jsapi 1.2 → 1.4

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

@@ -8,6 +8,22 @@ module Jsapi
         # :attr: description
         # The description of the security scheme.
         attribute :description, String
+
+        ##
+        # :attr: deprecated
+        # Specifies whether or not the security scheme is deprecated.
+        # Applies to \OpenAPI 3.2 and higher.
+        attribute :deprecated, values: [true, false]
+
+        private
+
+        def base_openapi_fields(type, version)
+          {
+            type: type,
+            description: description,
+            deprecated: (deprecated?.presence if version >= OpenAPI::V3_2)
+          }
+        end
       end
     end
   end

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

@@ -13,17 +13,10 @@ module Jsapi
             version = OpenAPI::Version.from(version)
 
             with_openapi_extensions(
-              if version.major == 2
-                {
-                  type: 'basic',
-                  description: description
-                }
+              if version < OpenAPI::V3_0
+                base_openapi_fields('basic', version)
               else
-                {
-                  type: 'http',
-                  scheme: 'basic',
-                  description: description
-                }
+                base_openapi_fields('http', version).merge(scheme: 'basic')
               end
             )
           end

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

@@ -7,7 +7,7 @@ module Jsapi
         # Specifies a security scheme based on bearer authentication.
         #
         # Note that Bearer authentication was introduced with \OpenAPI 3.0. Thus, a security
-        # scheme of this class is skipped when generating an \OpenAPI 2.0 document.
+        # scheme of this class is omitted when generating an \OpenAPI 2.0 document.
         class Bearer < Base
           include OpenAPI::Extensions
 
@@ -16,17 +16,17 @@ module Jsapi
           # The format of the bearer token.
           attribute :bearer_format, String
 
-          # Returns a hash representing the \OpenAPI security scheme object, or
-          # +nil+ if <code>version.major</code> is 2.
+          # Returns a hash representing the \OpenAPI security scheme object, or +nil+
+          # 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: 'http',
-              scheme: 'bearer',
-              bearerFormat: bearer_format,
-              description: description
+              base_openapi_fields('http', version).merge(
+                scheme: 'bearer',
+                bearerFormat: bearer_format
+              )
             )
           end
         end

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

@@ -18,15 +18,13 @@ module Jsapi
           attribute :scheme, 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: 'http',
-              scheme: scheme,
-              description: description
+              base_openapi_fields('http', version).merge(scheme: scheme)
             )
           end
         end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Jsapi
+  module Meta
+    module SecurityScheme
+      # Specifies a security scheme based on MutualTLS.
+      class MutualTLS < Base
+        include OpenAPI::Extensions
+
+        # Returns a hash representing the \OpenAPI security scheme object, or +nil+
+        # if <code>version</code> is less than \OpenAPI 3.1.
+        def to_openapi(version, *)
+          version = OpenAPI::Version.from(version)
+          return if version < OpenAPI::V3_1
+
+          with_openapi_extensions(
+            base_openapi_fields('mutualTLS', version)
+          )
+        end
+      end
+    end
+  end
+end

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

@@ -9,34 +9,50 @@ module Jsapi
 
         ##
         # :attr: oauth_flows
-        # The hash containing the OAuth flows. Possible keys are:
+        # Maps one or more of the following keys to OAuthFlow objects.
         #
         # - <code>"authorization_code"</code>
         # - <code>"client_credentials"</code>
+        # - <code>"device_authorization"</code>
         # - <code>"implicit"</code>
         # - <code>"password"</code>
         #
-        # Values are OAuthFlow objects.
+        # Note that <code>"device_authorization"</code> was introduced with \OpenAPI 3.2.
+        # This entry is omitted when generating an \OpenAPI document with a lower version.
         attribute :oauth_flows, { String => OAuthFlow },
-                  keys: %w[authorization_code client_credentials implicit password]
+                  keys: %w[authorization_code
+                           client_credentials
+                           device_authorization
+                           implicit
+                           password]
+        ##
+        # :attr: oauth2_metadata_url
+        # The URL of the OAuth2 authorization server metadata.
+        # Applies to \OpenAPI 3.2 and higher.
+        attribute :oauth2_metadata_url, String
 
         # Returns a hash representing the \OpenAPI security scheme object.
         def to_openapi(version, *)
           version = OpenAPI::Version.from(version)
 
-          with_openapi_extensions(type: 'oauth2', description: description).tap do |h|
-            if oauth_flows.any?
-              if version.major == 2
-                key, oauth_flow = oauth_flows.first
-                h[:flow] = key.to_s
-                h.merge!(oauth_flow.to_openapi(version))
-              else
-                h[:flows] = oauth_flows.to_h do |key, value|
+          with_openapi_extensions(
+            base_openapi_fields('oauth2', version).tap do |fields|
+              flows = oauth_flows
+              flows = flows.except('device_authorization') unless version >= OpenAPI::V3_2
+
+              if version >= OpenAPI::V3_0
+                fields[:flows] = flows.to_h do |key, value|
                   [key.to_s.camelize(:lower).to_sym, value.to_openapi(version)]
-                end
+                end if flows.any?
+
+                fields[:oauth2MetadataUrl] = oauth2_metadata_url if version >= OpenAPI::V3_2
+              elsif flows.one?
+                key, flow = flows.first
+                fields[:flow] = key.to_s
+                fields.merge!(flow.to_openapi(version))
               end
             end
-          end
+          )
         end
       end
     end

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/meta.rb

@@ -24,6 +24,8 @@ require_relative 'meta/property'
 require_relative 'meta/schema'
 require_relative 'meta/request_body'
 require_relative 'meta/parameter'
+require_relative 'meta/pathname'
+require_relative 'meta/path'
 require_relative 'meta/response'
 require_relative 'meta/operation'
 require_relative 'meta/rescue_handler'

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.2'
+    VERSION = '1.4'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsapi
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.4'
 platform: ruby
 authors:
 - Denis Göller
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-30 00:00:00.000000000 Z
+date: 2025-11-15 00:00:00.000000000 Z
 dependencies: []
 description:
 email: denis@dmgoeller.de
@@ -34,6 +34,7 @@ files:
 - lib/jsapi/dsl/examples.rb
 - lib/jsapi/dsl/operation.rb
 - lib/jsapi/dsl/parameter.rb
+- lib/jsapi/dsl/path.rb
 - lib/jsapi/dsl/request_body.rb
 - lib/jsapi/dsl/response.rb
 - lib/jsapi/dsl/schema.rb
@@ -80,11 +81,14 @@ 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
 - lib/jsapi/meta/parameter/base.rb
 - lib/jsapi/meta/parameter/reference.rb
+- lib/jsapi/meta/path.rb
+- lib/jsapi/meta/pathname.rb
 - lib/jsapi/meta/property.rb
 - lib/jsapi/meta/reference_error.rb
 - lib/jsapi/meta/request_body.rb
@@ -128,6 +132,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