oas_core 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12fdf235fa83442a3868ac09e2aa1185268aad637a799df7a184ac38c396dfdc
-  data.tar.gz: 4546918641b90a1808edff30c8595f8b102ddc5c616bb13b8768a6756366f98a
+  metadata.gz: a77360fd7e6944eb6e1ea64830375d480b04c289e478b63b444c3dc6f12134f9
+  data.tar.gz: 371786121bec6160afd368ed2677999055189aad0cbfa35c26a8c16a572c2505
 SHA512:
-  metadata.gz: 9995f945c5e3688c1f8d18729bbddbcc3febe1a7322739daf92e90aaf161f69d039b64327832de832ed477ecd8ec55b2433c3117b1359cf954de2daa3e8f2877
-  data.tar.gz: 30419c1faa9f66271bbcc2261c6ca5fa64f4f1b3203503a8fcfa32a9a31ac39b7326e0455c0090f7e8ee35fe5be3bc2a0dcc9884bfa87250c6808c858c411ad3
+  metadata.gz: ddd844dd639cda56c2635b52bd46db947a07428c8ef482f82184ca5693768665f7bb29ebd0d1ca275104a3ff506d5c9f5530d13255f2a5bccbdecd80aa3b7181
+  data.tar.gz: e66985fb30da4835e342a0580947de67a008f01c55d8799e59135d3ad137d42a341198fd96b988a095ab20353a429441f1ef3753c0a87517fb637ac70f227a5c

data/lib/oas_core/version.rb

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

data/lib/oas_core/yard/oas_core_factory.rb

@@ -49,6 +49,8 @@ module OasCore
         raw_type, required = text_and_required(second)
         schema = raw_type_to_content(raw_type)
         name = "#{name}[]" if location == 'query' && schema[:type] == 'array'
+        description, schema_keywords = extract_schema_keywords(description)
+        schema.merge!(schema_keywords)
 
         ParameterTag.new(tag_name, name, description.strip, schema, location, required:)
       rescue StandardError => e
@@ -201,6 +203,37 @@ module OasCore
           [text.strip, nil]
         end
       end
+
+      # Only allows keywords defined in the OpenAPI 3.0 specification for parameter schemas.
+      # @param text [String] The text to parse.
+      # @return [Array] An array containing the cleaned description and a hash of extracted keywords.
+      def extract_schema_keywords(text)
+        allowed_keywords = %i[
+          default minimum maximum enum format pattern multipleOf
+          exclusiveMinimum exclusiveMax minLength maxLength nullable
+        ].freeze
+
+        keywords = {}
+        cleaned_text = text.dup
+
+        text.scan(/(\w+):\s*\(([^)]+)\)/) do |keyword, value|
+          keyword_sym = keyword.to_sym
+          if allowed_keywords.include?(keyword_sym)
+            parsed_value = case keyword_sym
+                           when :nullable, :exclusiveMinimum, :exclusiveMaximum
+                             value.strip.downcase == 'true'
+                           when :enum
+                             value.strip.split(/\s*,\s*/)
+                           else
+                             value.strip
+                           end
+            keywords[keyword_sym] = parsed_value
+            cleaned_text.sub!(/#{keyword}:\s*\([^)]+\)/, '')
+          end
+        end
+
+        [cleaned_text.strip, keywords]
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oas_core
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - a-chacon