Add link to Swagger docs to main menu (#284)

The HTTP API reference is not linked through the docs site so it's not clear to a newcomer to Sigstore that one actually exists. This change adds a link on the main menu out to the auto-generated Swagger site so that it is easily discoverable. Signed-off-by: Colleen Murphy <[email protected]>
sigstore · Jan 4, 2024 · 37a51c6 · 37a51c6
1 parent a4c627b
commit 37a51c6
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/config/_default/menus/menus.en.toml b/config/_default/menus/menus.en.toml
@@ -22,6 +22,12 @@
   identifier = "policy-controller"
   url = "https://github.com/sigstore/policy-controller/blob/main/docs/api-types/index.md"
 
+[[swagger]]
+  name = "OpenAPI Specification"
+  weight = 50
+  identifier = "swagger"
+  url = "https://www.sigstore.dev/swagger/"
+
 # [[main]]
 #   name = "Docs"
 #   url = "/docs/about/overview/"

diff --git a/layouts/partials/sidebar/auto-collapsible-menu.html b/layouts/partials/sidebar/auto-collapsible-menu.html
@@ -15,6 +15,15 @@
 
   {{ $Sections := site.Sections | append $ExternalSiteSection }}
 
+  {{ $SwaggerDocsPages := slice }}
+  {{- range site.Menus.swagger }}
+  {{ $NewPage := dict "TargetBlank" true "Title" .Name "Permalink" .ConfiguredURL }}
+    {{ $SwaggerDocsPages = $SwaggerDocsPages | append $NewPage }}
+  {{ end }}
+  {{ $SwaggerSection := dict "Title" "API Reference" "Pages" $SwaggerDocsPages }}
+
+  {{ $Sections = $Sections | append $SwaggerSection }}
+
 
   <!-- This changed from Doks default to reflect no "docs" section folder -->
     {{ range $Sections }}