gitlab-grape-openapi 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b3783b6b78454e5f8a76c0f2da60864f1f890272e8d9604cac6c0152becea17
-  data.tar.gz: 21b5cec8a2792e118c480334b358aa62d3fc4d85553fbbe7ace7871a7fc91709
+  metadata.gz: 79aec4f1d4657df18a7ccbcf6b689c9f00f8f0b5c940d508da34b05112aa8432
+  data.tar.gz: 275e4524ae0d61929af41ca0540ff080f49790f0a2cbb1308f4a0e6d6b79f75f
 SHA512:
-  metadata.gz: 36ca996cdcbb0a74ac4853fe174491ffbdb38176952155630b956d9dcef42da63a7e1403693e54b3db27689590e20acdc6989cf0af5d288e96c5e692e5c110c8
-  data.tar.gz: 461ddbe6f58280b0678e394f20f722bb981e0cdb2c0684456597b5deff382e18ed96df69753df729e6e1e1cea73107eeaad9c4cff37a79aa2a92bb5b189948eb
+  metadata.gz: cd0dfaa149fb09c6a61bd2b8c9256d506e6bc62da716faed13e9b0c2f48932efed53b69315c330d1f91f8bf550bb5728fc284865748966b39f15b4a7d7598c67
+  data.tar.gz: c937af8a3e5f1a4f80ae412e7d444f1b11c7d30268b5c64dd9441c3e2b6125db1b325387effa1ec917821211ee12ca7e140dd1f9e659bcab039c86d99c3e3db4

data/lib/gitlab/grape_openapi/converters/entity_converter.rb

@@ -54,9 +54,28 @@ module Gitlab
           Models::Schema.new.tap do |schema|
             schema.type = OBJECT_TYPE
             schema.properties = build_exposures_properties(root_exposures)
+
+            required = required_exposure_keys(root_exposures)
+            schema.required = required if required.any?
           end
         end
 
+        def required_exposure_keys(exposures)
+          exposures.flat_map do |exposure|
+            if inlineable_merge_exposure?(exposure)
+              # Merged entity properties become the parent's, so their
+              # `required` entries do too.
+              build_or_fetch_nested_schema(nested_entity_class(exposure))&.required || []
+            elsif block_exposure?(exposure) && exposure.for_merge
+              required_exposure_keys(exposure.nested_exposures)
+            elsif exposure_documentation(exposure)[:required]
+              [exposure.key.to_s]
+            else
+              []
+            end
+          end.uniq
+        end
+
         def build_exposures_properties(exposures)
           exposures.each_with_object({}) do |exposure, properties|
             if inlineable_merge_exposure?(exposure)
@@ -95,6 +114,9 @@ module Gitlab
           object_schema = { type: OBJECT_TYPE }
           object_schema[:properties] = nested_properties if nested_properties.any?
 
+          nested_required = required_exposure_keys(exposure.nested_exposures)
+          object_schema[:required] = nested_required if nested_required.any?
+
           if documentation[:is_array]
             { type: ARRAY_TYPE, description: documentation[:desc], items: object_schema }.compact
           else
@@ -169,11 +191,23 @@ module Gitlab
             type: TypeResolver.resolve_type(actual_type) || DEFAULT_TYPE,
             description: documentation[:desc],
             format: TypeResolver.resolve_format(documentation[:format], actual_type),
+            enum: enum_values(documentation),
             default: default_value,
             example: documentation[:example]
           }
         end
 
+        # `values:` may also be a Proc or a Range (runtime validation
+        # constructs); only a literal Array translates to a fixed OpenAPI
+        # enum. Mirrors `ParameterConverter#build_enum_schema`. Symbols are
+        # stringified because the response contains strings, not symbols.
+        def enum_values(documentation)
+          values = documentation[:values]
+          return unless values.is_a?(Array) && values.any?
+
+          values.map { |value| value.is_a?(Symbol) ? value.to_s : value }
+        end
+
         def build_type_schema(type, documentation)
           schema = { type: TypeResolver.resolve_type(type) || DEFAULT_TYPE }
 
@@ -229,10 +263,13 @@ module Gitlab
         def build_primitive_items(property, item_type)
           items = { type: item_type }
 
-          # Move format to items if present
-          if property[:format]
-            items[:format] = property[:format]
-            property[:format] = nil
+          # Move format and enum to items if present; they constrain each
+          # element, not the array itself
+          [:format, :enum].each do |key|
+            next unless property[key]
+
+            items[key] = property[key]
+            property[key] = nil
           end
 
           items

data/lib/gitlab/grape_openapi/converters/operation_converter.rb

@@ -238,17 +238,10 @@ module Gitlab
         # Looks something like:
         # [{:attributes=>[:version_prefix],
         #   :options=>/^[\d+.]+/,
-        #   :required=>false,
-        #   :params_scope=>#<Grape::Validations::ParamsScope:0x000000016dc35820
-        #   :opts=>{:allow_blank=>nil, :fail_fast=>false},
+        #   :opts=>{:fail_fast=>false},
         #   :validator_class=>Grape::Validations::Validators::RegexpValidator}]
         def validations_for(attribute)
-          route
-            .app
-            .inheritable_setting
-            .namespace_stackable
-            .new_values[:validations]
-            &.select { |v| v[:attributes].include?(attribute) }
+          GrapeCompat.validations_for(route, attribute)
         end
 
         def extract_request_body

data/lib/gitlab/grape_openapi/grape_compat.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module GrapeOpenapi
+    # Isolates the Grape internals this gem reads so version differences live in
+    # one place.
+    #
+    # Grape < 3.2 stores each declared validation as a Hash; Grape >= 3.2 stores
+    # a frozen validator instance instead (ruby-grape/grape#2657). Both shapes
+    # are normalized to the Hash the converters expect.
+    module GrapeCompat
+      class << self
+        # Declared validations for a single attribute, newest scope only.
+        #
+        # Reads `new_values` rather than `[]` or `route[:saved_validations]` on
+        # purpose: those also include validations inherited from parent scopes,
+        # which would change the generated output.
+        def validations_for(route, attribute)
+          validations = route.app.inheritable_setting.namespace_stackable.new_values[:validations]
+          return unless validations
+
+          validations.filter_map do |validation|
+            normalized = normalize(validation)
+            normalized if normalized && normalized[:attributes].include?(attribute)
+          end
+        end
+
+        private
+
+        def normalize(validation)
+          return validation if validation.is_a?(Hash)
+
+          # Grape 3.2's ContractScopeValidator declares no attributes, so it maps
+          # to no parameter.
+          return unless validation.respond_to?(:attrs)
+
+          {
+            attributes: validation.attrs,
+            validator_class: validation.class,
+            # Grape 3.2 exposes no public reader for the validator options, which
+            # carry regexp patterns and limits. Switch to the reader if one is
+            # added upstream.
+            options: validation.instance_variable_get(:@options),
+            opts: { fail_fast: validation.fail_fast? }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/grape_openapi/models/request_body/parameter_schema.rb

@@ -226,12 +226,7 @@ module Gitlab
           end
 
           def validations_for(attribute)
-            route
-              .app
-              .inheritable_setting
-              .namespace_stackable
-              .new_values[:validations]
-              &.select { |v| v[:attributes].include?(attribute) }
+            GrapeCompat.validations_for(route, attribute)
           end
 
           def apply_allow_blank(schema)

data/lib/gitlab/grape_openapi/models/schema.rb

@@ -5,7 +5,7 @@ module Gitlab
     module Models
       # https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.0.md#schema-object
       class Schema
-        attr_accessor :properties, :type
+        attr_accessor :properties, :required, :type
 
         def initialize
           @properties = {}
@@ -31,6 +31,7 @@ module Gitlab
           {}.tap do |hash|
             add_type(hash)
             add_properties(hash)
+            add_required(hash)
           end
         end
 
@@ -44,6 +45,10 @@ module Gitlab
           hash[:properties] = properties.transform_values(&:to_h)
         end
 
+        def add_required(hash)
+          hash[:required] = required if required && !required.empty?
+        end
+
         def description
           @properties[:description]
         end

data/lib/gitlab/grape_openapi/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module GrapeOpenapi
-    VERSION = "0.2.3"
+    VERSION = "0.3.0"
   end
 end

data/lib/gitlab-grape-openapi.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "gitlab/grape_openapi/version"
+require_relative "gitlab/grape_openapi/grape_compat"
 require_relative "gitlab/grape_openapi/configuration"
 require_relative "gitlab/grape_openapi/generator"
 require_relative "gitlab/grape_openapi/schema_registry"

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-grape-openapi
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - group::api
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-20 00:00:00.000000000 Z
+date: 2026-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.4'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
@@ -148,6 +154,7 @@ files:
 - lib/gitlab/grape_openapi/converters/tag_converter.rb
 - lib/gitlab/grape_openapi/converters/type_resolver.rb
 - lib/gitlab/grape_openapi/generator.rb
+- lib/gitlab/grape_openapi/grape_compat.rb
 - lib/gitlab/grape_openapi/models/info.rb
 - lib/gitlab/grape_openapi/models/operation.rb
 - lib/gitlab/grape_openapi/models/parameter.rb