Merge pull request #516 from sebadob/doc-swagger-api-key-info

doc: hint to use API Keys for endpoint testing
sebadob · Jul 17, 2024 · ca3539c · ca3539c
2 parents ec2923a + 26edbad
commit ca3539c
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 2 deletions.
diff --git a/book/src/swagger.md b/book/src/swagger.md
@@ -12,6 +12,9 @@ For this reason, you have multiple ways of accessing the Swagger UI.
 ```admonish info 
 The UI is not meant to be used for testing out endpoints. Rauthy has way to many options and details regarding to the
 authentication and it's not that simple, that the default Swagger UI can handle it, at least to my knowledge.
+
+If you want to test certain endpoints, I suggest you <b>create an API Key</b> for that case, which you can use with any tool
+you like.
 ```
 
 ## External Access

diff --git a/docs/print.html b/docs/print.html
@@ -4088,6 +4088,8 @@ <h2 id="advanced-client-json-document"><a class="header" href="#advanced-client-
 <div>
 <p>The UI is not meant to be used for testing out endpoints. Rauthy has way to many options and details regarding to the
 authentication and it's not that simple, that the default Swagger UI can handle it, at least to my knowledge.</p>
+<p>If you want to test certain endpoints, I suggest you <b>create an API Key</b> for that case, which you can use with any tool
+you like.</p>
 </div>
 </div>
 <h2 id="external-access"><a class="header" href="#external-access">External Access</a></h2>

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
@@ -189,6 +189,8 @@ <h1 id="swagger-ui"><a class="header" href="#swagger-ui">Swagger UI</a></h1>
 <div>
 <p>The UI is not meant to be used for testing out endpoints. Rauthy has way to many options and details regarding to the
 authentication and it's not that simple, that the default Swagger UI can handle it, at least to my knowledge.</p>
+<p>If you want to test certain endpoints, I suggest you <b>create an API Key</b> for that case, which you can use with any tool
+you like.</p>
 </div>
 </div>
 <h2 id="external-access"><a class="header" href="#external-access">External Access</a></h2>