jsapi 0.1.2 → 0.3.0

data/lib/jsapi/meta/openapi/security_scheme/http/basic.rb

@@ -7,21 +7,26 @@ module Jsapi
         module HTTP
           # Represents a security scheme based on \HTTP basic authentication.
           class Basic < Base
+            include Extensions
+
             # Returns a hash representing the security scheme object.
             def to_openapi(version)
               version = OpenAPI::Version.from(version)
-              if version.major == 2
-                {
-                  type: 'basic',
-                  description: description
-                }
-              else
-                {
-                  type: 'http',
-                  scheme: 'basic',
-                  description: description
-                }
-              end.compact
+
+              with_openapi_extensions(
+                if version.major == 2
+                  {
+                    type: 'basic',
+                    description: description
+                  }
+                else
+                  {
+                    type: 'http',
+                    scheme: 'basic',
+                    description: description
+                  }
+                end
+              )
             end
           end
         end

data/lib/jsapi/meta/openapi/security_scheme/http/bearer.rb

@@ -11,6 +11,8 @@ module Jsapi
           # Thus, a security scheme of this class is skipped when generating
           # an \OpenAPI 2.0 document.
           class Bearer < Base
+            include Extensions
+
             ##
             # :attr: bearer_format
             # The optional format of the bearer token.
@@ -22,12 +24,12 @@ module Jsapi
               version = OpenAPI::Version.from(version)
               return if version.major == 2
 
-              {
+              with_openapi_extensions(
                 type: 'http',
                 scheme: 'bearer',
                 bearerFormat: bearer_format,
                 description: description
-              }.compact
+              )
             end
           end
         end

data/lib/jsapi/meta/openapi/security_scheme/http/other.rb

@@ -12,6 +12,8 @@ module Jsapi
           # a security scheme of this class is skipped when generating an
           # \OpenAPI 2.0 document.
           class Other < Base
+            include Extensions
+
             ##
             # :attr: scheme
             # The mandatory \HTTP authentication scheme.
@@ -23,11 +25,11 @@ module Jsapi
               version = OpenAPI::Version.from(version)
               return if version.major == 2
 
-              {
+              with_openapi_extensions(
                 type: 'http',
                 scheme: scheme,
                 description: description
-              }.compact
+              )
             end
           end
         end

data/lib/jsapi/meta/openapi/security_scheme/oauth2.rb

@@ -6,6 +6,8 @@ module Jsapi
       module SecurityScheme
         # Represents a security scheme based on \OAuth2.
         class OAuth2 < Base
+          include Extensions
+
           ##
           # :attr: oauth_flows
           # The hash containing the OAuth flows. Possible keys are:
@@ -22,10 +24,8 @@ module Jsapi
           # Returns a hash representing the security scheme object.
           def to_openapi(version)
             version = Version.from(version)
-            {
-              type: 'oauth2',
-              description: description
-            }.tap do |h|
+
+            with_openapi_extensions(type: 'oauth2', description: description).tap do |h|
               if oauth_flows&.any?
                 if version.major == 2
                   key, oauth_flow = oauth_flows.first
@@ -37,7 +37,7 @@ module Jsapi
                   end
                 end
               end
-            end.compact
+            end
           end
         end
       end

data/lib/jsapi/meta/openapi/security_scheme/open_id_connect.rb

@@ -9,6 +9,8 @@ module Jsapi
         # OpenID Connect was introduced with \OpenAPI 3.0. Thus, a security scheme of
         # this class is skipped when generating an \OpenAPI 2.0 document.
         class OpenIDConnect < Base
+          include Extensions
+
           ##
           # :attr: open_id_connect_url
           attribute :open_id_connect_url, String
@@ -19,11 +21,11 @@ module Jsapi
             version = Version.from(version)
             return if version.major == 2
 
-            {
+            with_openapi_extensions(
               type: 'openIdConnect',
               openIdConnectUrl: open_id_connect_url,
               description: description
-            }.compact
+            )
           end
         end
       end

data/lib/jsapi/meta/openapi/server.rb

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a server object.
       class Server < Base
+        include Extensions
+
         ##
         # :attr: description
         # The optional description of the server.
@@ -22,11 +24,11 @@ module Jsapi
 
         # Returns a hash representing the server object.
         def to_openapi(*)
-          {
+          with_openapi_extensions(
             url: url,
             description: description,
             variables: variables&.transform_values(&:to_openapi)
-          }.compact
+          )
         end
       end
     end

data/lib/jsapi/meta/openapi/server_variable.rb

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a server variable object.
       class ServerVariable < Base
+        include Extensions
+
         ##
         # :attr: default
         # The default value of the server variable.
@@ -22,11 +24,11 @@ module Jsapi
 
         # Returns a hash representing the server variable object.
         def to_openapi(*)
-          {
+          with_openapi_extensions(
             default: default,
             enum: enum.presence, # must not be empty
             description: description
-          }.compact
+          )
         end
       end
     end

data/lib/jsapi/meta/openapi/tag.rb

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a tag object.
       class Tag < Base
+        include Extensions
+
         ##
         # :attr: description
         # The description of the tag.
@@ -22,11 +24,11 @@ module Jsapi
 
         # Returns a hash representing the tag object.
         def to_openapi(*)
-          {
+          with_openapi_extensions(
             name: name,
             description: description,
             externalDocs: external_docs&.to_openapi
-          }.compact
+          )
         end
       end
     end

data/lib/jsapi/meta/openapi.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'openapi/extensions'
 require_relative 'openapi/version'
 require_relative 'openapi/callback'
 require_relative 'openapi/contact'

data/lib/jsapi/meta/operation.rb

@@ -3,6 +3,8 @@
 module Jsapi
   module Meta
     class Operation < Base
+      include OpenAPI::Extensions
+
       ##
       # :attr: callbacks
       # The optional callbacks. Applies to \OpenAPI 3.0 and higher.
@@ -133,7 +135,8 @@ module Jsapi
       # Returns a hash representing the \OpenAPI operation object.
       def to_openapi(version, definitions)
         version = OpenAPI::Version.from(version)
-        {
+
+        with_openapi_extensions(
           operationId: name,
           tags: tags,
           summary: summary,
@@ -141,7 +144,7 @@ module Jsapi
           externalDocs: external_docs&.to_openapi,
           deprecated: deprecated?.presence,
           security: security_requirements&.map(&:to_openapi)
-        }.tap do |hash|
+        ).tap do |hash|
           if version.major == 2
             hash[:consumes] = consumed_mime_types if consumed_mime_types
             hash[:produces] = produced_mime_types if produced_mime_types
@@ -170,7 +173,7 @@ module Jsapi
               callback.to_openapi(version, definitions)
             end
           end
-        end.compact
+        end
       end
     end
   end

data/lib/jsapi/meta/parameter/model.rb

@@ -4,6 +4,8 @@ module Jsapi
   module Meta
     module Parameter
       class Model < Base
+        include OpenAPI::Extensions
+
         ##
         # :attr: deprecated
         # Specifies whether or not the parameter is deprecated.
@@ -47,12 +49,14 @@ module Jsapi
         def initialize(name, keywords = {})
           raise ArgumentError, "parameter name can't be blank" if name.blank?
 
+          @name = name.to_s
+
           keywords = keywords.dup
           super(keywords.extract!(:deprecated, :description, :examples, :in))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
-          @name = name.to_s
           @schema = Schema.new(keywords)
         end
 
@@ -85,32 +89,34 @@ module Jsapi
           else
             parameter_name = schema.array? ? "#{name}[]" : name
             [
-              if version.major == 2
-                {
-                  name: parameter_name,
-                  in: self.in,
-                  description: description,
-                  required: required?.presence,
-                  allowEmptyValue: allow_empty_value?.presence,
-                  collectionFormat: ('multi' if schema.array?)
-                }.merge(schema.to_openapi(version))
-              else
-                {
-                  name: parameter_name,
-                  in: self.in,
-                  description: description,
-                  required: required?.presence,
-                  allowEmptyValue: allow_empty_value?.presence,
-                  deprecated: deprecated?.presence,
-                  schema: schema.to_openapi(version),
-                  examples: examples&.transform_values(&:to_openapi)
-
-                  # NOTE: collectionFormat is replaced by style and explode.
-                  #       The default values for query parameters are:
-                  #       - style: 'form'
-                  #       - explode: true
-                }
-              end.compact
+              with_openapi_extensions(
+                if version.major == 2
+                  {
+                    name: parameter_name,
+                    in: self.in,
+                    description: description,
+                    required: required?.presence,
+                    allowEmptyValue: allow_empty_value?.presence,
+                    collectionFormat: ('multi' if schema.array?)
+                  }.merge(schema.to_openapi(version))
+                else
+                  {
+                    name: parameter_name,
+                    in: self.in,
+                    description: description,
+                    required: required?.presence,
+                    allowEmptyValue: allow_empty_value?.presence,
+                    deprecated: deprecated?.presence,
+                    schema: schema.to_openapi(version),
+                    examples: examples&.transform_values(&:to_openapi)
+
+                    # NOTE: collectionFormat is replaced by style and explode.
+                    #       The default values for query parameters are:
+                    #       - style: 'form'
+                    #       - explode: true
+                  }
+                end
+              )
             ]
           end
         end
@@ -139,27 +145,29 @@ module Jsapi
               description = property_schema.description
               allow_empty_value = property.schema.existence <= Existence::ALLOW_EMPTY
               [
-                if version.major == 2
-                  {
-                    name: parameter_name,
-                    in: self.in,
-                    description: description,
-                    required: required,
-                    allowEmptyValue: allow_empty_value.presence,
-                    collectionFormat: ('multi' if property_schema.array?)
-                  }.merge(property_schema.to_openapi(version))
-                else
-                  {
-                    name: parameter_name,
-                    in: self.in,
-                    description: description,
-                    required: required,
-                    allowEmptyValue: allow_empty_value.presence,
-                    deprecated: deprecated,
-                    schema: property_schema.to_openapi(version).except(:deprecated),
-                    examples: examples&.transform_values(&:to_openapi)
-                  }
-                end.compact
+                with_openapi_extensions(
+                  if version.major == 2
+                    {
+                      name: parameter_name,
+                      in: self.in,
+                      description: description,
+                      required: required,
+                      allowEmptyValue: allow_empty_value.presence,
+                      collectionFormat: ('multi' if property_schema.array?)
+                    }.merge(property_schema.to_openapi(version))
+                  else
+                    {
+                      name: parameter_name,
+                      in: self.in,
+                      description: description,
+                      required: required,
+                      allowEmptyValue: allow_empty_value.presence,
+                      deprecated: deprecated,
+                      schema: property_schema.to_openapi(version).except(:deprecated),
+                      examples: examples&.transform_values(&:to_openapi)
+                    }
+                  end
+                )
               ]
             end
           end

data/lib/jsapi/meta/property.rb

@@ -34,10 +34,12 @@ module Jsapi
       def initialize(name, keywords = {})
         raise ArgumentError, "property name can't be blank" if name.blank?
 
+        @name = name.to_s
+
         keywords = keywords.dup
         super(keywords.extract!(:read_only, :source, :write_only))
+        keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
-        @name = name.to_s
         @schema = Schema.new(keywords)
       end
 

data/lib/jsapi/meta/request_body/model.rb

@@ -4,6 +4,8 @@ module Jsapi
   module Meta
     module RequestBody
       class Model < Base
+        include OpenAPI::Extensions
+
         ##
         # :attr: description
         # The optional description of the request body.
@@ -26,6 +28,7 @@ module Jsapi
           super(keywords.extract!(:description, :examples))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
           @schema = Schema.new(keywords)
         end
@@ -43,12 +46,12 @@ module Jsapi
             in: 'body',
             description: description,
             required: required?
-          }.merge(schema.to_openapi('2.0')).compact
+          }.merge(schema.to_openapi('2.0')).merge(openapi_extensions).compact
         end
 
         # Returns a hash representing the \OpenAPI 3.x request body object.
         def to_openapi(version)
-          {
+          with_openapi_extensions(
             description: description,
             content: {
               'application/json' => {
@@ -57,7 +60,7 @@ module Jsapi
               }.compact
             },
             required: required?
-          }.compact
+          )
         end
       end
     end

data/lib/jsapi/meta/response/model.rb

@@ -4,6 +4,8 @@ module Jsapi
   module Meta
     module Response
       class Model < Base
+        include OpenAPI::Extensions
+
         ##
         # :attr: description
         # The optional description of the response.
@@ -36,6 +38,7 @@ module Jsapi
           super(keywords.extract!(:description, :examples, :locale))
 
           add_example(value: keywords.delete(:example)) if keywords.key?(:example)
+          keywords[:ref] = keywords.delete(:schema) if keywords.key?(:schema)
 
           @schema = Schema.new(**keywords)
         end
@@ -43,28 +46,31 @@ module Jsapi
         # Returns a hash representing the \OpenAPI response object.
         def to_openapi(version, definitions)
           version = OpenAPI::Version.from(version)
-          if version.major == 2
-            {
-              description: description,
-              schema: schema.to_openapi(version),
-              examples: (
-                if (example = examples&.values&.first).present?
-                  { 'application/json' => example.resolve(definitions).value }
-                end
-              )
-            }
-          else
-            {
-              description: description,
-              content: {
-                'application/json' => {
-                  schema: schema.to_openapi(version),
-                  examples: examples&.transform_values(&:to_openapi)
-                }.compact
-              },
-              links: links&.transform_values(&:to_openapi)
-            }
-          end.compact
+
+          with_openapi_extensions(
+            if version.major == 2
+              {
+                description: description,
+                schema: schema.to_openapi(version),
+                examples: (
+                  if (example = examples&.values&.first).present?
+                    { 'application/json' => example.resolve(definitions).value }
+                  end
+                )
+              }
+            else
+              {
+                description: description,
+                content: {
+                  'application/json' => {
+                    schema: schema.to_openapi(version),
+                    examples: examples&.transform_values(&:to_openapi)
+                  }.compact
+                },
+                links: links&.transform_values(&:to_openapi)
+              }
+            end
+          )
         end
       end
     end

data/lib/jsapi/meta/schema/additional_properties.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module Schema
+      class AdditionalProperties < Meta::Base
+        #
+        # :attr: schema
+        # The Schema of additional properties.
+        attribute :schema, Schema, writer: false
+
+        ##
+        # :attr: source
+        # The method to read additional properties when serializing an object.
+        # The default method is +additional_properties+.
+        attribute :source, Symbol, default: :additional_properties
+
+        delegate_missing_to :schema
+
+        def initialize(keywords = {})
+          keywords = keywords.dup
+          super(keywords.extract!(:source))
+
+          @schema = Schema.new(keywords)
+        end
+      end
+    end
+  end
+end

data/lib/jsapi/meta/schema/array.rb

@@ -7,7 +7,7 @@ module Jsapi
         ##
         # :attr: items
         # The Schema defining the kind of items.
-        attribute :items, Schema
+        attribute :items, Schema, writer: false
 
         ##
         # :attr: max_items
@@ -19,6 +19,14 @@ module Jsapi
         # The minimum length of an array.
         attribute :min_items, writer: false
 
+        def items=(keywords = {}) # :nodoc:
+          if keywords.key?(:schema)
+            keywords = keywords.dup
+            keywords[:ref] = keywords.delete(:schema)
+          end
+          @items = Schema.new(keywords)
+        end
+
         def max_items=(value) # :nodoc:
           add_validation('max_items', Validation::MaxItems.new(value))
           @max_items = value

data/lib/jsapi/meta/schema/base.rb

@@ -4,6 +4,8 @@ module Jsapi
   module Meta
     module Schema
       class Base < Meta::Base
+        include OpenAPI::Extensions
+
         TYPES = %w[array boolean integer number object string].freeze # :nodoc:
 
         TYPES.each do |type|
@@ -96,37 +98,40 @@ module Jsapi
         # Returns a hash representing the \OpenAPI schema object.
         def to_openapi(version)
           version = OpenAPI::Version.from(version)
-          if version.major == 2
-            # OpenAPI 2.0
-            {
-              type: type,
-              example: examples&.first
-            }
-          elsif version.minor.zero?
-            # OpenAPI 3.0
-            {
-              type: type,
-              nullable: nullable?.presence,
-              examples: examples,
-              deprecated: deprecated?.presence
-            }
-          else
-            # OpenAPI 3.1
-            {
-              type: nullable? ? [type, 'null'] : type,
-              examples: examples,
-              deprecated: deprecated?.presence
-            }
-          end.tap do |hash|
-            hash[:title] = title
-            hash[:description] = description
-            hash[:default] = default
-            hash[:externalDocs] = external_docs&.to_openapi
 
-            validations.each_value do |validation|
-              hash.merge!(validation.to_openapi_validation(version))
+          with_openapi_extensions(
+            if version.major == 2
+              # OpenAPI 2.0
+              {
+                type: type,
+                example: examples&.first
+              }
+            elsif version.minor.zero?
+              # OpenAPI 3.0
+              {
+                type: type,
+                nullable: nullable?.presence,
+                examples: examples,
+                deprecated: deprecated?.presence
+              }
+            else
+              # OpenAPI 3.1
+              {
+                type: nullable? ? [type, 'null'] : type,
+                examples: examples,
+                deprecated: deprecated?.presence
+              }
+            end.tap do |hash|
+              hash[:title] = title
+              hash[:description] = description
+              hash[:default] = default
+              hash[:externalDocs] = external_docs&.to_openapi
+
+              validations.each_value do |validation|
+                hash.merge!(validation.to_openapi_validation(version))
+              end
             end
-          end.compact
+          )
         end
 
         def type # :nodoc: