Spec updates (#433)

* added SBT token page

* updated spec to open all tags

* updated example merger with security scheme

* updated example gen

* merged master

* Revert "merged master"

This reverts commit b7ed6d2.

docs/components/SpecAPIComponent/APIComponent.tsx

@@ -48,6 +48,7 @@ function APIComponent({ specType }: any) {
             token: apiKey,
           },
         },
+        defaultOpenAllTags: true
       })
     }
 

libs/example_merger.js

@@ -29,11 +29,38 @@ const saveOpenAPIDocument = (filePath, document) => {
 
 const addExamplesToOpenAPI = (doc, examples) => {
   // Check if the document title contains 'Metadata' or 'Indexer'
-  if (
-    doc.info.title.includes('Metadata') ||
-    doc.info.title.includes('Indexer') ||
-    doc.info.title.includes('Analytics')
-  ) {
+  if (doc.info.title.includes('Metadata') || doc.info.title.includes('Analytics')) {
+    doc.tags = [
+      {
+        name: 'public',
+        description:
+          'Endpoints accessible by passing your project-access-key in the header. This is injected whenever you login automatically.',
+      },
+      {
+        name: 'secret',
+        description:
+          'Endpoints that require a Sequence service token intended to be secret. You can manually generate one on Sequence Builder and pass it as a Bearer Token.',
+      },
+    ]
+  }
+
+  if (doc.info.title.includes('Indexer')) {
+    doc.components.securitySchemes = {
+      ApiKeyAuth: {
+        type: 'apiKey',
+        in: 'header',
+        description:
+          'Project access key for authenticating requests, get an access key at https://sequence.build',
+        name: 'X-Access-Key',
+      },
+      BearerAuth: {
+        type: 'http',
+        scheme: 'bearer',
+        bearerFormat: 'JWT',
+        description: 'JWT Service Token generated from Sequence Builder',
+      },
+    }
+
     doc.tags = [
       {
         name: 'public',
@@ -70,14 +97,18 @@ const addExamplesToOpenAPI = (doc, examples) => {
                 requestBody.content['multipart/form-data'] =
                   requestBody.content['multipart/form-data'] || {}
                 requestBody.content['multipart/form-data'].example = ex.request
+
               }
 
               if (requestBody.content['multipart/form-data']) {
                 requestBody.content['multipart/form-data'].example = ex.request
               }
 
               if (requestBody.content['application/json']) {
-                requestBody.content['application/json'].example = ex.request
+                requestBody.content['application/json'].examples = {}
+                requestBody.content['application/json'].examples[exampleName] = {}
+                requestBody.content['application/json'].examples[exampleName].value = ex.request
+                requestBody.content['application/json'].examples[exampleName].summary = ex.summary
               }
             }
           }
@@ -89,15 +120,28 @@ const addExamplesToOpenAPI = (doc, examples) => {
               if (!response.content) {
                 response.content = {
                   'application/json': {
-                    example: ex.response,
+                    examples: {
+                      exampleName: {
+                        value: ex.response,
+                        summary: ex.summary
+                      }
+                    }
                   },
                 }
               } else {
                 if (response.content['application/json']) {
-                  response.content['application/json'].example = ex.response
+                  response.content['application/json'].examples = {}
+                  response.content['application/json'].examples[exampleName] = {}
+                  response.content['application/json'].examples[exampleName].value = ex.response
+                  response.content['application/json'].examples[exampleName].summary = ex.summary
                 } else {
                   response.content['application/json'] = {
-                    example: ex.response,
+                    examples: {
+                      exampleName: {
+                        value: ex.response,
+                        summary: ex.summary
+                      }
+                    }
                   }
                 }
               }