adds support to externalDocs per route when using OAS 2.0 and updates…

… FastifySchema interface (#527)

* fix(types): adds externalDocs option to route schema

* feat(swagger): adds support to externalDocs per route

index.d.ts

@@ -22,6 +22,7 @@ declare module 'fastify' {
     summary?: string;
     consumes?: string[];
     produces?: string[];
+    externalDocs?: OpenAPIV2.ExternalDocumentationObject | OpenAPIV3.ExternalDocumentationObject;
     security?: Array<{ [securityLabel: string]: string[] }>;
     /**
      * OpenAPI operation unique identifier

lib/spec/swagger/utils.js

@@ -285,6 +285,7 @@ function prepareSwaggerMethod (schema, ref, swaggerObject) {
     if (schema.operationId) swaggerMethod.operationId = schema.operationId
     if (schema.summary) swaggerMethod.summary = schema.summary
     if (schema.description) swaggerMethod.description = schema.description
+    if (schema.externalDocs) swaggerMethod.externalDocs = schema.externalDocs
     if (schema.tags) swaggerMethod.tags = schema.tags
     if (schema.produces) swaggerMethod.produces = schema.produces
     if (schema.consumes) swaggerMethod.consumes = schema.consumes

test/spec/swagger/route.js

@@ -120,7 +120,7 @@ test('route options - deprecated', t => {
 })
 
 test('route options - meta', t => {
-  t.plan(8)
+  t.plan(9)
   const fastify = Fastify()
 
   fastify.register(fastifySwagger, swaggerOption)
@@ -132,7 +132,11 @@ test('route options - meta', t => {
       tags: ['tag'],
       description: 'Route description',
       produces: ['application/octet-stream'],
-      consumes: ['application/x-www-form-urlencoded']
+      consumes: ['application/x-www-form-urlencoded'],
+      externalDocs: {
+        description: 'Find more info here',
+        url: 'https://swagger.io'
+      }
     }
   }
 
@@ -152,6 +156,7 @@ test('route options - meta', t => {
         t.equal(opts.schema.description, definedPath.description)
         t.same(opts.schema.produces, definedPath.produces)
         t.same(opts.schema.consumes, definedPath.consumes)
+        t.equal(opts.schema.externalDocs, definedPath.externalDocs)
       })
       .catch(function (err) {
         t.fail(err)

test/types/types.test.ts

@@ -63,6 +63,10 @@ app.put('/some-route/:id', {
       consumes: ['application/json', 'multipart/form-data'],
       security: [{ apiKey: []}],
       operationId: 'opeId',
+      externalDocs: {
+        url: 'https://swagger.io',
+        description: 'Find more info here'
+      },
     }
   }, (req, reply) => {});