jsapi 0.9.1 → 0.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4631e17cbd92a36a62ab6e7aa139b65afa83fccc2c41da34c3f757f2b077340f
-  data.tar.gz: 4c547aeb52a0fc74c09389f2c97dd0b8c90883fd36c79b9c502689a25379f3f5
+  metadata.gz: 59c9ddcd1965cd62ee1b1bbb0e7f066061eaef6a5f8217c69b6d86ee92230b4a
+  data.tar.gz: f02a5ff2b0d13ca4c238356b8d11473432ec71b12b40218639335f9f2f45f1da
 SHA512:
-  metadata.gz: 1db64f601b34597e5b13ee820482c5a72d2adef153feac7ef3e1141804df36cc8816f665ee18c73e1b30e50a8c13454bed4c7562d447b2fdaf1b3814d863bd09
-  data.tar.gz: a4bd27f4fcc7c50ee9447e70777ca54de3e81ee6fd7ab3124817baf54511c90d0d95cf461c09c7fdc42a3bf8b57bb62d91954bc96d8a44a77eb15f9d53d2f5be
+  metadata.gz: 4f8f331323ab4d88ba89133f37b0eee8fc6bdb1ab5159f3ce5885b7139d4376e74f6df42ed8232c6ea5c4cb7b373d8ea5a8c866c6833d23f5f1412f6a004ea14
+  data.tar.gz: f7061a754b6bbde17046b4cc4cb29eca42daede67f3978f474574c9389d555815e5e11f8f2af021f93985458511790699a64d8cd5fc95b03f421792dcd0dd4a5

data/lib/jsapi/dsl/definitions.rb

@@ -218,7 +218,7 @@ module Jsapi
       ##
       # :method: security_requirement
       # :args: **keywords, &block
-      # Adds a security requirement.
+      # Specifies a security requirement.
       #
       #   security_requirement do
       #     scheme 'basic_auth'

data/lib/jsapi/dsl/operation.rb

@@ -38,6 +38,15 @@ module Jsapi
       #
       #   deprecated true
 
+      ##
+      # :method: external_docs
+      # :args: **keywords, &block
+      # Specifies the external documentation.
+      #
+      #    external_docs url: 'https://foo.bar/docs'
+      #
+      # See Meta::Operation#external_docs for further information.
+
       ##
       # :method: description
       # :args: arg
@@ -162,6 +171,17 @@ module Jsapi
         end
       end
 
+      ##
+      # :method: security_requirement
+      # :args: **keywords, &block
+      # Specifies a security requirement.
+      #
+      #   security_requirement do
+      #     scheme 'basic_auth'
+      #   end
+      #
+      # See Meta::Operation#security_requirements for further information.
+
       ##
       # :method: summary
       # :args: arg

data/lib/jsapi/dsl/schema.rb

@@ -5,6 +5,15 @@ module Jsapi
     # Used to define a schema.
     class Schema < Base
 
+      ##
+      # :method: additional_properties
+      # :args: **keywords, &block
+      # Specifies the schema of properties that are not explicity specified.
+      #
+      #   additional_properties type: 'string'
+      #
+      # See Meta::Schema::Object#additional_properties for further information.
+
       # Includes all of the properties from +schemas+. Each argument must be the name of
       # a schema defined by ClassMethods#api_schema or Definitions#schema.
       def all_of(*schemas)
@@ -47,8 +56,9 @@ module Jsapi
       #
       #   enum %w[foo bar]
 
-      ## :method: external_docs
-      ## :args: **keywords, &blocks
+      ##
+      # :method: external_docs
+      # :args: **keywords, &block
       # Specifies the external documentation.
       #
       # See Meta::Schema::Base#external_docs for further information.

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

@@ -3,6 +3,7 @@
 module Jsapi
   module Meta
     module Callback
+      # Specifies a callback reference.
       class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(*)

data/lib/jsapi/meta/definitions.rb

@@ -382,10 +382,14 @@ module Jsapi
         @objects ||= ancestors.each_with_object({}) do |ancestor, objects|
           self.class.attribute_names.each do |key|
             case value = ancestor.send(key)
-            when Hash
-              (objects[key] ||= {}).reverse_merge!(value)
             when Array
               (objects[key] ||= []).push(*value)
+            when Hash
+              if (hash = objects[key])
+                value.each { |k, v| hash[k] = v unless hash.key?(k) }
+              else
+                objects[key] = value.dup
+              end
             else
               objects[key] ||= value
             end

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

@@ -3,6 +3,7 @@
 module Jsapi
   module Meta
     module Example
+      # Specifies an example reference.
       class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(*)

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

@@ -3,6 +3,7 @@
 module Jsapi
   module Meta
     module Header
+      # Specifies a header reference.
       class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(*)

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

@@ -3,6 +3,7 @@
 module Jsapi
   module Meta
     module Link
+      # Specifies a link reference.
       class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(*)

data/lib/jsapi/meta/operation.rb

@@ -2,7 +2,7 @@
 
 module Jsapi
   module Meta
-    # Defines an API operation.
+    # Specifies an API operation.
     class Operation < Base::Model
       include OpenAPI::Extensions
 

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

@@ -3,10 +3,10 @@
 module Jsapi
   module Meta
     module Parameter
-      # Defines a parameter.
+      # Specifies a parameter.
       class Model < Base::Model
-        include ToOpenAPI
         include OpenAPI::Extensions
+        include ToOpenAPI
 
         delegate_missing_to :schema
 

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

@@ -3,12 +3,14 @@
 module Jsapi
   module Meta
     module Parameter
+      # Specifies a parameter reference.
       class Reference < Base::Reference
         include ToOpenAPI
 
-        # Returns an array of hashes. Each hash represents an \OpenAPI parameter object
-        # if the type of the referred parameter is <code>"object"</code>. Otherwise the
-        # array contains a single hash representing the \OpenAPI reference object.
+        # Returns an array of hashes. If the type of the referred parameter is
+        # <code>"object"</code>, each hash represents an \OpenAPI parameter object.
+        # Otherwise the array contains a single hash representing the \OpenAPI
+        # reference object.
         #
         # Raises a ReferenceError when the reference could not be resolved.
         def to_openapi_parameters(version, definitions)

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

@@ -4,6 +4,7 @@ module Jsapi
   module Meta
     module Parameter
       module ToOpenAPI
+        # Returns a hash representing the \OpenAPI parameter or reference object.
         def to_openapi(version, definitions)
           to_openapi_parameters(version, definitions).first
         end

data/lib/jsapi/meta/property.rb

@@ -2,6 +2,7 @@
 
 module Jsapi
   module Meta
+    # Specifies a property
     class Property < Base::Model
       delegate_missing_to :schema
 

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

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module RequestBody
-      # Defines a request body.
+      # Specifies a request body.
       class Model < Base::Model
         include OpenAPI::Extensions
 

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

@@ -3,6 +3,7 @@
 module Jsapi
   module Meta
     module RequestBody
+      # Specifies a request body reference.
       class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(*)

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

@@ -3,7 +3,7 @@
 module Jsapi
   module Meta
     module Response
-      # Defines a response.
+      # Specifies a response.
       class Model < Base::Model
         include OpenAPI::Extensions
 

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

@@ -3,6 +3,7 @@
 module Jsapi
   module Meta
     module Response
+      # Specifies a response reference.
       class Reference < Base::Reference
         # Returns a hash representing the \OpenAPI reference object.
         def to_openapi(version, *)

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.9.1'
+    VERSION = '0.9.2'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.9.2
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-18 00:00:00.000000000 Z
+date: 2024-10-24 00:00:00.000000000 Z
 dependencies: []
 description:
 email: denis@dmgoeller.de