feat: implemented schema endpoints

catalog-info.yaml

@@ -1,15 +1,14 @@
 apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
-  name:  config-server
-  description: A Node.js service that provides configuration data to other services 
+  name: config-server
+  description: A Node.js service that provides configuration data to other services
   annotations:
     github.com/project-slug: MapColonies/config-server
   tags:
     - nodejs
     - typescript
     - expressjs
-    - boilerplate
 spec:
   type: service
   lifecycle: production

openapi3.yaml

@@ -117,22 +117,22 @@ paths:
           $ref: '#/components/responses/404NotFound'
         '500':
           $ref: '#/components/responses/500InternalServerError'
-  /schema/{path}:
+  /schema:
     get:
       parameters:
-        - name: path
-          in: path
-          description: The relative path of the schema as defined in the schema id
+        - name: id
+          in: query
+          description: The id of the requested schema
           required: true
-          schema: 
-            type: string
+          schema:
+            $ref: '#/components/schemas/schemaId'
         - name: shouldDereference
           in: query
-          description: should the schema contain refs
+          description: should the server bundle all refs into one schema
           schema:
             type: boolean
       operationId: getSchema
-      summary: return a tree representation of all the schemas
+      summary: returns the requested schema
       responses:
         200:
           description: OK
@@ -146,7 +146,7 @@ paths:
           $ref: '#/components/responses/404NotFound'
         '500':
           $ref: '#/components/responses/500InternalServerError'
-  /schemas:
+  /schema/tree:
     get:
       operationId: getSchemasTree
       summary: return a tree representation of all the schemas
@@ -156,7 +156,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "#/components/schemas/schemaTree"
+                $ref: '#/components/schemas/schemaTree'
         '400':
           $ref: '#/components/responses/400BadRequest'
         '500':
@@ -297,7 +297,7 @@ components:
     schemaId:
       type: string
       pattern: "^https:\\/\\/mapcolonies\\.com\\/.+$"
-      example: "https://mapcolonies.com/common/db/v1"
+      example: 'https://mapcolonies.com/common/db/v1'
     version:
       type: string
       pattern: '^v[1-9]+[0-9]*$'
@@ -310,39 +310,39 @@ components:
       maxLength: 50
     schemaTree:
       type: array
-      example: 
+      example:
         - name: common
           children:
-           - name: boilerplate
-             children:
-               - name: v1
-                 url: https://mapcolonies.com/common/boilerplate/v1
-               - name: v2
-                 url: https://mapcolonies.com/common/boilerplate/v2
-               - name: v3
-                 url: https://mapcolonies.com/common/boilerplate/v3
-           - name: db
-             children:
-               - name: v1
-                 url: https://mapcolonies.com/common/db/v1
-               
+            - name: boilerplate
+              children:
+                - name: v1
+                  url: https://mapcolonies.com/common/boilerplate/v1
+                - name: v2
+                  url: https://mapcolonies.com/common/boilerplate/v2
+                - name: v3
+                  url: https://mapcolonies.com/common/boilerplate/v3
+            - name: db
+              children:
+                - name: v1
+                  url: https://mapcolonies.com/common/db/v1
+
       items:
         oneOf:
-          - $ref: "#/components/schemas/schemaTreeItem"
-          - $ref: "#/components/schemas/schemaTreeDir"
+          - $ref: '#/components/schemas/schemaTreeItem'
+          - $ref: '#/components/schemas/schemaTreeDir'
     schemaTreeItem:
       type: object
-      properties: 
-        name: 
+      properties:
+        name:
           type: string
         id:
           type: string
     schemaTreeDir:
       type: object
       properties:
         children:
-          $ref: "#/components/schemas/schemaTree"
-        name: 
+          $ref: '#/components/schemas/schemaTree'
+        name:
           type: string
     config:
       type: object