jsapi 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72aa6ad77a99ade6acb3d5c70b6521b640e012cccc7e9ab00b9d55db3062d4d6
-  data.tar.gz: 96ec077740dde1963ca6b448662e1f4370f3bc0b54778db2d03d9447ba69aa3b
+  metadata.gz: 78a92c9f73f4a39ede65ad5b0b5646db67dc8b9e2b3ca444b6de32fdb75e349a
+  data.tar.gz: e235535541854c172f578cce7cf112ceebe880971643cb33125a76cc61bbd88a
 SHA512:
-  metadata.gz: ec7997fbedc7c9035f9e36d5426b23502b87f4c4c654b1e02f93db711f514a8a434d371dc4761156165c439256ad3f339c7a151b1b35c8dcbf3d1e14f1fd4628
-  data.tar.gz: 1f2952e80bf883302fd835f9425bae0bd2e7629b2746d3abec4b19a259c5abbd9869534b18eb6c69afd94a9397e13c7d86d78720f3573d92ef355b1e66b99fb0
+  metadata.gz: 7c139744bacb90f772bb40779a8d149daf025dd838ffc3268c35640dfe18da1934e62ffd2e319658478ef5c4d54a4f630ed76eabf60a22df641f1ce7da218150
+  data.tar.gz: b9e72517dea9061eaa23b5ff5631745a18769614c04d2a91ae97db2e715c30504bc5b849fdcaa89384f7fb2618e5ea639601f637b9583b5fec219bd053006f08

data/lib/jsapi/controller/methods.rb

@@ -13,9 +13,9 @@ module Jsapi
       end
 
       # Performs an API operation by calling the given block. The request parameters are
-      # passed as an instance of the operation's model class to the block. The object
-      # returned by the block is implicitly rendered according to the appropriate
-      # +response+ specification.
+      # passed as an instance of the operation's model class to the block. Parameter names
+      # are converted to snake case. The object returned by the block is implicitly rendered
+      # according to the appropriate +response+ specification.
       #
       #   api_operation('foo') do |api_params|
       #     # ...
@@ -53,6 +53,7 @@ module Jsapi
       end
 
       # Returns the request parameters as an instance of the operation's model class.
+      # Parameter names are converted to snake case.
       #
       #   params = api_params('foo')
       #

data/lib/jsapi/controller/parameters.rb

@@ -25,15 +25,12 @@ module Jsapi
         end
         request_body = operation.request_body&.resolve(definitions)
         if request_body && request_body.schema.respond_to?(:properties)
-          meta_models.merge!(
-            request_body.schema.resolve_properties(:write, definitions)
-          )
+          meta_models.merge!(request_body.schema.resolve_properties(:write, definitions))
         end
 
         # Wrap params
         meta_models.each do |name, meta_model|
-          @raw_attributes[name] =
-            JSON.wrap(params[name], meta_model.schema, definitions)
+          @raw_attributes[name.underscore] = JSON.wrap(params[name], meta_model.schema, definitions)
         end
       end
 

data/lib/jsapi/controller/response.rb

@@ -5,8 +5,8 @@ module Jsapi
     # Used to serialize a response.
     class Response
 
-      # Creates a new instance to serialize +object+ according to +response+. References are
-      # resolved to API components in +definitions+.
+      # Creates a new instance to serialize +object+ according to +response+. References
+      # are resolved to API components in +definitions+.
       def initialize(object, response, definitions)
         @object = object
         @response = response
@@ -37,33 +37,13 @@ module Jsapi
 
         case schema.type
         when 'array'
-          item_schema = schema.items.resolve(@definitions)
-          Array(object).map { |item| serialize(item, item_schema, path) }
+          serialize_array(object, schema, path)
         when 'integer'
           schema.convert(object.to_i)
         when 'number'
           schema.convert(object.to_f)
         when 'object'
-          return if object.blank? # {}
-
-          # Select inherriting schema on polymorphism
-          if (discriminator = schema.discriminator)
-            discriminator_property = schema.properties[discriminator.property_name]
-            schema = discriminator.resolve(
-              object.public_send(
-                discriminator_property.source || discriminator_property.name
-              ),
-              @definitions
-            )
-          end
-          # Serialize properties
-          schema.resolve_properties(:read, @definitions).transform_values do |property|
-            serialize(
-              object.public_send(property.source || property.name),
-              property.schema.resolve(@definitions),
-              path.nil? ? property.name : "#{path}.#{property.name}"
-            )
-          end
+          serialize_object(object, schema, path)
         when 'string'
           schema.convert(
             case schema.format
@@ -81,6 +61,48 @@ module Jsapi
           object
         end
       end
+
+      def serialize_array(array, schema, path)
+        item_schema = schema.items.resolve(@definitions)
+        Array(array).map { |item| serialize(item, item_schema, path) }
+      end
+
+      def serialize_object(object, schema, path)
+        return if object.blank? # {}
+
+        # Select inherriting schema on polymorphism
+        if (discriminator = schema.discriminator)
+          discriminator_property = schema.properties[discriminator.property_name]
+          schema = discriminator.resolve(
+            object.public_send(discriminator_property.source || discriminator_property.name.underscore),
+            @definitions
+          )
+        end
+        # Serialize properties
+        properties = schema.resolve_properties(:read, @definitions).transform_values do |property|
+          serialize(
+            object.public_send(property.source || property.name.underscore),
+            property.schema.resolve(@definitions),
+            path.nil? ? property.name : "#{path}.#{property.name}"
+          )
+        end
+        if (additional_properties = schema.additional_properties&.resolve(@definitions))
+          additional_properties_schema = additional_properties.schema.resolve(@definitions)
+
+          object.public_send(additional_properties.source)&.each do |key, value|
+            # Don't replace the property with the same key
+            next if properties.key?(key = key.to_s)
+
+            # Serialize the additional property
+            properties[key] = serialize(
+              value,
+              additional_properties_schema,
+              path.nil? ? key : "#{path}.#{key}"
+            )
+          end
+        end
+        properties
+      end
     end
   end
 end

data/lib/jsapi/json/object.rb

@@ -11,16 +11,13 @@ module Jsapi
       def initialize(attributes, schema, definitions)
         # Select inherriting schema on polymorphism
         if (discriminator = schema.discriminator)
-          schema = discriminator.resolve(
-            attributes[discriminator.property_name],
-            definitions
-          )
+          schema = discriminator.resolve(attributes[discriminator.property_name], definitions)
         end
         # Wrap attribute values
-        @raw_attributes = schema.resolve_properties(:write, definitions)
-                                .transform_values do |property|
-          JSON.wrap(attributes[property.name], property.schema, definitions)
-        end
+        @raw_attributes =
+          schema.resolve_properties(:write, definitions).transform_values do |property|
+            JSON.wrap(attributes[property.name], property.schema, definitions)
+          end
 
         super(schema)
       end

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

@@ -4,6 +4,8 @@ module Jsapi
   module Meta
     module Example
       class Model < Base
+        include OpenAPI::Extensions
+
         ##
         # :attr: description
         # The optional description of the example.
@@ -26,10 +28,7 @@ module Jsapi
 
         # Returns a hash representing the \OpenAPI example object.
         def to_openapi(*)
-          {}.tap do |hash|
-            hash[:summary] = summary if summary.present?
-            hash[:description] = description if description.present?
-
+          with_openapi_extensions(summary: summary, description: description).tap do |hash|
             if external?
               hash[:external_value] = value
             else

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a contact object.
       class Contact < Base
+        include Extensions
+
         ##
         # :attr: email
         # The email address of the contact.
@@ -22,11 +24,7 @@ module Jsapi
 
         # Returns a hash representing the contact object.
         def to_openapi(*)
-          {
-            name: name,
-            url: url,
-            email: email
-          }.compact
+          with_openapi_extensions(name: name, url: url, email: email)
         end
       end
     end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module OpenAPI
+      module Extensions
+        # Adds an \OpenAPI extension.
+        #
+        # Raises an +ArgumentError+ if +name+ is blank.
+        def add_openapi_extension(name, value = nil)
+          raise ArgumentError, "name can't be blank" if name.blank?
+
+          openapi_extensions["x-#{name}".to_sym] = value
+        end
+
+        # Returns a hash containing the \OpenAPI extensions.
+        def openapi_extensions
+          @openapi_extensions ||= {}
+        end
+
+        private
+
+        def with_openapi_extensions(keywords = {}) # :nodoc:
+          keywords.merge!(openapi_extensions)
+          keywords.compact!
+          keywords
+        end
+      end
+    end
+  end
+end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an external documentation object.
       class ExternalDocumentation < Base
+        include Extensions
+
         ##
         # :attr: description
         # The optional description of the external documentation.
@@ -17,10 +19,7 @@ module Jsapi
 
         # Returns a hash representing the external documentation object.
         def to_openapi(*)
-          {
-            url: url,
-            description: description
-          }.compact
+          with_openapi_extensions(url: url, description: description)
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an info object.
       class Info < Base
+        include Extensions
+
         ##
         # :attr: contact
         # The optional Contact object.
@@ -37,14 +39,14 @@ module Jsapi
 
         # Returns a hash representing the info object.
         def to_openapi(*)
-          {
+          with_openapi_extensions(
             title: title,
             version: version,
             description: description,
             termsOfService: terms_of_service,
             contact: contact&.to_openapi,
             license: license&.to_openapi
-          }.compact
+          )
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents a license object.
       class License < Base
+        include Extensions
+
         ##
         # :attr: name
         # The name of the license.
@@ -17,10 +19,7 @@ module Jsapi
 
         # Returns a hash representing the license object.
         def to_openapi(*)
-          {
-            name: name,
-            url: url
-          }.compact
+          with_openapi_extensions(name: name, url: url)
         end
       end
     end

data/lib/jsapi/meta/openapi/link/model.rb

@@ -6,6 +6,8 @@ module Jsapi
       module Link
         # Represents a link object.
         class Model < Base
+          include Extensions
+
           ##
           # :attr: description
           # The optional description of the link.
@@ -33,13 +35,13 @@ module Jsapi
 
           # Returns a hash representing the link object.
           def to_openapi(*)
-            {
+            with_openapi_extensions(
               operationId: operation_id,
               parameters: parameters,
               requestBody: request_body,
               description: description,
               server: server&.to_openapi
-            }.compact
+            )
           end
         end
       end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an OAuth flow object.
       class OAuthFlow < Base
+        include Extensions
+
         class Scope < Base
           ##
           # :attr: description
@@ -37,12 +39,12 @@ module Jsapi
 
         # Returns a hash representing the OAuth flow object.
         def to_openapi(version)
-          {
+          with_openapi_extensions(
             authorizationUrl: authorization_url,
             tokenUrl: token_url,
             refreshUrl: (refresh_url if version.major > 2),
             scopes: scopes.transform_values(&:description)
-          }.compact
+          )
         end
       end
     end

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

@@ -5,6 +5,8 @@ module Jsapi
     module OpenAPI
       # Represents an \OpenAPI object.
       class Root < Base
+        include Extensions
+
         ##
         # :attr: callbacks
         # The reusable Callback objects. Applies to \OpenAPI 3.0 and higher.
@@ -95,38 +97,40 @@ module Jsapi
               value.to_openapi(version)
             end
 
-          if version.major == 2
-            uri = servers&.first&.then { |server| URI(server.url) }
-            {
-              swagger: '2.0',
-              info: info&.to_openapi,
-              host: host || uri&.hostname,
-              basePath: base_path || uri&.path,
-              schemes: schemes || uri&.scheme&.then { |scheme| [scheme] },
-              consumes: consumed_mime_types,
-              produces: produced_mime_types,
-              securityDefinitions: security_schemes,
-              security: security_requirements&.map(&:to_openapi),
-              tags: tags&.map(&:to_openapi),
-              externalDocs: external_docs&.to_openapi
-            }
-          else
-            {
-              openapi: version.minor.zero? ? '3.0.3' : '3.1.0',
-              info: info&.to_openapi,
-              servers: servers&.map(&:to_openapi),
-              components: {
-                callbacks: callbacks&.transform_values do |callback|
-                  callback.to_openapi(version, definitions)
-                end,
-                links: links&.transform_values(&:to_openapi),
-                securitySchemes: security_schemes
-              }.compact.presence,
-              security: security_requirements&.map(&:to_openapi),
-              tags: tags&.map(&:to_openapi),
-              externalDocs: external_docs&.to_openapi
-            }
-          end.compact
+          with_openapi_extensions(
+            if version.major == 2
+              uri = servers&.first&.then { |server| URI(server.url) }
+              {
+                swagger: '2.0',
+                info: info&.to_openapi,
+                host: host || uri&.hostname,
+                basePath: base_path || uri&.path,
+                schemes: schemes || uri&.scheme&.then { |scheme| [scheme] },
+                consumes: consumed_mime_types,
+                produces: produced_mime_types,
+                securityDefinitions: security_schemes,
+                security: security_requirements&.map(&:to_openapi),
+                tags: tags&.map(&:to_openapi),
+                externalDocs: external_docs&.to_openapi
+              }
+            else
+              {
+                openapi: version.minor.zero? ? '3.0.3' : '3.1.0',
+                info: info&.to_openapi,
+                servers: servers&.map(&:to_openapi),
+                components: {
+                  callbacks: callbacks&.transform_values do |callback|
+                    callback.to_openapi(version, definitions)
+                  end,
+                  links: links&.transform_values(&:to_openapi),
+                  securitySchemes: security_schemes
+                }.compact.presence,
+                security: security_requirements&.map(&:to_openapi),
+                tags: tags&.map(&:to_openapi),
+                externalDocs: external_docs&.to_openapi
+              }
+            end
+          )
         end
       end
     end

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

@@ -6,6 +6,8 @@ module Jsapi
       module SecurityScheme
         # Represents a security scheme based on an API key.
         class APIKey < Base
+          include Extensions
+
           ##
           # :attr: in
           # The location of the API key. Possible values are:
@@ -24,12 +26,12 @@ module Jsapi
 
           # Returns a hash representing the security scheme object.
           def to_openapi(*)
-            {
+            with_openapi_extensions(
               type: 'apiKey',
               name: name,
               in: self.in,
               description: description
-            }.compact
+            )
           end
         end
       end

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.
@@ -87,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
@@ -141,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/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.
@@ -44,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' => {
@@ -58,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.
@@ -44,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/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:

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

@@ -4,15 +4,21 @@ module Jsapi
   module Meta
     module Schema
       class Object < Base
+        ##
+        # :attr: additional_properties
+        # The AdditionalProperties.
+        attribute :additional_properties, AdditionalProperties
+
         ##
         # :attr: all_of_references
         attribute :all_of_references, [Reference], default: []
 
-        alias :all_of= :all_of_references=
+        alias :all_of= :all_of_references= # :nodoc:
         alias :add_all_of :add_all_of_reference
 
         ##
         # :attr: discriminator
+        # The Discriminator.
         attribute :discriminator, Discriminator
 
         ##
@@ -47,6 +53,7 @@ module Jsapi
           super.merge(
             allOf: all_of_references.map(&:to_json_schema).presence,
             properties: properties.transform_values(&:to_json_schema),
+            additionalProperties: additional_properties&.to_json_schema,
             required: properties.values.select(&:required?).map(&:name)
           ).compact
         end
@@ -60,6 +67,7 @@ module Jsapi
             properties: properties.transform_values do |property|
               property.to_openapi(version)
             end,
+            additionalProperties: additional_properties&.to_openapi(version),
             required: properties.values.select(&:required?).map(&:name)
           ).compact
         end

data/lib/jsapi/meta/schema.rb

@@ -4,13 +4,14 @@ require_relative 'schema/conversion'
 require_relative 'schema/boundary'
 require_relative 'schema/delegator'
 require_relative 'schema/reference'
-require_relative 'schema/discriminator'
 require_relative 'schema/base'
 require_relative 'schema/boolean'
 require_relative 'schema/array'
 require_relative 'schema/numeric'
 require_relative 'schema/integer'
 require_relative 'schema/number'
+require_relative 'schema/additional_properties'
+require_relative 'schema/discriminator'
 require_relative 'schema/object'
 require_relative 'schema/string'
 require_relative 'schema/validation'

data/lib/jsapi/version.rb

@@ -5,6 +5,6 @@ module Jsapi
     # NOTE: See https://bundler.io/guides/creating_gem.html
 
     # The current GEM version.
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-07-14 00:00:00.000000000 Z
 dependencies: []
 description: Jsapi can be used to read requests, produce responses and create OpenAPI
   documents
@@ -66,6 +66,7 @@ files:
 - lib/jsapi/meta/openapi/callback/model.rb
 - lib/jsapi/meta/openapi/callback/reference.rb
 - lib/jsapi/meta/openapi/contact.rb
+- lib/jsapi/meta/openapi/extensions.rb
 - lib/jsapi/meta/openapi/external_documentation.rb
 - lib/jsapi/meta/openapi/info.rb
 - lib/jsapi/meta/openapi/license.rb
@@ -102,6 +103,7 @@ files:
 - lib/jsapi/meta/response/model.rb
 - lib/jsapi/meta/response/reference.rb
 - lib/jsapi/meta/schema.rb
+- lib/jsapi/meta/schema/additional_properties.rb
 - lib/jsapi/meta/schema/array.rb
 - lib/jsapi/meta/schema/base.rb
 - lib/jsapi/meta/schema/boolean.rb