Merge pull request #235 from pulsar-edit/update-openapi-spec

Automatically Update OpenAPI Documentation
pulsar-edit · Feb 10, 2024 · 7934376 · 7934376
2 parents 0b34409 + a3249cb
commit 7934376
Show file tree

Hide file tree

Showing 45 changed files with 1,655 additions and 647 deletions.
diff --git a/.github/workflows/ci-standards.yml b/.github/workflows/ci-standards.yml
@@ -39,6 +39,9 @@ jobs:
     - name: Generate Complexity Reports
       run: npm run complex
 
+    - name: Generate OpenAPI Docs
+      run: npm run openapi-docs
+
     - name: Commit All Changes
       uses: stefanzweifel/git-auto-commit-action@v4
       with:

diff --git a/docs/index.md b/docs/index.md
@@ -43,12 +43,12 @@ A quick note here, the following resources, while still incredibly helpful to un
   * [Logging](./reference/logging.md): How the built in logging module works.
   * [Numeric Error Codes](./reference/numeric_error_codes.md): **Deprecated** Definition and List of numeric error codes that may be returned.
   * [Packages](./reference/packages.md): Information on where the Pulsar Package Registry got it's packages and what to do if you don't see yours.
-  * [Queries](./reference/queries.md): **Deprecated** Details of some of the common SQL queries used to retreive information from the Pulsar Package Registry.
+  * [Queries](./reference/queries.md): **Deprecated** Details of some of the common SQL queries used to retrieve information from the Pulsar Package Registry.
   * [Returns](./reference/returns.md): Definition of the objects returned and handled.
   * [Server Status Object](./reference/server_status_object.md): Definition of the Server Status Object.
   * [Build](./build.md): Documentation on how to build the Pulsar Package Registry.
   * [Writing Integration Tests](./writingIntegrationTests.md): **Deprecated** Documentation about how to successfully write integration tests.
-  
+
 A number of documents within this repo are automatically generated. These documents can help to view the codebase as it is right now. These documents can be helpful to identify problem areas or to learn about the source code itself.
 
 The following list contains automatically generated content:

diff --git a/docs/swagger/index.html b/docs/swagger/index.html
@@ -7,13 +7,13 @@
     <title>SwaggerUI</title>
     <link
       rel="stylesheet"
-      href="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui.css"
+      href="https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui.css"
     />
   </head>
   <body>
     <div id="swagger-ui"></div>
     <script
-      src="https://unpkg.com/swagger-ui-dist@4.5.0/swagger-ui-bundle.js"
+      src="https://unpkg.com/swagger-ui-dist@5.11.0/swagger-ui-bundle.js"
       crossorigin
     ></script>
     <script>