Change to open api spec 3.0

aadityataparia · aadityataparia · commit 5749585b1cc0 · 2018-12-06T19:15:05.000+09:00
diff --git a/lib/rspec_api_documentation.rb b/lib/rspec_api_documentation.rb
@@ -52,20 +52,27 @@ module Writers
   module OpenApi
     extend ActiveSupport::Autoload
 
+    autoload :Components
+    autoload :Contact
+    autoload :ExternalDocs
+    autoload :Flow
+    autoload :Header
     autoload :Helper
-    autoload :Node
-    autoload :Root
     autoload :Info
-    autoload :Contact
     autoload :License
-    autoload :Path
-    autoload :Tag
+    autoload :Media
+    autoload :Node
     autoload :Operation
     autoload :Parameter
+    autoload :Path
+    autoload :RequestBody
     autoload :Response
-    autoload :Header
+    autoload :Root
     autoload :Schema
-    autoload :SecuritySchema
+    autoload :SecurityScheme
+    autoload :Server
+    autoload :Tag
+    autoload :Variable
   end
 
   module Views
diff --git a/lib/rspec_api_documentation/open_api/components.rb b/lib/rspec_api_documentation/open_api/components.rb
@@ -0,0 +1,13 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Components < Node
+      add_setting :schemas, :schema => { '' => Schema }
+      add_setting :responses, :schema => { '' => Response }
+      add_setting :parameters, :schema => { '' => Parameter }
+      add_setting :headers, :schema => { '' => Header }
+      add_setting :securitySchemes, :schema => { '' => SecurityScheme }
+      add_setting :links
+      add_setting :callbacks
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/contact.rb b/lib/rspec_api_documentation/open_api/contact.rb
@@ -1,9 +1,9 @@
 module RspecApiDocumentation
   module OpenApi
     class Contact < Node
-      add_setting :name, :default => 'API Support'
-      add_setting :url, :default => 'http://www.open-api.io/support'
-      add_setting :email, :default => 'support@open-api.io'
+      add_setting :name
+      add_setting :url
+      add_setting :email
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/external_docs.rb b/lib/rspec_api_documentation/open_api/external_docs.rb
@@ -0,0 +1,8 @@
+module RspecApiDocumentation
+  module OpenApi
+    class ExternalDocs < Node
+      add_setting :description
+      add_setting :url, :required => true
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/flow.rb b/lib/rspec_api_documentation/open_api/flow.rb
@@ -0,0 +1,10 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Flow < Node
+      add_setting :authorizationUrl, :required => true
+      add_setting :tokenUrl, :required => true
+      add_setting :refreshUrl
+      add_setting :scopes, :required => true
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/header.rb b/lib/rspec_api_documentation/open_api/header.rb
@@ -1,12 +1,17 @@
 module RspecApiDocumentation
   module OpenApi
     class Header < Node
-      add_setting :description, :default => ''
-      add_setting :type, :required => true, :default => lambda { |header|
-        Helper.extract_type(header.public_send('x-example-value'))
-      }
-      add_setting :format
-      add_setting 'x-example-value'
+      add_setting :description
+      add_setting :required
+      add_setting :deprecated
+      # add_setting :allowEmptyValue
+      # add_setting :style
+      # add_setting :explode
+      # add_setting :allowReserved
+      add_setting :schema, :schema => Schema
+      add_setting :example
+      # add_setting :examples, :schema => { '' => Example }
+      # add_setting :content, :schema => { '' => Media }
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/helper.rb b/lib/rspec_api_documentation/open_api/helper.rb
@@ -16,7 +16,7 @@ def extract_type(value)
       end
 
       def extract_items(value, opts = {})
-        result = {type: extract_type(value)}
+        result = { type: extract_type(value) }
         if result[:type] == :array
           result[:items] = extract_items(value[0], opts)
         else
diff --git a/lib/rspec_api_documentation/open_api/info.rb b/lib/rspec_api_documentation/open_api/info.rb
@@ -2,10 +2,10 @@ module RspecApiDocumentation
   module OpenApi
     class Info < Node
       add_setting :title, :default => 'OpenAPI Specification', :required => true
-      add_setting :description, :default => 'This is a sample server Petstore server.'
-      add_setting :termsOfService, :default => 'http://open-api.io/terms/'
-      add_setting :contact, :default => Contact.new, :schema => Contact
-      add_setting :license, :default => License.new, :schema => License
+      add_setting :description
+      add_setting :termsOfService
+      add_setting :contact, :schema => Contact
+      add_setting :license, :schema => License
       add_setting :version, :default => '1.0.0', :required => true
     end
   end
diff --git a/lib/rspec_api_documentation/open_api/media.rb b/lib/rspec_api_documentation/open_api/media.rb
@@ -0,0 +1,10 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Media < Node
+      add_setting :schema, :schema => Schema
+      add_setting :example
+      # add_setting :examples, :schema => { '' => Example }
+      # add_setting :encoding, :schema => { '' => Encoding }
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/node.rb b/lib/rspec_api_documentation/open_api/node.rb
@@ -64,7 +64,13 @@ def add_setting(name, opts = {})
         settings[name] = opts[:value] if opts[:value]
 
         define_singleton_method("#{name}_schema") { opts[:schema] || NilClass }
-        define_singleton_method("#{name}=") { |value| settings[name] = value }
+        define_singleton_method("#{name}=") do |value|
+          if setting[name].is_a?(Hash) && value.is_a?(Hash)
+            value.each { |k, v| setting[name][k] = setting[name][k] ? setting[name][k].merge(v) : v }
+          else
+            settings[name] = value
+          end
+        end
         define_singleton_method("#{name}") do
           if settings.has_key?(name)
             settings[name]
diff --git a/lib/rspec_api_documentation/open_api/operation.rb b/lib/rspec_api_documentation/open_api/operation.rb
@@ -4,15 +4,14 @@ class Operation < Node
       add_setting :tags, :default => []
       add_setting :summary
       add_setting :description
-      add_setting :externalDocs
-      add_setting :operationId
-      add_setting :consumes
-      add_setting :produces
+      add_setting :externalDocs, :schema => ExternalDocs
+      # add_setting :operationId
       add_setting :parameters, :default => [], :schema => [Parameter]
-      add_setting :responses, :required => true, :schema => { String => Response }
-      add_setting :schemes
+      add_setting :requestBody, :schema => RequestBody
+      add_setting :responses, :required => true, :schema => { '' => Response }
       add_setting :deprecated, :default => false
       add_setting :security
+      # add_setting :servers, :schema => [Server]
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/parameter.rb b/lib/rspec_api_documentation/open_api/parameter.rb
@@ -1,33 +1,19 @@
 module RspecApiDocumentation
   module OpenApi
     class Parameter < Node
-      # Required to write example values to description of parameter when option `with_example: true` is provided
-      attr_accessor :value
-      attr_accessor :with_example
-
       add_setting :name, :required => true
       add_setting :in, :required => true
-      add_setting :description, :default => ''
-      add_setting :required, :default => lambda { |parameter| parameter.in.to_s == 'path' ? true : false }
-      add_setting :schema
-      add_setting :type
-      add_setting :items
-      add_setting :default
-      add_setting :minimum
-      add_setting :maximum
-      add_setting :enum
-
-      def description_with_example
-        str = description_without_example.dup || ''
-        if with_example && value
-          str << "\n" unless str.empty?
-          str << "Eg, `#{value}`"
-        end
-        str
-      end
-
-      alias_method :description_without_example, :description
-      alias_method :description, :description_with_example
+      add_setting :description
+      add_setting :required, :default => lambda { |parameter| parameter.in.to_s == 'path' }
+      add_setting :deprecated
+      # add_setting :allowEmptyValue
+      # add_setting :style
+      # add_setting :explode
+      # add_setting :allowReserved
+      add_setting :schema, :schema => Schema
+      add_setting :example
+      # add_setting :examples, :schema => { '' => Example }
+      # add_setting :content, :schema => { '' => Media }
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/path.rb b/lib/rspec_api_documentation/open_api/path.rb
@@ -8,6 +8,7 @@ class Path < Node
       add_setting :options, :schema => Operation
       add_setting :head, :schema => Operation
       add_setting :patch, :schema => Operation
+      add_setting :trace, :schema => Operation
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/request_body.rb b/lib/rspec_api_documentation/open_api/request_body.rb
@@ -0,0 +1,9 @@
+module RspecApiDocumentation
+  module OpenApi
+    class RequestBody < Node
+      add_setting :description, :default => 'body'
+      add_setting :content, :required => true, :schema => { '' => Media }
+      add_setting :required, :default => false
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/response.rb b/lib/rspec_api_documentation/open_api/response.rb
@@ -2,9 +2,9 @@ module RspecApiDocumentation
   module OpenApi
     class Response < Node
       add_setting :description, :required => true, :default => 'Successful operation'
-      add_setting :schema, :schema => Schema
-      add_setting :headers, :schema => { String => Header }
-      add_setting :examples
+      add_setting :headers, :schema => { '' => Header }
+      add_setting :content, :schema => { '' => Media }
+      # add_setting :links
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/root.rb b/lib/rspec_api_documentation/open_api/root.rb
@@ -1,21 +1,14 @@
 module RspecApiDocumentation
   module OpenApi
     class Root < Node
-      add_setting :swagger, :default => '2.0', :required => true
+      add_setting :openapi, :default => '3.0.0', :required => true
       add_setting :info, :default => Info.new, :required => true, :schema => Info
-      add_setting :host, :default => 'localhost:3000'
-      add_setting :basePath
-      add_setting :schemes, :default => %w(http https)
-      add_setting :consumes, :default => %w(application/json application/xml)
-      add_setting :produces, :default => %w(application/json application/xml)
-      add_setting :paths, :default => {}, :required => true, :schema => { String => Path }
-      add_setting :definitions
-      add_setting :parameters
-      add_setting :responses
-      add_setting :securityDefinitions, :schema => { String => SecuritySchema }
+      add_setting :servers, :schema => [Server]
+      add_setting :paths, :default => { '/' => Path.new }, :required => true, :schema => { '' => Path }
+      add_setting :components, :schema => Components
       add_setting :security
-      add_setting :tags, :default => [], :schema => [Tag]
-      add_setting :externalDocs
+      add_setting :tags, :schema => [Tag]
+      add_setting :externalDocs, :schema => ExternalDocs
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/schema.rb b/lib/rspec_api_documentation/open_api/schema.rb
@@ -1,15 +1,36 @@
 module RspecApiDocumentation
   module OpenApi
     class Schema < Node
-      add_setting :format
       add_setting :title
-      add_setting :description, :default => ''
+      add_setting :multipleOf
+      add_setting :maximum
+      add_setting :exclusiveMaximum
+      add_setting :minimum
+      add_setting :exclusiveMinimum
+      add_setting :maxLength
+      add_setting :minLength
+      add_setting :pattern
+      add_setting :maxItems
+      add_setting :minItems
+      add_setting :uniqueItems
+      add_setting :maxProperties
+      add_setting :minProperties
       add_setting :required
       add_setting :enum
       add_setting :type
+      add_setting :allOf, :schema => [Schema]
+      add_setting :oneOf, :schema => [Schema]
+      add_setting :anyOf, :schema => [Schema]
+      add_setting :not, :schema => [Schema]
       add_setting :items
-      add_setting :properties
+      add_setting :properties, :schema => { '' => Schema }
+      add_setting :description
+      add_setting :format
       add_setting :example
+      add_setting :externalDocs, :schema => ExternalDocs
+      add_setting :nullable
+      add_setting :deprecated
+      add_setting :discriminator
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/security_schema.rb b/lib/rspec_api_documentation/open_api/security_schema.rb
diff --git a/lib/rspec_api_documentation/open_api/security_scheme.rb b/lib/rspec_api_documentation/open_api/security_scheme.rb
@@ -0,0 +1,14 @@
+module RspecApiDocumentation
+  module OpenApi
+    class SecurityScheme < Node
+      add_setting :type, :required => true
+      add_setting :description
+      add_setting :name
+      add_setting :in
+      add_setting :scheme
+      add_setting :bearerFormat
+      add_setting :flows, :schema => { '' => Flow }
+      add_setting :openIdConnectUrl
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/server.rb b/lib/rspec_api_documentation/open_api/server.rb
@@ -0,0 +1,9 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Server < Node
+      add_setting :url, :required => true
+      add_setting :description
+      add_setting :variables, :schema => { '' => Variable }
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/open_api/tag.rb b/lib/rspec_api_documentation/open_api/tag.rb
@@ -2,8 +2,8 @@ module RspecApiDocumentation
   module OpenApi
     class Tag < Node
       add_setting :name, :required => true
-      add_setting :description, :default => ''
-      add_setting :externalDocs
+      add_setting :description
+      # add_setting :externalDocs, :schema => ExternalDocs
     end
   end
 end
diff --git a/lib/rspec_api_documentation/open_api/variable.rb b/lib/rspec_api_documentation/open_api/variable.rb
@@ -0,0 +1,9 @@
+module RspecApiDocumentation
+  module OpenApi
+    class Variable < Node
+      add_setting :enum
+      add_setting :default, :required => true
+      add_setting :description
+    end
+  end
+end
diff --git a/lib/rspec_api_documentation/writers/open_api_writer.rb b/lib/rspec_api_documentation/writers/open_api_writer.rb
