oas_core 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a77360fd7e6944eb6e1ea64830375d480b04c289e478b63b444c3dc6f12134f9
-  data.tar.gz: 371786121bec6160afd368ed2677999055189aad0cbfa35c26a8c16a572c2505
+  metadata.gz: 25745b92adac67103b83e87c32b5e4ad79fa05addd4c18c36638a726e5c265d7
+  data.tar.gz: 584a858c3cba7df7ebf9a9f219f4580db1237dae3a2f07a3ac0d02f90e6f5b8b
 SHA512:
-  metadata.gz: ddd844dd639cda56c2635b52bd46db947a07428c8ef482f82184ca5693768665f7bb29ebd0d1ca275104a3ff506d5c9f5530d13255f2a5bccbdecd80aa3b7181
-  data.tar.gz: e66985fb30da4835e342a0580947de67a008f01c55d8799e59135d3ad137d42a341198fd96b988a095ab20353a429441f1ef3753c0a87517fb637ac70f227a5c
+  metadata.gz: 1d62dbfe664d07dea17bd9f47b20cacc743e4e44fd6011c5e9e0b56c9dfd22ab8ac795590345014304e69708e734c9f45f55a8faa62a77a17ed94449fde713f9
+  data.tar.gz: 4135466e3a1c2a006ddf29d298676557cb65b7f750870e735eaf8af2da0c55bbb44b8f84769a2cf9bc39983f9a530f39c2fe25e5b618a2434bc02dded874da3c

data/README.md

@@ -6,7 +6,7 @@
 
 # 📃Open API Specification Core
 
-OasCore is a Ruby gem designed to generate Open API Specification (OAS) 3.1 documentation directly from YARD comments in your endpoints. It serves as the core engine for OAS generation, while framework-specific adapters like `OasRails` (for Ruby on Rails) handle the extraction, integration and additional features.
+OasCore is a Ruby gem designed to generate Open API Specification (OAS) 3.2 documentation directly from YARD comments in your endpoints. It serves as the core engine for OAS generation, while framework-specific adapters like `OasRails` (for Ruby on Rails) handle the extraction, integration and additional features.
 
 ## Framework adapters
 

data/lib/oas_core/builders/operation_builder.rb

@@ -35,7 +35,16 @@ module OasCore
       end
 
       def extract_operation_id(oas_route:)
-        "#{oas_route.verb}_#{oas_route.path.gsub('/', '_')}"
+        # Sanitize path to create URL-safe operationId:
+        # - Replace / with _
+        # - Remove braces from path parameters ({id} → id)
+        # - Clean up multiple consecutive underscores
+        sanitized_path = oas_route.path
+                                  .gsub('/', '_')
+                                  .gsub(/[{}]/, '')
+                                  .gsub(/_+/, '_')
+                                  .gsub(/^_|_$/, '')
+        "#{oas_route.verb}_#{sanitized_path}"
       end
 
       def extract_tags(oas_route:)

data/lib/oas_core/configuration.rb

@@ -17,7 +17,7 @@ module OasCore
       @info = args.fetch(:info, Spec::Info.new)
       @servers = args.fetch(:servers, default_servers)
       @tags = []
-      @swagger_version = '3.1.0'
+      @swagger_version = '3.2.0'
       @default_tags_from = :namespace
       @api_path = '/'
       @authenticate_all_routes_by_default = true
@@ -26,7 +26,7 @@ module OasCore
       @set_default_responses = true
       @possible_default_responses = %i[not_found unauthorized forbidden internal_server_error
                                        unprocessable_entity]
-      @http_verbs = %i[get post put patch delete]
+      @http_verbs = %i[get post put patch delete options head trace]
       @response_body_of_default = 'Hash{ status: !Integer, error: String }'
 
       @possible_default_responses.each do |response|

data/lib/oas_core/json_schema_generator.rb

@@ -139,10 +139,10 @@ module OasCore
       case type.to_s.downcase
       when 'string' then { type: 'string' }
       when 'integer' then { type: 'integer' }
-      when 'float' then { type: 'float' }
+      when 'float' then { type: 'number' }
       when 'boolean' then { type: 'boolean' }
       when 'array' then { type: 'array' }
-      when 'hash' then { type: 'hash' }
+      when 'hash' then { type: 'object' }
       when 'nil' then { type: 'null' }
       when 'date' then { type: 'string', format: 'date' }
       when 'datetime' then { type: 'string', format: 'date-time' }

data/lib/oas_core/spec/info.rb

@@ -31,7 +31,7 @@ module OasCore
       def default_description
         "# Welcome to OasCore
 
-OasCore automatically generates interactive documentation for your Rails APIs using the OpenAPI Specification 3.1 (OAS 3.1) and displays it with a nice UI.
+OasCore automatically generates interactive documentation for your Rails APIs using the OpenAPI Specification 3.2 (OAS 3.2) and displays it with a nice UI.
 
 ## Getting Started
 
@@ -52,7 +52,7 @@ To customize and enrich your API documentation:
 
 ## Features
 
-- Automatic OAS 3.1 document generation
+- Automatic OAS 3.2 document generation
 - [RapiDoc](https://github.com/rapi-doc/RapiDoc) integration for interactive exploration
 - Minimal setup required for basic documentation
 - Extensible through configuration and Yard tags

data/lib/oas_core/spec/parameter.rb

@@ -6,7 +6,7 @@ module OasCore
       include Specable
       include Hashable
 
-      STYLE_DEFAULTS = { query: 'form', path: 'simple', header: 'simple', cookie: 'form' }.freeze
+      STYLE_DEFAULTS = { query: 'form', path: 'simple', header: 'simple', cookie: 'form', querystring: 'form' }.freeze
 
       attr_accessor :name, :style, :description, :required, :schema
       attr_reader :in

data/lib/oas_core/spec/path_item.rb

@@ -4,7 +4,7 @@ module OasCore
   module Spec
     class PathItem
       include Specable
-      attr_reader :get, :post, :put, :patch, :delete
+      attr_reader :get, :post, :put, :patch, :delete, :options, :head, :trace, :query
 
       def initialize(specification)
         @specification = specification
@@ -13,6 +13,10 @@ module OasCore
         @put = nil
         @patch = nil
         @delete = nil
+        @options = nil
+        @head = nil
+        @trace = nil
+        @query = nil
       end
 
       def add_operation(http_method, operation)

data/lib/oas_core/spec/server.rb

@@ -4,15 +4,16 @@ module OasCore
   module Spec
     class Server
       include Specable
-      attr_accessor :url, :description
+      attr_accessor :url, :description, :name
 
-      def initialize(url:, description:)
+      def initialize(url:, description:, name: nil)
         @url = url
         @description = description
+        @name = name
       end
 
       def oas_fields
-        %i[url description]
+        %i[url description name]
       end
     end
   end

data/lib/oas_core/spec/specification.rb

@@ -11,7 +11,7 @@ module OasCore
       def initialize
         @components = Components.new(self)
         @info = OasCore.config.info
-        @openapi = '3.1.0'
+        @openapi = '3.2.0'
         @servers = OasCore.config.servers
         @tags = OasCore.config.tags
         @external_docs = {}

data/lib/oas_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OasCore
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/oas_core/yard/oas_core_factory.rb

@@ -52,11 +52,73 @@ module OasCore
         description, schema_keywords = extract_schema_keywords(description)
         schema.merge!(schema_keywords)
 
+        schema[:default] = parse_default_tag(schema) if schema.key?(:default)
+        schema[:enum] = parse_enum_tag(schema) if schema.key?(:enum)
+
         ParameterTag.new(tag_name, name, description.strip, schema, location, required:)
       rescue StandardError => e
         raise TagParsingError, "Failed to parse parameter tag: #{e.message}"
       end
 
+      # Parses the default tag.
+      # @param schema [Hash] The schema containing the default value.
+      # @return [Value] The parsed default value.
+      def parse_default_tag(schema)
+        case schema[:type]
+        when 'integer'
+          parse_integer(schema[:default])
+        when 'boolean'
+          parse_boolean(schema[:default])
+        else
+          schema[:default]
+        end
+      end
+
+      # Parses the enum tag.
+      # @param schema [Hash] The schema containing the enum values.
+      # @return [Array] The parsed enum values.
+      def parse_enum_tag(schema)
+        enum_values = schema[:enum]
+        return enum_values unless enum_values.is_a?(Array)
+
+        case schema[:type]
+        when 'integer'
+          enum_values.map do |value|
+            parse_integer(value)
+          end
+        when 'boolean'
+          enum_values.map do |value|
+            parse_boolean(value)
+          end
+        else
+          enum_values
+        end
+      end
+
+      # Parses an integer value.
+      # @param value [String] The value to parse.
+      # @return [Integer, Object] The parsed integer or the original value if it can't be coerced.
+      def parse_integer(value)
+        Integer(value)
+      rescue ArgumentError, TypeError
+        # Keep original value if it can't be coerced
+        value
+      end
+
+      # Parses a boolean value.
+      # @param value [String] The value to parse.
+      # @return [Boolean, Object] The parsed boolean or the original value if it can't be coerced.
+      def parse_boolean(value)
+        value_str = value.to_s.downcase
+        if value_str == 'true'
+          true
+        elsif value_str == 'false'
+          false
+        else
+          value
+        end
+      end
+
       # Parses a tag that represents a response.
       # @param tag_name [String] The name of the tag.
       # @param text [String] The tag text to parse.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_core
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - a-chacon
@@ -72,7 +72,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.9'
 description: OasCore simplifies API documentation by automatically generating OpenAPI
-  Specification (OAS 3.1) documents from your Ruby application routes. It eliminates
+  Specification (OAS 3.2) documents from your Ruby application routes. It eliminates
   the need for manual documentation, ensuring accuracy and consistency.
 email:
 - andres.ch@protonmail.com