Mark query params and request body attributes as required (#20)

Where possible we now mark the following as required:
- query params
- request body attributes
- args defined in argument sets

closes: #3

Author: paulsturgess

examples/core_api/argument_sets/time_lookup_argument_set.rb

@@ -4,7 +4,7 @@ module CoreAPI
   module ArgumentSets
     class TimeLookupArgumentSet < Apia::LookupArgumentSet
 
-      argument :unix, type: :string
+      argument :unix, type: :string, required: true
       argument :string, type: :string
 
       potential_error "InvalidTime" do

examples/core_api/controllers/time_controller.rb

@@ -18,7 +18,7 @@ class TimeController < Apia::Controller
       endpoint :format do
         description "Format the given time"
         argument :time, type: ArgumentSets::TimeLookupArgumentSet, required: true
-        argument :timezone, type: Objects::TimeZone
+        argument :timezone, type: Objects::TimeZone, required: true
         field :formatted_time, type: :string, null: true
         action do
           time = request.arguments[:time]

examples/core_api/endpoints/test_endpoint.rb

@@ -8,7 +8,7 @@ class TestEndpoint < Apia::Endpoint
 
       description "Returns the current time"
       argument :object, type: ArgumentSets::ObjectLookup, required: true
-      argument :scalar, type: :string
+      argument :scalar, type: :string, required: true
       field :time, type: Objects::Time, include: "unix,day_of_week,year[as_string]", null: true do
         condition do |o|
           o[:time].year.to_s == "2023"

examples/core_api/endpoints/time_now_endpoint.rb

@@ -8,7 +8,7 @@ class TimeNowEndpoint < Apia::Endpoint
 
       description "Returns the current time"
       argument :timezone, type: Objects::TimeZone
-      argument :time_zones, [Objects::TimeZone]
+      argument :time_zones, [Objects::TimeZone], required: true
       argument :filters, [:string]
       field :time, type: Objects::Time
       field :time_zones, type: [Objects::TimeZone]

lib/apia/open_api/objects/parameters.rb

@@ -61,13 +61,15 @@ def add_to_spec
                 items: items
               }
             }
+            param[:required] = true if @argument.required?
             add_to_parameters(param)
           elsif @argument.type.enum?
             param = {
               name: @argument.name.to_s,
               in: "query",
               schema: generate_schema_ref(@argument.type.klass.definition)
             }
+            param[:required] = true if @argument.required?
             add_to_parameters(param)
             add_to_components_schemas(@argument)
           else
@@ -78,6 +80,7 @@ def add_to_spec
                 type: convert_type_to_open_api_data_type(@argument.type)
               }
             }
+            param[:required] = true if @argument.required?
             add_to_parameters(param)
           end
         end

lib/apia/open_api/objects/request_body.rb

@@ -31,7 +31,9 @@ def initialize(spec:, route:, route_spec:)
         end
 
         def add_to_spec
+          required = []
           @route.endpoint.definition.argument_set.definition.arguments.each_value do |arg|
+            required << arg.name.to_s if arg.required?
             if arg.array?
               if arg.type.argument_set? || arg.type.enum?
                 items = generate_schema_ref(arg.type.klass.definition)
@@ -54,12 +56,13 @@ def add_to_spec
             end
           end
 
+          schema = { properties: @properties }
+          schema[:required] = required unless required.empty?
+
           @route_spec[:requestBody] = {
             content: {
               "application/json": {
-                schema: {
-                  properties: @properties
-                }
+                schema: schema
               }
             }
           }

lib/apia/open_api/objects/schema.rb

@@ -120,6 +120,11 @@ def generate_schema_for_child(schema, child, all_properties_included)
               type: convert_type_to_open_api_data_type(child.type)
             }
           end
+
+          if child.try(:required?)
+            schema[:required] ||= []
+            schema[:required] << child.name.to_s
+          end
           schema
         end
 

spec/support/fixtures/openapi.json

@@ -36,7 +36,8 @@
             "in": "query",
             "schema": {
               "$ref": "#/components/schemas/CoreAPI_Objects_TimeZone"
-            }
+            },
+            "required": true
           }
         ],
         "responses": {
@@ -78,7 +79,11 @@
                   "timezone": {
                     "$ref": "#/components/schemas/CoreAPI_Objects_TimeZone"
                   }
-                }
+                },
+                "required": [
+                  "time",
+                  "timezone"
+                ]
               }
             }
           }
@@ -122,7 +127,10 @@
                       "$ref": "#/components/schemas/CoreAPI_ArgumentSets_TimeLookupArgumentSet"
                     }
                   }
-                }
+                },
+                "required": [
+                  "times"
+                ]
               }
             }
           }
@@ -204,7 +212,8 @@
               "items": {
                 "$ref": "#/components/schemas/CoreAPI_Objects_TimeZone"
               }
-            }
+            },
+            "required": true
           },
           {
             "name": "filters[]",
@@ -298,7 +307,10 @@
                       "type": "string"
                     }
                   }
-                }
+                },
+                "required": [
+                  "time_zones"
+                ]
               }
             }
           }
@@ -386,7 +398,8 @@
             "in": "query",
             "schema": {
               "type": "string"
-            }
+            },
+            "required": true
           }
         ],
         "responses": {
@@ -445,7 +458,11 @@
                   "scalar": {
                     "type": "string"
                   }
-                }
+                },
+                "required": [
+                  "object",
+                  "scalar"
+                ]
               }
             }
           }
@@ -517,7 +534,8 @@
             "in": "query",
             "schema": {
               "$ref": "#/components/schemas/CoreAPI_Objects_TimeZone"
-            }
+            },
+            "required": true
           }
         ],
         "responses": {
@@ -557,7 +575,11 @@
                   "timezone": {
                     "$ref": "#/components/schemas/CoreAPI_Objects_TimeZone"
                   }
-                }
+                },
+                "required": [
+                  "time",
+                  "timezone"
+                ]
               }
             }
           }
@@ -604,7 +626,10 @@
           "string": {
             "type": "string"
           }
-        }
+        },
+        "required": [
+          "unix"
+        ]
       },
       "CoreAPI_Objects_Time": {
         "type": "object",