OpenAPI specification (#669)

* Add OpenAPI plugin and config sidebars

* Update API documentation configuration

* Add new scripts and versions for API documentation

* Add OpenAPI specification generation and build step

* Update OpenAPI build step

* Add OpenAPI documentation generation step

* Add OpenAPI documentation generation step

* Comment out version selector and crumb in sidebars.js

* Add API Design documentation to sidebar

* Update package.json scripts to use npm instead of yarn

* Disable SendButton for code-gen specs

* Update dependencies and add security

* Update API server URLs and add variables

* Update ReportPortal server URLs and Docusaurus dependencies

* Update import paths for service API and service UAT

* Add empty versions object for API documentation

* Update api sidebars structure

* Add manual sections to service-api.yaml and service-uat.yaml

* Update links in docusaurus.config.js

* Add contact information and website link to API intro

.github/workflows/ci.yml

@@ -39,5 +39,8 @@ jobs:
       - name: Run lint
         run: npm run lint
 
+      - name: Build the OpenAPI documentation
+        run: npm run gen-all
+
       - name: Build the source code
         run: npm run build

.github/workflows/deploy-dev.yml

@@ -63,6 +63,9 @@ jobs:
           touch .env
           echo DOCS_BASE_URL=${{ env.DOCS_BASE_URL }} >> .env
 
+      - name: Build the OpenAPI documentation
+        run: npm run gen-all
+
       - name: Build the source code
         run: npm run build
 

.github/workflows/deploy.yml

@@ -43,6 +43,9 @@ jobs:
         run: |
           touch .env
           echo DOCS_BASE_URL=${{ env.DOCS_BASE_URL }} >> .env
+      
+      - name: Build the OpenAPI documentation
+        run: npm run gen-all
 
       - name: Build the source code
         run: npm run build

.gitignore

@@ -3,6 +3,11 @@
 
 # Production
 /build
+/docs/api/*
+!/docs/api/_category_.yml
+!/docs/api/intro.mdx
+!/docs/api/sidebars.ts
+!/docs/api/versioned_sidebars
 
 # Generated files
 .docusaurus