grape-oas 1.6.0 → 1.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d771c74ede3e601d65419900f26aa0ad36d785a649e09184a9e6755f4749fe7
-  data.tar.gz: 55bef62d1b83ccbd6f57cc469ec6ff81aea4b00c38fef892542fa5bc2f0588b0
+  metadata.gz: 227e4af89b7cb81a143484c1fd2fcb151952990c4f2870806f4416d32f88c987
+  data.tar.gz: 314d241a0e48262a34c259ec0dd25d1b48c21139eb423b93a715fcd21dfd5c77
 SHA512:
-  metadata.gz: 9d3f8cc1eeee662d60fdd0574970ed350416dcc9770df2536b7d7d7f017292bcc4338f47cb203cd2d486189d32d614b56d12c74efa83f4c52eabfb69df171b0d
-  data.tar.gz: 86d67570e32b7aafa0290963801c2b0f673fce6d1dde815b93cc2fd5ee8794c898541987382b7910b217e62b58807fdd5f9a6e940d427f82371a23b9ecbfaf84
+  metadata.gz: ce885918700d0ef1122d03129722237b64e8d4e61c30be842920060425176ee9466bc60254c159c776ca92b0f105dc78dfec352ce8f291d4a92cd2465d4f5c2a
+  data.tar.gz: a61d84e0d561663861df04dd63eb98f3ba6a2b50f228aa9193c7552e6dc6bcda12e1da6a742ba2892b625d47e2a04dd7e1efdaec3c5ba26138bed3fd4271b2ff

data/CHANGELOG.md

@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [1.6.1] - 2026-11-06
+
+### Changed
+
+- [#175](https://github.com/numbata/grape-oas/pull/175): Apply entity-level `example` documentation to the generated schema, matching grape-swagger - [@numbata](https://github.com/numbata).
+- [#176](https://github.com/numbata/grape-oas/pull/176): Keep the danger PR check running in CI by pinning `git` below 6 - [@numbata](https://github.com/numbata).
+- [#180](https://github.com/numbata/grape-oas/pull/180): Automate releases with verified packaging, gem publication and a draft GitHub release - [@numbata](https://github.com/numbata).
+
+### Fixed
+
+- [#166](https://github.com/numbata/grape-oas/pull/166): Serialize Symbol enum values as strings so `type: Symbol` parameters with `values:` keep their `enum` in OAS 3.0/3.1 - [@numbata](https://github.com/numbata).
+- [#173](https://github.com/numbata/grape-oas/pull/173): Omit lambda/proc parameter defaults, in `default:` and `documentation: { default: }`, from the generated spec instead of emitting `Proc#inspect`; a static `documentation: { default: }` still documents a callable `default:` - [@olivier-thatch](https://github.com/olivier-thatch).
+- [#178](https://github.com/numbata/grape-oas/pull/178): Stop entity exposures named like root-level documentation keys (`example`, `additional_properties`, `description`, `nullable`, ...) from leaking into the entity schema - [@numbata](https://github.com/numbata).
+
 ## [1.6.0] - 2026-09-21
 
 ### Added

data/lib/grape_oas/api_model_builders/request_params_support/schema_enhancer.rb

@@ -43,13 +43,21 @@ module GrapeOAS
           def apply_default(schema, spec, doc)
             return unless schema.respond_to?(:default=)
 
-            if spec.key?(:default)
+            # Unlike `values:`, defaults are not evaluated: Grape runs a Proc default per
+            # request, so there is no static value to document. Use
+            # `documentation: { default: }` instead.
+            if spec.key?(:default) && static_default?(spec[:default])
               schema.default = spec[:default]
-            elsif doc.key?(:default)
+            elsif doc.key?(:default) && static_default?(doc[:default])
               schema.default = doc[:default]
             end
           end
 
+          # Any callable is skipped, not only Proc, because the exporters cannot serialize it.
+          def static_default?(value)
+            !value.respond_to?(:call)
+          end
+
           def apply_format_and_example(schema, doc)
             schema.format = doc[:format] if doc[:format] && schema.respond_to?(:format=)
             schema.examples = doc[:example] if doc.key?(:example) && schema.respond_to?(:examples=)

data/lib/grape_oas/exporter/concerns/enum_normalizer.rb

@@ -16,7 +16,7 @@ module GrapeOAS
             normalized_value = case base_type
                                when Constants::SchemaTypes::INTEGER then value.to_i if value.respond_to?(:to_i)
                                when Constants::SchemaTypes::NUMBER then value.to_f if value.respond_to?(:to_f)
-                               else value
+                               else value.is_a?(Symbol) ? value.to_s : value
                                end
             values << normalized_value unless normalized_value.nil?
           end

data/lib/grape_oas/introspectors/entity_introspector.rb

@@ -118,9 +118,13 @@ module GrapeOAS
         schema.extensions = root_ext if root_ext
       end
 
+      # Grape::Entity.documentation is a per-exposure aggregate, not root-level
+      # documentation; only an entity's own override counts as the latter.
       def entity_doc
-        doc = @entity_class.respond_to?(:documentation) ? (@entity_class.documentation || {}) : {}
-        DocKeyNormalizer.normalize(doc)
+        return {} unless @entity_class.respond_to?(:documentation)
+        return {} if @entity_class.method(:documentation).owner == Grape::Entity.singleton_class
+
+        DocKeyNormalizer.normalize(@entity_class.documentation || {})
       rescue NoMethodError
         {}
       end

data/lib/grape_oas/introspectors/entity_introspector_support/property_extractor.rb

@@ -35,6 +35,7 @@ module GrapeOAS
           def apply_entity_level_properties(schema, doc)
             schema.additional_properties = doc[:additional_properties] if doc.key?(:additional_properties)
             schema.unevaluated_properties = doc[:unevaluated_properties] if doc.key?(:unevaluated_properties)
+            schema.examples = doc[:example] if doc.key?(:example)
 
             defs = doc[:defs] || doc[:$defs]
             schema.defs = defs if defs.is_a?(Hash)

data/lib/grape_oas/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeOAS
-  VERSION = "1.6.0"
+  VERSION = "1.6.1"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: grape-oas
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.6.1
 platform: ruby
 authors:
 - Andrei Subbota
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -151,7 +150,6 @@ metadata:
   documentation_uri: https://github.com/numbata/grape-oas#readme
   bug_tracker_uri: https://github.com/numbata/grape-oas/issues
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -166,8 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: OpenAPI (Swagger) v2 and v3 documentation for Grape APIs
 test_files: []