LukeParke/OpenAPI.gg
1
0
Fork 0
mirror of https://github.com/LukeHagar/OpenAPI.gg.git synced 2025-12-07 12:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

add auth descriptions

Browse Source
This commit is contained in:
Malte Teichert
2024-05-20 00:13:34 +02:00
parent eadefcf8d4
commit 45d640b5d7
1 changed files with 15 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
src/lib/components/atoms/AuthenticationItem.svelte
View File

@@ -72,6 +72,9 @@
{:else if data.type == 'apiKey' && data.in == 'header'} {:else if data.type == 'apiKey' && data.in == 'header'}
<!-- Cookie API Keys handled by CookieAuth --> <!-- Cookie API Keys handled by CookieAuth -->
<h3 class="h3">API Key</h3> <h3 class="h3">API Key</h3>
<p>
API keys are a simple authentication method that the client provides when making API requests.
</p>
<label class="space-y-2"> <label class="space-y-2">
<h4 class="h4">Unique name for the security scheme</h4> <h4 class="h4">Unique name for the security scheme</h4>
<input class="input" type="text" placeholder="apiKeyAuth" bind:value={data.identifier} /> <input class="input" type="text" placeholder="apiKeyAuth" bind:value={data.identifier} />
@@ -89,6 +92,10 @@
</label> </label>
{:else if data.type == 'openIdConnect'} {:else if data.type == 'openIdConnect'}
<h3 class="h3">OpenID</h3> <h3 class="h3">OpenID</h3>
<p>
OpenID Connect (OIDC) is an identity layer built on top of the OAuth 2.0 protocol and
supported by some OAuth 2.0 providers, such as Google and Azure Active Directory.
</p>
<label class="space-y-2"> <label class="space-y-2">
<h4 class="h4">Unique name for the security scheme</h4> <h4 class="h4">Unique name for the security scheme</h4>
<input class="input" type="text" placeholder="openIdAuth" bind:value={data.identifier} /> <input class="input" type="text" placeholder="openIdAuth" bind:value={data.identifier} />
@@ -103,6 +110,10 @@
</label> </label>
{:else if data.type == 'oauth2'} {:else if data.type == 'oauth2'}
<h3 class="h3">OAuth2</h3> <h3 class="h3">OAuth2</h3>
<p>
OAuth 2.0 is an authorization protocol that gives an API client limited access to user data on
a web server.
</p>
<label class="space-y-2"> <label class="space-y-2">
<h4 class="h4">Unique name for the security scheme</h4> <h4 class="h4">Unique name for the security scheme</h4>
<input class="input" type="text" placeholder="oAuth" bind:value={data.identifier} /> <input class="input" type="text" placeholder="oAuth" bind:value={data.identifier} />
@@ -142,6 +153,10 @@
</span> </span>
{:else if data.type == 'apiKey' && data.in == 'cookie'} {:else if data.type == 'apiKey' && data.in == 'cookie'}
<h3 class="h3">Cookie Auth</h3> <h3 class="h3">Cookie Auth</h3>
<p>
Cookie authentication uses HTTP cookies to authenticate client requests and maintain session
information.
</p>
<label class="space-y-2"> <label class="space-y-2">
<h4 class="h4">Unique name for the security scheme</h4> <h4 class="h4">Unique name for the security scheme</h4>
<input class="input" type="text" placeholder="cookieAuth" bind:value={data.identifier} /> <input class="input" type="text" placeholder="cookieAuth" bind:value={data.identifier} />