openapi_parser 2.5.0 → 2.6.0

data/lib/openapi_parser/spec_validator/rules/xml_wrapped_deprecation.rb

@@ -0,0 +1,29 @@
+module OpenAPIParser
+  class SpecValidator
+    module Rules
+      # 3.2 deprecates `wrapped: true` on the XML Object in favor of
+      # `nodeType: element`. The field is still allowed but discouraged,
+      # so we report it as a violation on 3.2 documents.
+      class XmlWrappedDeprecation < Rule
+        def check(root)
+          return [] unless version_at_least?('3.2')
+
+          violations = []
+          each_schema(root) do |schema|
+            raw = schema.raw_schema
+            next unless raw.is_a?(Hash)
+
+            xml = raw['xml']
+            next unless xml.is_a?(Hash) && xml['wrapped'] == true
+
+            violations << violation(
+              path: schema.object_reference,
+              message: '`wrapped` on an XML Object is deprecated in 3.2; use `nodeType: element`',
+            )
+          end
+          violations
+        end
+      end
+    end
+  end
+end

data/lib/openapi_parser/spec_validator.rb

@@ -17,7 +17,24 @@ require_relative 'spec_validator/rules/const_in_30'
 require_relative 'spec_validator/rules/dynamic_ref_in_30'
 require_relative 'spec_validator/rules/dynamic_anchor_in_30'
 require_relative 'spec_validator/rules/content_schema_in_30'
+require_relative 'spec_validator/rules/defs_in_30'
+require_relative 'spec_validator/rules/allow_empty_value_deprecation'
+require_relative 'spec_validator/rules/xml_node_type_before_32'
+require_relative 'spec_validator/rules/xml_attribute_deprecation'
+require_relative 'spec_validator/rules/xml_wrapped_deprecation'
+require_relative 'spec_validator/rules/media_types_before_32'
+require_relative 'spec_validator/rules/default_mapping_before_32'
+require_relative 'spec_validator/rules/cookie_style_before_32'
+require_relative 'spec_validator/rules/server_name_before_32'
 require_relative 'spec_validator/rules/self_before_32'
+require_relative 'spec_validator/rules/query_method_before_32'
+require_relative 'spec_validator/rules/additional_operations_before_32'
+require_relative 'spec_validator/rules/response_summary_before_32'
+require_relative 'spec_validator/rules/tag_fields_before_32'
+require_relative 'spec_validator/rules/example_value_fields_before_32'
+require_relative 'spec_validator/rules/security_scheme_fields_before_32'
+require_relative 'spec_validator/rules/streaming_fields_before_32'
+require_relative 'spec_validator/rules/querystring_before_32'
 
 module OpenAPIParser
   class SpecViolationError < OpenAPIError
@@ -82,7 +99,24 @@ module OpenAPIParser
           Rules::DynamicRefIn30,
           Rules::DynamicAnchorIn30,
           Rules::ContentSchemaIn30,
+          Rules::DefsIn30,
+          Rules::AllowEmptyValueDeprecation,
+          Rules::XmlNodeTypeBefore32,
+          Rules::XmlAttributeDeprecation,
+          Rules::XmlWrappedDeprecation,
+          Rules::MediaTypesBefore32,
+          Rules::DefaultMappingBefore32,
+          Rules::CookieStyleBefore32,
+          Rules::ServerNameBefore32,
           Rules::SelfBefore32,
+          Rules::QueryMethodBefore32,
+          Rules::AdditionalOperationsBefore32,
+          Rules::ResponseSummaryBefore32,
+          Rules::TagFieldsBefore32,
+          Rules::ExampleValueFieldsBefore32,
+          Rules::SecuritySchemeFieldsBefore32,
+          Rules::StreamingFieldsBefore32,
+          Rules::QuerystringBefore32,
         ]
       end
   end

data/lib/openapi_parser/version.rb

@@ -1,3 +1,3 @@
 module OpenAPIParser
-  VERSION = '2.5.0'.freeze
+  VERSION = '2.6.0'.freeze
 end

data/lib/openapi_parser.rb

@@ -40,8 +40,9 @@ module OpenAPIParser
     end
 
     # Load schema located by the passed uri. Uri must be absolute.
+    # @param [OpenAPIParser::Schemas::OpenAPI, nil] referrer the document whose $ref loads this one
     # @return [OpenAPIParser::Schemas::OpenAPI]
-    def load_uri(uri, config:, schema_registry:)
+    def load_uri(uri, config:, schema_registry:, referrer: nil)
       # Open-uri doesn't open file scheme uri, so we try to open file path directly
       # File scheme uri which points to a remote file is not supported.
       uri_path = uri.path
@@ -54,7 +55,7 @@ module OpenAPIParser
       end
 
       extension = Pathname.new(uri_path).extname
-      load_hash(parse_file(content, extension), config: config, uri: uri, schema_registry: schema_registry)
+      load_hash(parse_file(content, extension), config: config, uri: uri, schema_registry: schema_registry, referrer: referrer)
     end
 
     private
@@ -90,8 +91,8 @@ module OpenAPIParser
         JSON.parse(content)
       end
 
-      def load_hash(hash, config:, uri:, schema_registry:)
-        root = Schemas::OpenAPI.new(hash, config, uri: uri, schema_registry: schema_registry)
+      def load_hash(hash, config:, uri:, schema_registry:, referrer: nil)
+        root = Schemas::OpenAPI.new(hash, config, uri: uri, schema_registry: schema_registry, referrer: referrer)
 
         OpenAPIParser::ReferenceExpander.expand(root, config.strict_reference_validation) if config.expand_reference
 

data/sig/openapi_parser/config.rbs

@@ -9,6 +9,7 @@ module OpenAPIParser
 
     def initialize: (untyped config) -> untyped
     def allow_empty_date_and_datetime: -> bool
+    def allow_3_2_features: -> bool
     def date_coerce_class: -> (singleton(Object) | nil)
     def datetime_coerce_class: -> (singleton(Object) | nil)
     def coerce_value: -> bool

data/sig/openapi_parser/schema_validator.rbs

@@ -2,6 +2,7 @@
 module OpenAPIParser
   class SchemaValidator
     include Validatable
+    VALUE_TYPES: Array[String]
     @value: Hash[bot, bot]
     @schema: OpenAPIParser::Schemas::Schema
     @coerce_value: bool | nil

data/sig/openapi_parser/schema_validators/base.rbs

@@ -10,9 +10,11 @@ module OpenAPIParser
       def coerce_and_validate: (Object _value, OpenAPIParser::Schemas::Schema _schema, **untyped) -> [untyped, (ValidateError | NotExistDiscriminatorMappedSchema | nil)]
       def validate_discriminator_schema: (
         OpenAPIParser::Schemas::Discriminator discriminator, 
-        Hash[String, bot] value,
+        Hash[String, untyped] value,
+        ?candidate_schemas: Array[OpenAPIParser::Schemas::Schema] | nil,
         ?parent_discriminator_schemas: Array[OpenAPIParser::Schemas::Schema]
-      ) -> [Object | nil, OpenAPIParser::OpenAPIError]
+      ) -> [Object | nil, OpenAPIParser::OpenAPIError | nil]
+      private def default_mapping_target: (OpenAPIParser::Schemas::Discriminator discriminator) -> (String | nil)
     end
   end
 end

data/sig/openapi_parser/spec_validator.rbs

@@ -35,6 +35,9 @@ module OpenAPIParser
       def version_at_least?: (String boundary) -> bool
       private def violation: (path: String, message: String) -> SpecViolation
       private def each_schema: (untyped root) ?{ (untyped) -> void } -> untyped
+      private def each_node: (untyped root, *Class klasses) { (untyped) -> void } -> void
+      private def each_security_scheme: (untyped root) { (String, Hash[untyped, untyped]) -> void } -> void
+      private def escape_reference: (untyped key) -> String
       private def walk: (untyped node, Hash[Integer, bool] visited) { (untyped) -> void } -> void
     end
 
@@ -107,9 +110,83 @@ module OpenAPIParser
         def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
       end
 
+      class DefsIn30 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class AllowEmptyValueDeprecation < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class XmlNodeTypeBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class XmlAttributeDeprecation < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class XmlWrappedDeprecation < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class MediaTypesBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class DefaultMappingBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class CookieStyleBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class ServerNameBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
       class SelfBefore32 < Rule
         def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
       end
+
+      class QueryMethodBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class AdditionalOperationsBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class ResponseSummaryBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class TagFieldsBefore32 < Rule
+        NEW_FIELDS: Array[String]
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class ExampleValueFieldsBefore32 < Rule
+        NEW_FIELDS: Array[String]
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class SecuritySchemeFieldsBefore32 < Rule
+        NEW_FIELDS: Array[String]
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class StreamingFieldsBefore32 < Rule
+        NEW_FIELDS: Array[String]
+        NEW_ENCODING_FIELDS: Array[String]
+        private def encoding_violations: (untyped node, untyped encodings) -> Array[SpecValidator::SpecViolation]
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
+
+      class QuerystringBefore32 < Rule
+        def check: (OpenAPIParser::Schemas::OpenAPI root) -> Array[SpecValidator::SpecViolation]
+      end
     end
   end
 

data/sig/openapi_parser.rbs

@@ -2,20 +2,22 @@ module OpenAPIParser
   def self.parse: (Hash[bot, bot] schema, ?Hash[bot, bot] config) -> OpenAPIParser::Schemas::OpenAPI
   def self.parse_with_filepath: (Hash[bot, bot] schema, String filepath, ?Hash[bot, bot] config) -> OpenAPIParser::Schemas::OpenAPI
   def self.load: (String filepath, ?Hash[bot, bot] config) -> OpenAPIParser::Schemas::OpenAPI
-  def self.load_uri: (OpenAPIParser::readable_uri uri, config: untyped, schema_registry: Hash[bot, bot]) -> OpenAPIParser::Schemas::OpenAPI
+  def self.load_uri: (OpenAPIParser::readable_uri uri, config: untyped, schema_registry: Hash[bot, bot], ?referrer: OpenAPIParser::Schemas::OpenAPI?) -> OpenAPIParser::Schemas::OpenAPI
   def self.file_uri: (String filepath) -> URI::Generic
   def self.parse_file: (String? content, String ext) -> Hash[bot, bot]
   def self.parse_yaml: (String? content) -> Hash[bot, bot]
   def self.parse_json: (String? content) -> Hash[bot, bot]
-  def self.load_hash: (Hash[bot, bot] hash, config: untyped, uri: OpenAPIParser::readable_uri?, schema_registry: Hash[bot, bot]) -> OpenAPIParser::Schemas::OpenAPI
+  def self.load_hash: (Hash[bot, bot] hash, config: untyped, uri: OpenAPIParser::readable_uri?, schema_registry: Hash[bot, bot], ?referrer: OpenAPIParser::Schemas::OpenAPI?) -> OpenAPIParser::Schemas::OpenAPI
 end
 
 module OpenAPIParser
   module Schemas
     class OpenAPI
-      def initialize: (Hash[bot, bot] hash, untyped config, uri: OpenAPIParser::readable_uri?, schema_registry: Hash[bot, bot]) -> OpenAPIParser::Schemas::OpenAPI
+      def initialize: (Hash[bot, bot] hash, untyped config, uri: OpenAPIParser::readable_uri?, schema_registry: Hash[bot, bot], ?referrer: OpenAPIParser::Schemas::OpenAPI?) -> OpenAPIParser::Schemas::OpenAPI
       def openapi: () -> String?
       def openapi_version: () -> Gem::Version?
+      def use_3_1_features?: () -> bool
+      def use_3_2_features?: () -> bool
     end
   end
 end

data/sig/wip_types.rbs

@@ -48,6 +48,11 @@ end
 
 class OpenAPIParser::Schemas::OpenAPI < OpenAPIParser::Schemas::Base 
   attr_reader paths: untyped
+  attr_reader components: OpenAPIParser::Schemas::Components | nil
+end
+
+class OpenAPIParser::Schemas::Components < OpenAPIParser::Schemas::Base
+  attr_reader schemas: Hash[String, OpenAPIParser::Schemas::Schema] | nil
 end
 
 module OpenAPIParser::Expandable
@@ -61,4 +66,5 @@ end
 class OpenAPIParser::Schemas::Discriminator < OpenAPIParser::Schemas::Base
   attr_reader property_name: (String | nil)
   attr_reader mapping: Hash[String, String] 
+  attr_reader default_mapping: (String | nil)
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: openapi_parser
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - ota42y
@@ -182,6 +182,7 @@ files:
 - lib/openapi_parser/schema_validator/float_validator.rb
 - lib/openapi_parser/schema_validator/integer_validator.rb
 - lib/openapi_parser/schema_validator/minimum_maximum.rb
+- lib/openapi_parser/schema_validator/multiple_of.rb
 - lib/openapi_parser/schema_validator/nil_validator.rb
 - lib/openapi_parser/schema_validator/object_validator.rb
 - lib/openapi_parser/schema_validator/one_of_validator.rb
@@ -210,24 +211,41 @@ files:
 - lib/openapi_parser/schemas/schema.rb
 - lib/openapi_parser/spec_validator.rb
 - lib/openapi_parser/spec_validator/rule.rb
+- lib/openapi_parser/spec_validator/rules/additional_operations_before_32.rb
+- lib/openapi_parser/spec_validator/rules/allow_empty_value_deprecation.rb
 - lib/openapi_parser/spec_validator/rules/boolean_schema_in_30.rb
 - lib/openapi_parser/spec_validator/rules/const_in_30.rb
 - lib/openapi_parser/spec_validator/rules/content_encoding_in_30.rb
 - lib/openapi_parser/spec_validator/rules/content_media_type_in_30.rb
 - lib/openapi_parser/spec_validator/rules/content_schema_in_30.rb
+- lib/openapi_parser/spec_validator/rules/cookie_style_before_32.rb
+- lib/openapi_parser/spec_validator/rules/default_mapping_before_32.rb
+- lib/openapi_parser/spec_validator/rules/defs_in_30.rb
 - lib/openapi_parser/spec_validator/rules/dynamic_anchor_in_30.rb
 - lib/openapi_parser/spec_validator/rules/dynamic_ref_in_30.rb
 - lib/openapi_parser/spec_validator/rules/example_singular_deprecation.rb
+- lib/openapi_parser/spec_validator/rules/example_value_fields_before_32.rb
 - lib/openapi_parser/spec_validator/rules/exclusive_maximum.rb
 - lib/openapi_parser/spec_validator/rules/exclusive_minimum.rb
 - lib/openapi_parser/spec_validator/rules/json_schema_dialect_in_30.rb
+- lib/openapi_parser/spec_validator/rules/media_types_before_32.rb
 - lib/openapi_parser/spec_validator/rules/nullable_deprecation.rb
 - lib/openapi_parser/spec_validator/rules/path_items_in_30.rb
 - lib/openapi_parser/spec_validator/rules/prefix_items_in_30.rb
+- lib/openapi_parser/spec_validator/rules/query_method_before_32.rb
+- lib/openapi_parser/spec_validator/rules/querystring_before_32.rb
+- lib/openapi_parser/spec_validator/rules/response_summary_before_32.rb
+- lib/openapi_parser/spec_validator/rules/security_scheme_fields_before_32.rb
 - lib/openapi_parser/spec_validator/rules/self_before_32.rb
+- lib/openapi_parser/spec_validator/rules/server_name_before_32.rb
+- lib/openapi_parser/spec_validator/rules/streaming_fields_before_32.rb
+- lib/openapi_parser/spec_validator/rules/tag_fields_before_32.rb
 - lib/openapi_parser/spec_validator/rules/type_array_in_30.rb
 - lib/openapi_parser/spec_validator/rules/type_null_in_30.rb
 - lib/openapi_parser/spec_validator/rules/webhooks_in_30.rb
+- lib/openapi_parser/spec_validator/rules/xml_attribute_deprecation.rb
+- lib/openapi_parser/spec_validator/rules/xml_node_type_before_32.rb
+- lib/openapi_parser/spec_validator/rules/xml_wrapped_deprecation.rb
 - lib/openapi_parser/spec_validator/spec_violation.rb
 - lib/openapi_parser/version.rb
 - openapi_parser.gemspec