Merge pull request #532 from sebadob/doc-exposed-swagger-ui

doc: mention link to exposed SwaggerUI
sebadob · Aug 5, 2024 · 344e79c · 344e79c
2 parents 28b2457 + e34eab8
commit 344e79c
Show file tree

Hide file tree

Showing 5 changed files with 37 additions and 2 deletions.
diff --git a/book/src/swagger.md b/book/src/swagger.md
@@ -17,6 +17,15 @@ If you want to test certain endpoints, I suggest you <b>create an API Key</b> fo
 you like.
 ```
 
+```admonish hint
+If you just want to take a look at the SwaggerUI when you have no running Rauthy instance yet, I have a test / dev 
+instance running which exposes the API docs: 
+<a href="https://iam.sebadob.dev/docs/v1/swagger-ui/" target="_blank">Swagger UI</a>
+
+Please note that this is a testing instance and it might not be online all the time or be running the latest nightly
+build, but everything should be fine most of the time.
+```
+
 ## External Access
 
 If you open the Rauthy Admin UI and navigate to `Docs`, you will find a link to the Swagger UI that each Rauthy instance

diff --git a/docs/print.html b/docs/print.html
@@ -4395,6 +4395,19 @@ <h2 id="rotation-event"><a class="header" href="#rotation-event">Rotation Event<
 you like.</p>
 </div>
 </div>
+<div id="admonition-hint" class="admonition admonish-tip">
+<div class="admonition-title">
+<p>Hint</p>
+<p><a class="admonition-anchor-link" href="swagger.html#admonition-hint"></a></p>
+</div>
+<div>
+<p>If you just want to take a look at the SwaggerUI when you have no running Rauthy instance yet, I have a test / dev
+instance running which exposes the API docs:
+<a href="https://iam.sebadob.dev/docs/v1/swagger-ui/" target="_blank">Swagger UI</a></p>
+<p>Please note that this is a testing instance and it might not be online all the time or be running the latest nightly
+build, but everything should be fine most of the time.</p>
+</div>
+</div>
 <h2 id="external-access"><a class="header" href="#external-access">External Access</a></h2>
 <p>If you open the Rauthy Admin UI and navigate to <code>Docs</code>, you will find a link to the Swagger UI that each Rauthy instance
 hosts. By default, in production this will not be exposed and the link in the UI will not be working as mentioned in the

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/searchindex.json b/docs/searchindex.json
diff --git a/docs/swagger.html b/docs/swagger.html
@@ -193,6 +193,19 @@ <h1 id="swagger-ui"><a class="header" href="#swagger-ui">Swagger UI</a></h1>
 you like.</p>
 </div>
 </div>
+<div id="admonition-hint" class="admonition admonish-tip">
+<div class="admonition-title">
+<p>Hint</p>
+<p><a class="admonition-anchor-link" href="#admonition-hint"></a></p>
+</div>
+<div>
+<p>If you just want to take a look at the SwaggerUI when you have no running Rauthy instance yet, I have a test / dev
+instance running which exposes the API docs:
+<a href="https://iam.sebadob.dev/docs/v1/swagger-ui/" target="_blank">Swagger UI</a></p>
+<p>Please note that this is a testing instance and it might not be online all the time or be running the latest nightly
+build, but everything should be fine most of the time.</p>
+</div>
+</div>
 <h2 id="external-access"><a class="header" href="#external-access">External Access</a></h2>
 <p>If you open the Rauthy Admin UI and navigate to <code>Docs</code>, you will find a link to the Swagger UI that each Rauthy instance
 hosts. By default, in production this will not be exposed and the link in the UI will not be working as mentioned in the