Initial support for openapi3 components/schemas

Author: blake

lib/grape-swagger/openapi_3/doc_methods.rb

@@ -55,7 +55,10 @@ def setup(options)
 
         output[:tags]        = tags unless tags.empty? || paths.blank?
         output[:paths]       = paths unless paths.blank?
-        output[:definitions] = definitions unless definitions.blank?
+        unless definitions.blank?
+          output[:components] = {}
+          output[:components][:schemas] = definitions
+        end
 
         output
       end

lib/grape-swagger/openapi_3/doc_methods/parse_params.rb

@@ -74,7 +74,7 @@ def document_array_param(value_type, definitions)
 
           array_items = {}
           if definitions[value_type[:data_type]]
-            array_items['$ref'] = "#/definitions/#{@parsed_param[:type]}"
+            array_items['$ref'] = "#/components/schemas/#{@parsed_param[:type]}"
           else
             array_items[:type] = type || @parsed_param[:schema][:type] == 'array' ? 'string' : @parsed_param[:schema][:type]
           end

lib/grape-swagger/openapi_3/endpoint.rb

@@ -301,7 +301,7 @@ def tag_object(route, path)
 
     def build_reference(route, value, response_model)
       # TODO: proof that the definition exist, if model isn't specified
-      reference = { '$ref' => "#/definitions/#{response_model}" }
+      reference = { '$ref' => "#/components/schemas/#{response_model}" }
       route.options[:is_array] && value[:code] < 300 ? { type: 'array', items: reference } : reference
     end
 

spec/openapi_3/api_openapi_3_response_spec.rb

@@ -53,23 +53,23 @@ def app
             'description' => 'This returns something',
             'content' => {
               'application/json' => {
-                'schema' => { '$ref' => '#/definitions/UseItemResponseAsType' }
+                'schema' => { '$ref' => '#/components/schemas/UseItemResponseAsType' }
               }
             }
           },
           '400' => {
             'description' => 'NotFound',
             'content' => {
               'application/json' => {
-                'schema' => { '$ref' => '#/definitions/ApiError' }
+                'schema' => { '$ref' => '#/components/schemas/ApiError' }
               }
             }
           }
         },
         'tags' => ['nested_type'],
         'operationId' => 'getNestedType'
       )
-      expect(subject['definitions']).to eql(swagger_nested_type)
+      expect(subject['components']['schemas']).to eql(swagger_nested_type)
     end
   end
 
@@ -87,23 +87,23 @@ def app
             'description' => 'This returns something',
             'content' => {
               'application/json' => {
-                'schema' => { '$ref' => '#/definitions/UseResponse' }
+                'schema' => { '$ref' => '#/components/schemas/UseResponse' }
               }
             }
           },
           '400' => {
             'description' => 'NotFound',
             'content' => {
               'application/json' => {
-                'schema' => { '$ref' => '#/definitions/ApiError' }
+                'schema' => { '$ref' => '#/components/schemas/ApiError' }
               }
             }
           }
         },
         'tags' => ['entity_response'],
         'operationId' => 'getEntityResponse'
       )
-      expect(subject['definitions']).to eql(swagger_entity_as_response_object)
+      expect(subject['components']['schemas']).to eql(swagger_entity_as_response_object)
     end
   end
 
@@ -114,7 +114,6 @@ def app
     end
 
     specify do
-      fail("TODO: Fix")
       expect(subject['paths']['/params_given']['post']).to eql(
         'description' => 'This returns something',
         'requestBody' => {
@@ -140,15 +139,15 @@ def app
             'description' => 'NotFound',
             'content' => {
               'application/json' => {
-                'schema' => { '$ref' => '#/definitions/ApiError' }
+                'schema' => { '$ref' => '#/components/schemas/ApiError' }
               }
             }
           }
         },
         'tags' => ['params_given'],
         'operationId' => 'postParamsGiven'
       )
-      expect(subject['definitions']).to eql(swagger_params_as_response_object)
+      expect(subject['components']['schemas']).to eql(swagger_params_as_response_object)
     end
   end
 end