brainstem 2.0.0 → 2.1.0

data/spec/brainstem/api_docs/formatters/open_api_specification/helper_spec.rb

@@ -54,12 +54,12 @@ module Brainstem
             end
           end
 
-          describe "format_description" do
+          describe "format_sentence" do
             context "when description is given" do
               let(:description) { "  lorem ipsum dolor sit amet  " }
 
               it "returns the formatted description" do
-                expect(subject.format_description(description)).to eq("Lorem ipsum dolor sit amet.")
+                expect(subject.format_sentence(description)).to eq("Lorem ipsum dolor sit amet.")
               end
             end
 
@@ -67,7 +67,7 @@ module Brainstem
               let(:description) { "" }
 
               it "returns nil" do
-                expect(subject.format_description(description)).to eq('')
+                expect(subject.format_sentence(description)).to eq('')
               end
             end
           end
@@ -191,12 +191,23 @@ module Brainstem
                 it "returns type as `array` and given item type" do
                   expect(subject.send(:type_and_format, 'array', 'integer')).to eq({
                     'type' => 'array',
-                    'items' => { 'type' => 'integer' }
+                    'items' => { 'type' => 'integer', 'format' => 'int32' }
                   })
                 end
               end
             end
 
+            context "when dealing with delimited strings" do
+              it 'returns string as type and the collection format' do
+                %w(csv ssv tsv pipes).each do |delimited_string_type|
+                  expect(subject.type_and_format(delimited_string_type)).to eq(
+                    'type' => 'string',
+                    'collectionFormat' => delimited_string_type,
+                  )
+                end
+              end
+            end
+
             context "when type is unknown" do
               it "returns nil" do
                 expect(subject.send(:type_and_format, 'invalid')).to be_nil

data/spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/param_definitions_formatter_spec.rb

@@ -34,38 +34,86 @@ module Brainstem
               end
 
               describe '#call' do
-                context 'when request type is get' do
-                  let(:http_methods)  { %w(GET) }
+                context 'when an endpoint presents a brainstem object' do
+                  context 'when request type is get' do
+                    let(:http_methods)  { %w(GET) }
+
+                    context 'when action is index' do
+                      let(:action) { 'index' }
+
+                      it 'formats path, shared, query and body params for the endpoint' do
+                        any_instance_of(described_class) do |instance|
+                          mock(instance).format_path_params!
+                          mock(instance).format_optional_params!
+                          mock(instance).format_include_params!
+                          mock(instance).format_query_params!
+                          mock(instance).format_body_params!
+                          mock(instance).format_pagination_params!
+                          mock(instance).format_search_param!
+                          mock(instance).format_only_param!
+                          mock(instance).format_sort_order_params!
+                          mock(instance).format_filter_params!
+                        end
+
+                        subject.call
+                      end
+                    end
 
-                  context 'when action is index' do
-                    let(:action) { 'index' }
+                    context 'when action is show' do
+                      let(:action) { 'show' }
+
+                      it 'formats path, optional, query and body params for the endpoint' do
+                        any_instance_of(described_class) do |instance|
+                          mock(instance).format_path_params!
+                          mock(instance).format_optional_params!
+                          mock(instance).format_include_params!
+                          mock(instance).format_query_params!
+                          mock(instance).format_body_params!
+
+                          dont_allow(instance).format_pagination_params!
+                          dont_allow(instance).format_search_param!
+                          dont_allow(instance).format_only_param!
+                          dont_allow(instance).format_sort_order_params!
+                          dont_allow(instance).format_filter_params!
+                        end
+
+                        subject.call
+                      end
+                    end
+                  end
+
+                  context 'when request type is `delete`' do
+                    let(:http_methods) { %w(DELETE) }
+                    let(:action)       { 'destroy' }
 
-                    it 'formats path, shared, query and body params for the endpoint' do
+                    it 'formats path, query and body param for the endpoint' do
                       any_instance_of(described_class) do |instance|
                         mock(instance).format_path_params!
-                        mock(instance).format_optional_params!
-                        mock(instance).format_include_params!
                         mock(instance).format_query_params!
                         mock(instance).format_body_params!
-                        mock(instance).format_pagination_params!
-                        mock(instance).format_search_param!
-                        mock(instance).format_only_param!
-                        mock(instance).format_sort_order_params!
-                        mock(instance).format_filter_params!
+
+                        dont_allow(instance).format_pagination_params!
+                        dont_allow(instance).format_search_param!
+                        dont_allow(instance).format_only_param!
+                        dont_allow(instance).format_sort_order_params!
+                        dont_allow(instance).format_optional_params!
+                        dont_allow(instance).format_include_params!
+                        dont_allow(instance).format_filter_params!
                       end
 
                       subject.call
                     end
                   end
 
-                  context 'when action is show' do
-                    let(:action) { 'show' }
+                  context 'when request type is not delete' do
+                    let(:http_methods) { %w(PATCH) }
+                    let(:action)       { 'update' }
 
-                    it 'formats path, optional, query and body params for the endpoint' do
+                    it 'formats path, query and body param for the endpoint' do
                       any_instance_of(described_class) do |instance|
-                        mock(instance).format_path_params!
                         mock(instance).format_optional_params!
                         mock(instance).format_include_params!
+                        mock(instance).format_path_params!
                         mock(instance).format_query_params!
                         mock(instance).format_body_params!
 
@@ -81,9 +129,8 @@ module Brainstem
                   end
                 end
 
-                context 'when request type is `delete`' do
-                  let(:http_methods) { %w(DELETE) }
-                  let(:action)       { 'destroy' }
+                context 'when an endpoint does not present a brainstem object' do
+                  let(:presenter) { nil }
 
                   it 'formats path, query and body param for the endpoint' do
                     any_instance_of(described_class) do |instance|
@@ -103,29 +150,6 @@ module Brainstem
                     subject.call
                   end
                 end
-
-                context 'when request type is not delete' do
-                  let(:http_methods) { %w(PATCH) }
-                  let(:action)       { 'update' }
-
-                  it 'formats path, query and body param for the endpoint' do
-                    any_instance_of(described_class) do |instance|
-                      mock(instance).format_optional_params!
-                      mock(instance).format_include_params!
-                      mock(instance).format_path_params!
-                      mock(instance).format_query_params!
-                      mock(instance).format_body_params!
-
-                      dont_allow(instance).format_pagination_params!
-                      dont_allow(instance).format_search_param!
-                      dont_allow(instance).format_only_param!
-                      dont_allow(instance).format_sort_order_params!
-                      dont_allow(instance).format_filter_params!
-                    end
-
-                    subject.call
-                  end
-                end
               end
 
               describe '#formatting' do
@@ -239,7 +263,7 @@ module Brainstem
                         'in'          => 'query',
                         'name'        => 'sprocket_ids',
                         'type'        => 'array',
-                        'items'       => { 'type' => 'integer' }
+                        'items'       => { 'type' => 'integer', 'format' => 'int32' }
                       },
                       {
                         'in'          => 'query',
@@ -274,7 +298,7 @@ module Brainstem
                           type: 'hash',
                           info: 'attributes for the task  '
                         },
-                        name: {
+                        title: {
                           _config: {
                             type: 'string',
                             required: true,
@@ -286,7 +310,7 @@ module Brainstem
                             type: 'hash',
                             info: 'sub tasks of the task'
                           },
-                          name: {
+                          title: {
                             _config: {
                               type: 'string',
                               required: true
@@ -300,7 +324,15 @@ module Brainstem
                           },
                           name: {
                             _config: {
-                              type: 'string'
+                              type: 'string',
+                              required: true,
+                            }
+                          },
+                          _dynamic_key: {
+                            _config: {
+                              type: 'boolean',
+                              info: 'something',
+                              dynamic_key: true,
                             }
                           },
                         },
@@ -324,6 +356,7 @@ module Brainstem
                         },
                         id: {
                           _config: {
+                            required: true,
                             type: 'integer',
                             info: 'ID of the assignee'
                           }
@@ -334,6 +367,15 @@ module Brainstem
                             info: 'activates the assignment'
                           }
                         }
+                      },
+                      _dynamic_key: {
+                        _config: {
+                          required: true,
+                          type: 'array',
+                          item_type: 'integer',
+                          info: 'IDs of assignees',
+                          dynamic_key: true,
+                        }
                       }
                     }.with_indifferent_access
                   end
@@ -353,38 +395,38 @@ module Brainstem
                         'schema'      => {
                           'type'       => 'object',
                           'properties' => {
-
                             'task' => {
-                              'title'       => 'task',
-                              'type'        => 'object',
                               'description' => 'Attributes for the task.',
+                              'required'    => ['title'],
+                              'type'        => 'object',
                               'properties'  => {
-                                'name' => {
-                                  'title'       => 'name',
+                                'title' => {
                                   'description' => 'Name of the task.',
                                   'type'        => 'string'
                                 },
                                 'subs' => {
-                                  'title'       => 'subs',
                                   'description' => 'Sub tasks of the task.',
+                                  'required'    => ['title'],
                                   'type'        => 'object',
                                   'properties'  => {
-                                    'name' => {
-                                      'title'    => 'name',
-                                      'type'     => 'string'
+                                    'title' => {
+                                      'type' => 'string'
                                     }
                                   }
                                 },
                                 'checklist' => {
-                                  'title'  => 'checklist',
                                   'type'   => 'array',
                                   'items'  => {
                                     'type'       => 'object',
+                                    'required'   => ['name'],
                                     'properties' => {
                                       'name' => {
-                                        'title'    => 'name',
-                                        'type'     => 'string'
+                                        'type' => 'string',
                                       }
+                                    },
+                                    'additionalProperties' => {
+                                      'type' => 'boolean',
+                                      'description' => 'Something.',
                                     }
                                   }
                                 }
@@ -392,12 +434,10 @@ module Brainstem
                             },
 
                             'creator' => {
-                              'title'       => 'creator',
                               'type'        => 'object',
                               'description' => 'Attributes for the creator.',
                               'properties'  => {
                                 'id' => {
-                                  'title'       => 'id',
                                   'description' => 'ID of the creator.',
                                   'type'        => 'integer',
                                   'format'      => 'int32'
@@ -406,25 +446,31 @@ module Brainstem
                             },
 
                             'assignees' => {
-                              'title'       => 'assignees',
                               'type'        => 'array',
                               'description' => 'Attributes for the assignees.',
                               'items'       => {
                                 'type'        => 'object',
+                                'required'    => ['id'],
                                 'properties'  => {
                                   'id' => {
-                                    'title'       => 'id',
                                     'description' => 'ID of the assignee.',
                                     'type'        => 'integer',
                                     'format'      => 'int32'
                                   },
                                   'active' => {
-                                    'title'       => 'active',
                                     'description' => 'Activates the assignment.',
                                     'type'        => 'boolean'
                                   },
                                 }
                               }
+                            },
+                          },
+                          'additionalProperties' => {
+                            'type' => 'array',
+                            'description' => 'IDs of assignees.',
+                            'items' => {
+                              'type' => 'integer',
+                              'format' => 'int32',
                             }
                           }
                         },
@@ -595,8 +641,8 @@ module Brainstem
                     mock(presenter).default_sort_order { 'title:asc' }
                     mock(presenter).valid_sort_orders {
                       {
-                        'title'         => { info: 'Order by title aphabetically' },
-                        'sprocket_name' => { info: 'Order by sprocket name aphabetically' },
+                        'title'         => { info: 'Order by title alphabetically', direction: true },
+                        'sprocket_name' => { info: 'Order by sprocket name alphabetically', direction: false },
                       }
                     }
                   end
@@ -611,7 +657,7 @@ module Brainstem
                         'type'        => 'string',
                         'default'     => 'title:asc',
                         'description' => "Supply `order` with the name of a valid sort field for the endpoint and a direction.\n\n" +
-                                         "Valid values: `sprocket_name:asc`, `sprocket_name:desc`, `title:asc`, and `title:desc`."
+                                         "Valid values: `sprocket_name`, `title:asc`, and `title:desc`."
                       }
                     ])
                   end

data/spec/brainstem/api_docs/formatters/open_api_specification/version_2/endpoint/response_definitions_formatter_spec.rb

@@ -114,6 +114,7 @@ module Brainstem
                   before do
                     stub(presenter).brainstem_keys { ['widgets'] }
                     stub(presenter).target_class { 'Widget' }
+                    stub(presenter).valid_associations { {} }
                   end
 
                   it 'returns the structured response for an endpoint' do
@@ -154,6 +155,172 @@ module Brainstem
                       }
                     })
                   end
+
+                  context 'when there are valid associations' do
+                    let(:task_stubbed_presenter) { Object.new }
+                    let(:user_stubbed_presenter) { Object.new }
+                    let(:nodoc) { false }
+
+                    before do
+                      stub(task_stubbed_presenter).nodoc? { nodoc }
+                      stub(task_stubbed_presenter).brainstem_keys { ['tasks'] }
+                      stub(user_stubbed_presenter).nodoc? { nodoc }
+                      stub(user_stubbed_presenter).brainstem_keys { ['users'] }
+                      stub(presenter).find_by_class(Task) { task_stubbed_presenter }
+                      stub(presenter).find_by_class(User) { user_stubbed_presenter }
+                    end
+
+                    context 'when association is pointing to a nodoc class' do
+                      let(:nodoc) { true }
+
+                      it 'does not generate references for the association' do
+                        subject.send(:format_schema_response!)
+
+                        expect(subject.output).to eq('200' => {
+                          'description' => 'A list of Widgets have been retrieved.',
+                          'schema' => {
+                            'type' => 'object',
+                            'properties' => {
+                              'count' => { 'type' => 'integer', 'format' => 'int32' },
+                              'meta' => {
+                                'type' => 'object',
+                                'properties' => {
+                                  'count' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_count' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_number' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_size' => { 'type' => 'integer', 'format' => 'int32' },
+                                }
+                              },
+                              'results' => {
+                                'type' => 'array',
+                                'items' => {
+                                  'type' => 'object',
+                                  'properties' => {
+                                    'key' => { 'type' => 'string' },
+                                    'id' => { 'type' => 'string' }
+                                  }
+                                }
+                              },
+                              'widgets' => {
+                                'type' => 'object',
+                                'additionalProperties' => {
+                                  '$ref' => '#/definitions/Widget'
+                                }
+                              }
+                            }
+                          }
+                        })
+                      end
+                    end
+
+                    context 'when the association is polymorphic' do
+                      before do
+                        stub(presenter).valid_associations { { 'tasks' => ::Brainstem::DSL::Association.new('polymorphic', :polymorphic, polymorphic_classes: [Task, User]) } }
+                      end
+
+                      it 'returns the appropriate associations with their additional properties' do
+                        subject.send(:format_schema_response!)
+
+                        expect(subject.output).to eq('200' => {
+                          'description' => 'A list of Widgets have been retrieved.',
+                          'schema' => {
+                            'type' => 'object',
+                            'properties' => {
+                              'count' => { 'type' => 'integer', 'format' => 'int32' },
+                              'meta' => {
+                                'type' => 'object',
+                                'properties' => {
+                                  'count' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_count' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_number' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_size' => { 'type' => 'integer', 'format' => 'int32' },
+                                }
+                              },
+                              'results' => {
+                                'type' => 'array',
+                                'items' => {
+                                  'type' => 'object',
+                                  'properties' => {
+                                    'key' => { 'type' => 'string' },
+                                    'id' => { 'type' => 'string' }
+                                  }
+                                }
+                              },
+                              'widgets' => {
+                                'type' => 'object',
+                                'additionalProperties' => {
+                                  '$ref' => '#/definitions/Widget'
+                                }
+                              },
+                              'tasks' => {
+                                'type' => 'object',
+                                'additionalProperties' => {
+                                  '$ref' => '#/definitions/Task'
+                                }
+                              },
+                              'users' => {
+                                'type' => 'object',
+                                'additionalProperties' => {
+                                  '$ref' => '#/definitions/User'
+                                }
+                              }
+                            }
+                          }
+                        })
+                      end
+                    end
+
+                    context 'when the association is not polymorphic' do
+                      before do
+                        stub(presenter).valid_associations { { 'tasks' => ::Brainstem::DSL::Association.new('Task', Task, {}) } }
+                      end
+
+                      it 'returns the appropriate association with its additional properties' do
+                        subject.send(:format_schema_response!)
+
+                        expect(subject.output).to eq('200' => {
+                          'description' => 'A list of Widgets have been retrieved.',
+                          'schema' => {
+                            'type' => 'object',
+                            'properties' => {
+                              'count' => { 'type' => 'integer', 'format' => 'int32' },
+                              'meta' => {
+                                'type' => 'object',
+                                'properties' => {
+                                  'count' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_count' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_number' => { 'type' => 'integer', 'format' => 'int32' },
+                                  'page_size' => { 'type' => 'integer', 'format' => 'int32' },
+                                }
+                              },
+                              'results' => {
+                                'type' => 'array',
+                                'items' => {
+                                  'type' => 'object',
+                                  'properties' => {
+                                    'key' => { 'type' => 'string' },
+                                    'id' => { 'type' => 'string' }
+                                  }
+                                }
+                              },
+                              'widgets' => {
+                                'type' => 'object',
+                                'additionalProperties' => {
+                                  '$ref' => '#/definitions/Widget'
+                                }
+                              },
+                              'tasks' => {
+                                'type' => 'object',
+                                'additionalProperties' => {
+                                  '$ref' => '#/definitions/Task'
+                                }
+                              }
+                            }
+                          }
+                        })
+                      end
+                    end
+                  end
                 end
 
                 describe '#format_error_responses!' do
@@ -197,7 +364,25 @@ module Brainstem
                                 'info' => 'Can edit the widget.',
                                 'nodoc' => false
                               },
-                            }
+                            },
+                            '_dynamic_key' => {
+                              '_config' => {
+                                'type' => 'array',
+                                'item_type' => 'integer',
+                                'info' => 'Viewable Widget Ids.',
+                                'nodoc' => false,
+                                'dynamic_key' => true
+                              },
+                            },
+                          },
+                          '_dynamic_key' => {
+                            '_config' => {
+                              'type' => 'array',
+                              'item_type' => 'integer',
+                              'info' => 'Association Ids.',
+                              'nodoc' => false,
+                              'dynamic_key' => true
+                            },
                           },
                         }.with_indifferent_access
                       }
@@ -223,49 +408,93 @@ module Brainstem
                                   'type' => 'boolean',
                                   'description' => 'Can edit the widget.'
                                 }
-                              }
+                              },
+                              'additionalProperties' => {
+                                'type' => 'array',
+                                'description' => 'Viewable Widget Ids.',
+                                'items' => {
+                                  'type' => 'integer',
+                                  'format' => 'int32',
+                                }
+                              },
                             }
-                          }
+                          },
+                          'additionalProperties' => {
+                            'type' => 'array',
+                            'description' => 'Association Ids.',
+                            'items' => {
+                              'type' => 'integer',
+                              'format' => 'int32',
+                            }
+                          },
                         }
                       })
                     end
                   end
 
                   context 'when the response is an array' do
-                    before do
-                      stub(endpoint).custom_response_configuration_tree {
-                        {
-                          '_config' => {
-                            'type' => 'array',
-                            'item_type' => 'hash',
-                          },
-                          'widget_name' => {
+                    context 'when array of string / number' do
+                      before do
+                        stub(endpoint).custom_response_configuration_tree {
+                          {
                             '_config' => {
-                              'type' => 'string',
-                              'info' => 'The name of the widget.',
-                              'nodoc' => false
+                              'type' => 'array',
+                              'item_type' => 'string',
                             },
-                          },
-                          'widget_permissions' => {
+                          }.with_indifferent_access
+                        }
+                      end
+
+                      it 'returns the response structure' do
+                        subject.send(:format_custom_response!)
+
+                        expect(subject.output).to eq('200' => {
+                          'description' => 'A list of Widgets have been retrieved.',
+                          'schema' => {
+                            'type' => 'array',
+                            'items' => {
+                              'type' => 'string',
+                            }
+                          }
+                        })
+                      end
+                    end
+
+                    context 'when array of hashes' do
+                      before do
+                        stub(endpoint).custom_response_configuration_tree {
+                          {
                             '_config' => {
                               'type' => 'array',
                               'item_type' => 'hash',
-                              'info' => 'The permissions of the widget.',
-                              'nodoc' => false
                             },
-                            'can_edit' => {
+                            'widget_name' => {
                               '_config' => {
-                                'type' => 'boolean',
-                                'info' => 'Can edit the widget.',
+                                'type' => 'string',
+                                'info' => 'The name of the widget.',
                                 'nodoc' => false
                               },
-                            }
-                          },
-                        }.with_indifferent_access
-                      }
-                    end
+                            },
+                            'widget_permissions' => {
+                              '_config' => {
+                                'type' => 'array',
+                                'item_type' => 'hash',
+                                'info' => 'The permissions of the widget.',
+                                'nodoc' => false
+                              },
+                              'can_edit' => {
+                                '_config' => {
+                                  'type' => 'boolean',
+                                  'info' => 'Can edit the widget.',
+                                  'nodoc' => false
+                                },
+                              }
+                            },
+                          }.with_indifferent_access
+                        }
+                      end
 
-                    it 'returns the response structure' do
+                      it 'returns the response structure' do
                       subject.send(:format_custom_response!)
 
                       expect(subject.output).to eq('200' => {
@@ -296,16 +525,158 @@ module Brainstem
                           }
                         }
                       })
+                      end
+                    end
+                  end
+
+                  context 'when the response is multi nested array' do
+                    before do
+                      stub(endpoint).custom_response_configuration_tree { response_config_tree }
+                    end
+
+                    # response :array, nested_level: 2, item_type: [:hash, :string, :integer] do
+                    #   nested.field :a, :string
+                    #   nested.field :b, :integer
+                    # end
+                    
+                    # response :array, nested_level: 2, item_type: :hash do
+                    #   nested.field :a, :string
+                    #   nested.field :a, :integer
+                    # end
+                    # 
+                    # [
+                    #   [
+                    #     { widget_name: 'Widget A', can_edit: false },
+                    #     { widget_name: 'Widget B', can_edit: true },
+                    #   ]
+                    # ]
+                    context 'when the leaf array is an array of objects' do
+                      let(:response_config_tree) do
+                        {
+                          '_config' => {
+                            'type' => 'array',
+                            'nested_levels' => 2,
+                            'item_type' => 'hash',
+                          },
+                          'widget_name' => {
+                            '_config' => {
+                              'type' => 'string',
+                              'info' => 'The name of the widget.',
+                              'nodoc' => false
+                            },
+                          },
+                          'widget_permissions' => {
+                            '_config' => {
+                              'type' => 'array',
+                              'item_type' => 'hash',
+                              'info' => 'The permissions of the widget.',
+                              'nodoc' => false
+                            },
+                            'can_edit' => {
+                              '_config' => {
+                                'type' => 'array',
+                                'nested_levels' => 3,
+                                'item_type' => 'boolean',
+                                'nodoc' => false
+                              },
+                            }
+                          },
+                        }.with_indifferent_access
+                      end
+
+                      it 'returns the response structure' do
+                        subject.send(:format_custom_response!)
+
+                        expect(subject.output).to eq('200' => {
+                          'description' => 'A list of Widgets have been retrieved.',
+                          'schema' => {
+                            'type' => 'array',
+                            'items' => {
+                              'type' => 'array',
+                              'items' => {
+                                'type' => 'object',
+                                'properties' => {
+                                  'widget_name' => {
+                                    'type' => 'string',
+                                    'description' => 'The name of the widget.'
+                                  },
+                                  'widget_permissions' => {
+                                    'type' => 'array',
+                                    'description' => 'The permissions of the widget.',
+                                    'items' => {
+                                      'type' => 'object',
+                                      'properties' => {
+                                        'can_edit' => {
+                                          'type' => 'array',
+                                          'items' => {
+                                            'type' => 'array',
+                                            'items' => {
+                                              'type' => 'array',
+                                              'items' => {
+                                                'type' => 'boolean'
+                                              }
+                                            }
+                                          }
+                                        }
+                                      }
+                                    }
+                                  }
+                                }
+                              }
+                            }
+                          }
+                        })
+                      end
+                    end
+
+                    # response :array, nested_level: 3, item_type: :string
+                    # 
+                    # [
+                    #   [
+                    #     [1,3,4,5],
+                    #     [6,7,8,9],
+                    #   ]
+                    # ]
+                    context 'when the leaf array is an array of strings' do
+                      let(:response_config_tree) do
+                        {
+                          '_config' => {
+                            'type' => 'array',
+                            'nested_levels' => 3,
+                            'item_type' => 'string',
+                          },
+                        }.with_indifferent_access
+                      end
+
+                      it 'returns the response structure' do
+                        subject.send(:format_custom_response!)
+
+                        expect(subject.output).to eq('200' => {
+                          'description' => 'A list of Widgets have been retrieved.',
+                          'schema' => {
+                            'type' => 'array',
+                            'items' => {
+                              'type' => 'array',
+                              'items' => {
+                                'type' => 'array',
+                                'items' => {
+                                  'type' => 'string',
+                                }
+                              }
+                            }
+                          }
+                        })
+                      end
                     end
                   end
 
-                  context 'when the response is not a hash or array' do
+                  context 'when the response is not a hash or an array' do
                     before do
                       stub(endpoint).custom_response_configuration_tree {
                         {
                           '_config' => {
-                            'type' => 'boolean',
-                            'info' => 'whether the widget exists',
+                            'type' => 'integer',
+                            'info' => 'Indicates the number of widgets',
                             'nodoc' => false
                           },
                         }.with_indifferent_access
@@ -318,8 +689,9 @@ module Brainstem
                       expect(subject.output).to eq('200' => {
                         'description' => 'A list of Widgets have been retrieved.',
                         'schema' => {
-                          'type' => 'boolean',
-                          'description' => 'Whether the widget exists.'
+                          'type' => 'integer',
+                          'format' => 'int32',
+                          'description' => 'Indicates the number of widgets.'
                         }
                       })
                     end