upd openapi

bcgov · Jun 1, 2021 · 9cedfb2 · 9cedfb2
1 parent 44fdd93
commit 9cedfb2
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 0 deletions.
diff --git a/src/api-openapi.js b/src/api-openapi.js
@@ -17,6 +17,13 @@ class ApiOpenapiApp {
 
     RegisterRoutes(app);
 
+    // RFC 8631 service-desc link relation
+    // https://datatracker.ietf.org/doc/html/rfc8631
+    app.get('/ds/api', (req, res) => {
+      res.setHeader('Link', '</ds/api/openapi.yaml>; rel="service-desc"');
+      res.status(204).end();
+    });
+
     app.get('/ds/api/openapi.yaml', (req, res) => {
       res.setHeader('Content-Type', 'application/yaml');
       res.send(spec);

diff --git a/src/controllers/ContentController.ts b/src/controllers/ContentController.ts
@@ -16,6 +16,7 @@ import multer from 'multer';
 import { DateTime, Markdown } from '@keystonejs/fields';
 
 interface Content {
+  kind?: string;
   externalLink: string;
   title?: string;
   description?: string;

diff --git a/src/controllers/openapi.yaml b/src/controllers/openapi.yaml
@@ -7,6 +7,8 @@ components:
     schemas:
         Content:
             properties:
+                kind:
+                    type: string
                 externalLink:
                     type: string
                 title:

diff --git a/src/controllers/routes.ts b/src/controllers/routes.ts
@@ -27,6 +27,7 @@ const models: TsoaRoute.Models = {
     "Content": {
         "dataType": "refObject",
         "properties": {
+            "kind": {"dataType":"string"},
             "externalLink": {"dataType":"string","required":true},
             "title": {"dataType":"string"},
             "description": {"dataType":"string"},