fix(open_api): required should be nil or true

the openapi spec says required should only be present if true
spider-gazelle · Feb 13, 2025 · 2661952 · 2661952
1 parent 8174d5b
commit 2661952
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/shard.yml b/shard.yml
@@ -1,5 +1,5 @@
 name: action-controller
-version: 7.5.2
+version: 7.5.3
 crystal: ">= 1.9.0"
 
 dependencies:

diff --git a/src/action-controller/open_api.cr b/src/action-controller/open_api.cr
@@ -9,7 +9,7 @@ module ActionController::OpenAPI
   alias Params = NamedTuple(
     name: String,
     in: Symbol,
-    required: Bool,
+    required: Bool?,
     schema: String,
     docs: String?,
     example: String?,
@@ -300,7 +300,7 @@ module ActionController::OpenAPI
                 {
                   name: {{ param_name }},
                   in: {{ param[:in] }},
-                  required: {{ param[:required] }},
+                  required: ({{ param[:required] ? true : nil }}).as(Bool?),
                   schema: ::JSON::Schema.introspect({{ param[:schema] }}, openapi: true).to_json,
                   docs: {{ param[:docs] }}.as(String?),
                   example: {{ param[:example] }}.as(String?),
@@ -350,7 +350,7 @@ module ActionController::OpenAPI
               {
                 name: {{ param[:header] || param_name }},
                 in: {{ param[:in] }},
-                required: {{ param[:required] }},
+                required: ({{ param[:required] ? true : nil }}).as(Bool?),
                 schema: ::JSON::Schema.introspect({{ param[:schema] }}, openapi: true).to_json,
                 docs: {{ param[:docs] }}.as(String?),
                 example: {{ param[:example] }}.as(String?),
@@ -473,7 +473,7 @@ module ActionController::OpenAPI
         param = Parameter.new
         param.name = raw_param[:name]
         param.in = raw_param[:in].to_s
-        param.required = raw_param[:required]
+        param.required = raw_param[:required] ? true : nil
         param.schema = JSON.parse(raw_param[:schema])
         param.description = raw_param[:docs]
         param.example = raw_param[:example]
@@ -503,7 +503,7 @@ module ActionController::OpenAPI
           param = Parameter.new
           param.name = param_name
           param.in = raw_param[:in].to_s
-          param.required = raw_param[:required]
+          param.required = raw_param[:required] ? true : nil
           param.schema = JSON.parse(raw_param[:schema])
           param.description = raw_param[:docs]
           param.example = raw_param[:example]