feat: add service api documentation (#107)

* feat: add service api documentation

Signed-off-by: Sebastian Becker <[email protected]>

.github/workflows/gh-pages.yml

@@ -22,6 +22,6 @@ jobs:
       - name: Install Material for MkDocs
         run: pip install \
           git+https://${{ secrets.MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/[email protected] \
-          mkdocs-minify-plugin==0.5.0
+          mkdocs-minify-plugin==0.5.0 mkdocs-swagger-ui-tag==0.6.8
       - name: Deploy site
         run: mkdocs gh-deploy --force

3RD-PARTY-LICENSES/github.com/blueswen/mkdocs-swagger-ui-tag/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Blueswen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

3RD-PARTY-LICENSES/sbom.json

@@ -2,5 +2,8 @@
   {
     "project": "https://github.com/knative/docs",
     "license": "Apache-2.0"
+  }, {
+    "project": "https://github.com/blueswen/mkdocs-swagger-ui-tag",
+    "license": "MIT"
   }
-]
+]

config/nav.yml

@@ -6,21 +6,28 @@
 #
 nav:
   - Home: index.md
-  - Getting Started:
-      - getting-started/index.md
-      - Overview: getting-started/overview.md
-      - Prerequisites: getting-started/prerequisites.md
-      - Deployment:
-          - getting-started/deployment/index.md
-          - Manual:
-              - getting-started/deployment/manual/index.md
-              - Platform Setup: getting-started/deployment/manual/platform-setup.md
-              - Stack: getting-started/deployment/manual/stack.md
-          - Infrastructure as Code:
-              - getting-started/deployment/infrastructure-as-code/index.md
-              - Local: getting-started/deployment/infrastructure-as-code/local.md
-      - Configuring the CLI: getting-started/cli.md
-      - Millionaires Problem: getting-started/millionaires.md
+  - Documentation:
+      - Getting Started:
+          - documentation/getting-started/index.md
+          - Overview: documentation/getting-started/overview.md
+          - Prerequisites: documentation/getting-started/prerequisites.md
+          - Deployment:
+              - documentation/getting-started/deployment/index.md
+              - Manual:
+                  - documentation/getting-started/deployment/manual/index.md
+                  - Platform Setup: documentation/getting-started/deployment/manual/platform-setup.md
+                  - Stack: documentation/getting-started/deployment/manual/stack.md
+              - Infrastructure as Code:
+                  - documentation/getting-started/deployment/infrastructure-as-code/index.md
+                  - Local: documentation/getting-started/deployment/infrastructure-as-code/local.md
+          - Configuring the CLI: documentation/getting-started/cli.md
+          - Millionaires Problem: documentation/getting-started/millionaires.md
+      - Reference:
+          - API Specification:
+              - documentation/reference/api-specification/index.md
+              - Castor: documentation/reference/api-specification/castor.md
+              - Amphora: documentation/reference/api-specification/amphora.md
+              - Ephemeral: documentation/reference/api-specification/ephemeral.md
   - Blog: https://blog.carbynestack.io
   - Community:
       - Participate: community/participate.md

docs/documentation/reference/api-specification/amphora.md

@@ -0,0 +1,3 @@
+<!-- markdownlint-disable MD041 -->
+<!-- Disable enforcing of top-level header as this is provided by swagger-ui plugin -->
+<swagger-ui src="./amphora/amphora.oad.yaml"/>