use a swagger plugin to render texas openapi spec

nais · Nov 21, 2024 · 3f9d2f5 · 3f9d2f5
1 parent e207f3a
commit 3f9d2f5
Show file tree

Hide file tree

Showing 6 changed files with 272 additions and 210 deletions.
diff --git a/docs/auth/partials/validate.md b/docs/auth/partials/validate.md
@@ -11,6 +11,8 @@ Texas is [Token Exchange as a Service](../../explanations/README.md#texas), aime
 Send a HTTP POST request to the endpoint described in the `$NAIS_TOKEN_INTROSPECT_ENDPOINT` environment variable.
 Set `target` to the access token you wish to validate.
 
+For the complete API documentation, see [Texas OpenAPI reference](../../reference/texas.md).
+
 ```json
 {
     "identity_provider": "<IDENTITY_PROVIDER>",

diff --git a/docs/auth/reference/texas.md b/docs/auth/reference/texas.md
@@ -0,0 +1,9 @@
+---
+hide: ['toc']
+---
+<style>
+.md-typeset h1, .md-content__button {
+    display: none;
+}
+</style>
+<swagger-ui src="https://raw.githubusercontent.com/nais/texas/refs/heads/master/doc/openapi-spec.json"/>
diff --git a/docs/css/swagger.css b/docs/css/swagger.css
@@ -0,0 +1,3 @@
+.info {
+    margin-top: 0 !important;
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -69,8 +69,11 @@ extra_css:
   - material_theme_stylesheet_overrides/uu.css
   - material_theme_stylesheet_overrides/grid.css
   - css/gcp_only_admonition.css
+  - css/swagger.css
 plugins:
   - awesome-pages
+  - swagger-ui-tag:
+      extra_css: ['css/swagger.css']
   - tags:
       tags_file: ./tags.md
   - macros: