fix(openapi): keep required query flag for params (#910)

Author: mcollina

lib/spec/openapi/utils.js

@@ -134,17 +134,18 @@ function convertExamplesArrayToObject (examples) {
 // For supported keys read:
 // https://swagger.io/docs/specification/describing-parameters/
 function plainJsonObjectToOpenapi3 (opts, container, jsonSchema, externalSchemas, securityIgnores = []) {
-  const obj = convertJsonSchemaToOpenapi3(opts, resolveLocalRef(jsonSchema, externalSchemas))
+  const localJsonSchema = resolveLocalRef(jsonSchema, externalSchemas)
+  const obj = convertJsonSchemaToOpenapi3(opts, localJsonSchema)
   let toOpenapiProp
   switch (container) {
     case 'cookie':
     case 'header':
     case 'query':
-      toOpenapiProp = function (propertyName, jsonSchemaElement) {
+      toOpenapiProp = function (propertyName, jsonSchemaElement, required) {
         let result = {
           in: container,
           name: propertyName,
-          required: jsonSchemaElement.required
+          required
         }
 
         const media = schemaToMedia(jsonSchemaElement)
@@ -194,7 +195,7 @@ function plainJsonObjectToOpenapi3 (opts, container, jsonSchema, externalSchemas
   return Object.keys(obj)
     .filter((propKey) => (!securityIgnores.includes(propKey)))
     .map((propKey) => {
-      const jsonSchema = toOpenapiProp(propKey, obj[propKey])
+      const jsonSchema = toOpenapiProp(propKey, obj[propKey], localJsonSchema[propKey]?.required)
       if (jsonSchema.schema) {
         // it is needed as required in schema is invalid prop - delete only if needed
         if (jsonSchema.schema.required !== undefined) delete jsonSchema.schema.required

test/spec/openapi/refs.test.js

@@ -308,6 +308,49 @@ test('uses examples if has property required in body', async (t) => {
   t.assert.deepStrictEqual(schema.parameters[0].in, 'query')
 })
 
+test('renders required query parameter when property is a $ref', async (t) => {
+  const fastify = Fastify()
+  await fastify.register(fastifySwagger, { openapi: {} })
+
+  fastify.addSchema({
+    $id: 'CoringUploadTypeApiModel',
+    type: 'string',
+    enum: ['health_safety', 'coring']
+  })
+
+  fastify.get('/some-route', {
+    schema: {
+      query: {
+        type: 'object',
+        required: ['thing'],
+        properties: {
+          thing: { $ref: 'CoringUploadTypeApiModel' },
+          other: { type: 'string' }
+        }
+      },
+      response: {
+        200: {
+          type: 'object',
+          properties: {
+            hello: { type: 'string' }
+          }
+        }
+      }
+    }
+  }, () => ({ hello: 'world' }))
+
+  await fastify.ready()
+
+  const openapiObject = fastify.swagger()
+  await Swagger.validate(openapiObject)
+
+  const thingQueryParam = openapiObject.paths['/some-route'].get.parameters.find(parameter => parameter.name === 'thing')
+  const otherQueryParam = openapiObject.paths['/some-route'].get.parameters.find(parameter => parameter.name === 'other')
+
+  t.assert.strictEqual(thingQueryParam.required, true)
+  t.assert.strictEqual(otherQueryParam.required, false)
+})
+
 test('renders $ref schema with enum in headers', async (t) => {
   const fastify = Fastify()
   await fastify.register(fastifySwagger, { openapi: {} })