jsapi 1.1.1 → 1.3

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

@@ -4,9 +4,6 @@ module Jsapi
   module Meta
     module SecurityScheme
       # Specifies a security scheme based on OpenID Connect.
-      #
-      # 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 OpenAPI::Extensions
 
@@ -15,15 +12,15 @@ module Jsapi
         attribute :open_id_connect_url, String
 
         # Returns a hash representing the \OpenAPI security scheme object, or +nil+
-        # if <code>version.major</code> is 2.
+        # if <code>version</code> is less than \OpenAPI 3.0.
         def to_openapi(version, *)
           version = OpenAPI::Version.from(version)
-          return if version.major == 2
+          return if version < OpenAPI::V3_0
 
           with_openapi_extensions(
-            type: 'openIdConnect',
-            openIdConnectUrl: open_id_connect_url,
-            description: description
+            base_openapi_fields('openIdConnect', version).merge(
+              openIdConnectUrl: open_id_connect_url
+            )
           )
         end
       end

data/lib/jsapi/meta/security_scheme.rb

@@ -3,6 +3,7 @@
 require_relative 'security_scheme/base'
 require_relative 'security_scheme/api_key'
 require_relative 'security_scheme/http'
+require_relative 'security_scheme/mutual_tls'
 require_relative 'security_scheme/oauth2'
 require_relative 'security_scheme/open_id_connect'
 
@@ -31,6 +32,8 @@ module Jsapi
             HTTP.new(keywords.merge(scheme: 'basic'))
           when 'http' # OpenAPI 3.0 and higher
             HTTP.new(keywords)
+          when 'mutual_tls' # OpenAPI 3.1 and higher
+            MutualTLS.new(keywords)
           when 'oauth2'
             OAuth2.new(keywords)
           when 'open_id_connect' # OpenAPI 3.0 and higher

data/lib/jsapi/meta/server.rb

@@ -11,6 +11,11 @@ module Jsapi
       # The description of the server.
       attribute :description, String
 
+      ##
+      # :attr: name
+      # The optional unique name of the server. Applies to \OpenAPI 3.2 and higher.
+      attribute :name, String
+
       ##
       # :attr: url
       # The absolute or relative URL of the server.
@@ -22,10 +27,13 @@ module Jsapi
       attribute :variables, { String => ServerVariable }
 
       # Returns a hash representing the \OpenAPI server object.
-      def to_openapi(*)
+      def to_openapi(version, *)
+        version = OpenAPI::Version.from(version)
+
         with_openapi_extensions(
           url: url,
           description: description,
+          name: (name if version >= OpenAPI::V3_2),
           variables: variables.transform_values(&:to_openapi).presence
         )
       end

data/lib/jsapi/meta/tag.rb

@@ -16,17 +16,47 @@ module Jsapi
       # The ExternalDocumentation object.
       attribute :external_docs, ExternalDocumentation
 
+      ##
+      # :attr: kind
+      # The category of the tag. Applies to \OpenAPI 3.2 and higher.
+      attribute :kind, String
+
       ##
       # :attr: name
       # The name of the tag.
       attribute :name, String
 
+      ##
+      # :attr: parent
+      # The name of the parent tag. Applies to \OpenAPI 3.2 and higher.
+      attribute :parent, String
+
+      ##
+      # :attr: summary
+      # The short summary of the tag. Applies to \OpenAPI 3.2 and higher.
+      attribute :summary, String
+
       # Returns a hash representing the \OpenAPI tag object.
-      def to_openapi(*)
+      def to_openapi(version, *)
+        version = OpenAPI::Version.from(version)
+
         with_openapi_extensions(
-          name: name,
-          description: description,
-          externalDocs: external_docs&.to_openapi
+          if version >= OpenAPI::V3_2
+            {
+              name: name,
+              summary: summary,
+              description: description,
+              externalDocs: external_docs&.to_openapi,
+              parent: parent,
+              kind: kind
+            }
+          else
+            {
+              name: name,
+              description: description,
+              externalDocs: external_docs&.to_openapi
+            }
+          end
         )
       end
     end

data/lib/jsapi/model/base.rb

@@ -25,7 +25,43 @@ module Jsapi
       extend ActiveModel::Translation
       include ActiveModel::Validations
 
-      delegate :[], :additional_attributes, :attribute?, :attributes, to: :@nested
+      ##
+      # :method: []
+      # :call-seq: [](name)
+      #
+      # Returns the value assigned to +name+.
+
+      ##
+      # :method: additional_attributes
+      #
+      # Returns a hash containing the additional attributes.
+
+      ##
+      # :method: attribute?
+      # :call-seq: attribute?(name)
+      #
+      # Returns +true+ if +name+ is present, +false+ otherwise.
+
+      ##
+      # :method: attributes
+      #
+      # Returns a hash containing all attributes.
+
+      ##
+      # :method: serializable_hash
+      # :call-seq: serializable_hash(**options)
+      #
+      # Returns a hash containing serializable representations of all attributes.
+      #
+      # Possible options are:
+      #
+      # - +:only+ - The hash contains the given attributes only.
+      # - +:except+ - The hash does not contain the given attributes.
+      # - +:symbolize_names+ - If set to true, keys are symbols.
+      # - +:jsonify_values+ - If set to true, values are converted by +as_json+.
+
+      delegate :[], :additional_attributes, :attribute?, :attributes,
+               :serializable_hash, to: :@nested
 
       validate :_nested_validity
 

data/lib/jsapi/model/nestable.rb

@@ -13,7 +13,7 @@ module Jsapi
         raw_additional_attributes.transform_values(&:value)
       end
 
-      # Returns +true+ if +name+ is present, false +otherwise+.
+      # Returns +true+ if +name+ is present, +false+ otherwise.
       def attribute?(name)
         raw_attributes.key?(name&.to_s)
       end
@@ -32,6 +32,32 @@ module Jsapi
         }>"
       end
 
+      # Returns a hash containing serializable representations of all attributes.
+      #
+      # Possible options are:
+      #
+      # - +:only+ - The hash contains the given attributes only.
+      # - +:except+ - The hash does not contain the given attributes.
+      # - +:symbolize_names+ - If set to true, keys are symbols.
+      # - +:jsonify_values+ - If set to true, values are converted by +as_json+.
+      def serializable_hash(**options)
+        options = options.dup
+        except = options.delete(:except)&.map(&:to_s)
+        only = options.delete(:only)&.map(&:to_s)
+        symbolize_names = options[:symbolize_names] == true
+
+        {}.tap do |hash|
+          [raw_attributes, raw_additional_attributes].each do |attributes|
+            attributes.each do |name, value|
+              next if except&.include?(name) || only&.exclude?(name)
+
+              name = name.to_sym if symbolize_names
+              hash[name] = value.serializable_value(**options)
+            end
+          end
+        end
+      end
+
       private
 
       def validate_attributes(errors)

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 = '1.1.1'
+    VERSION = '1.3'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: '1.3'
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-06-19 00:00:00.000000000 Z
+date: 2025-11-02 00:00:00.000000000 Z
 dependencies: []
 description:
 email: denis@dmgoeller.de
@@ -80,6 +80,7 @@ files:
 - lib/jsapi/meta/oauth_flow.rb
 - lib/jsapi/meta/openapi.rb
 - lib/jsapi/meta/openapi/extensions.rb
+- lib/jsapi/meta/openapi/path_item.rb
 - lib/jsapi/meta/openapi/version.rb
 - lib/jsapi/meta/operation.rb
 - lib/jsapi/meta/parameter.rb
@@ -128,6 +129,7 @@ files:
 - lib/jsapi/meta/security_scheme/http/basic.rb
 - lib/jsapi/meta/security_scheme/http/bearer.rb
 - lib/jsapi/meta/security_scheme/http/other.rb
+- lib/jsapi/meta/security_scheme/mutual_tls.rb
 - lib/jsapi/meta/security_scheme/oauth2.rb
 - lib/jsapi/meta/security_scheme/open_id_connect.rb
 - lib/jsapi/meta/server.rb