jsapi 0.2.0 → 0.4.0

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.
@@ -12,7 +14,12 @@ module Jsapi
         ##
         # :attr: examples
         # The optional examples.
-        attribute :examples, { String => Example }, default_key: 'default'
+        attribute :examples, { String => OpenAPI::Example }, default_key: 'default'
+
+        ##
+        # :attr: headers
+        # The response headers.
+        attribute :headers, { String => OpenAPI::Header }
 
         ##
         # :attr: links
@@ -44,28 +51,35 @@ 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),
+                headers: headers&.transform_values do |header|
+                  header.to_openapi(version) unless header.reference?
+                end&.compact,
+                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
+                },
+                headers: headers&.transform_values { |header| header.to_openapi(version) },
+                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/meta.rb

@@ -6,7 +6,6 @@ require_relative 'meta/attributes'
 require_relative 'meta/base'
 require_relative 'meta/base_reference'
 require_relative 'meta/openapi'
-require_relative 'meta/example'
 require_relative 'meta/existence'
 require_relative 'meta/property'
 require_relative 'meta/schema'

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.4.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.4.0
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies: []
 description: Jsapi can be used to read requests, produce responses and create OpenAPI
   documents
@@ -56,9 +56,6 @@ files:
 - lib/jsapi/meta/base.rb
 - lib/jsapi/meta/base_reference.rb
 - lib/jsapi/meta/definitions.rb
-- lib/jsapi/meta/example.rb
-- lib/jsapi/meta/example/model.rb
-- lib/jsapi/meta/example/reference.rb
 - lib/jsapi/meta/existence.rb
 - lib/jsapi/meta/invalid_argument_error.rb
 - lib/jsapi/meta/openapi.rb
@@ -66,7 +63,14 @@ 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/example.rb
+- lib/jsapi/meta/openapi/example/model.rb
+- lib/jsapi/meta/openapi/example/reference.rb
+- lib/jsapi/meta/openapi/extensions.rb
 - lib/jsapi/meta/openapi/external_documentation.rb
+- lib/jsapi/meta/openapi/header.rb
+- lib/jsapi/meta/openapi/header/model.rb
+- lib/jsapi/meta/openapi/header/reference.rb
 - lib/jsapi/meta/openapi/info.rb
 - lib/jsapi/meta/openapi/license.rb
 - lib/jsapi/meta/openapi/link.rb
@@ -102,6 +106,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

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module Example
-      class Model < Base
-        ##
-        # :attr: description
-        # The optional description of the example.
-        attribute :description, String
-
-        ##
-        # :attr: external
-        # If true, +value+ is interpreted as a URI pointing to an external sample value.
-        attribute :external, values: [true, false]
-
-        ##
-        # :attr: summary
-        # The optional summary of the example.
-        attribute :summary, String
-
-        ##
-        # :attr: value
-        # The sample value.
-        attribute :value
-
-        # 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?
-
-            if external?
-              hash[:external_value] = value
-            else
-              hash[:value] = value
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Jsapi
-  module Meta
-    module Example
-      class Reference < BaseReference
-        # Returns a hash representing the \OpenAPI reference object.
-        def to_openapi(*)
-          { '$ref': "#/components/examples/#{ref}" }
-        end
-      end
-    end
-  end
-end

data/lib/jsapi/meta/example.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'example/model'
-require_relative 'example/reference'
-
-module Jsapi
-  module Meta
-    module Example
-      class << self
-        # Creates a new example model or reference.
-        def new(keywords = {})
-          return Reference.new(keywords) if keywords.key?(:ref)
-
-          Model.new(keywords)
-        end
-      end
-    end
-  end
-end