Update Auth docs details about SSO/OAuth endpoints (#3871)

This commit is contained in:
Mattia Panzeri
2021-02-01 16:36:35 +01:00
committed by GitHub
parent 693e770ca3
commit 59431ce516
3 changed files with 14 additions and 15 deletions

View File

@@ -89,10 +89,10 @@ paths:
$ref: "./paths/auth/password-request.yaml"
/auth/password/reset:
$ref: "./paths/auth/password-reset.yaml"
/auth/sso:
$ref: "./paths/auth/sso.yaml"
/auth/sso/{provider}:
$ref: "./paths/auth/sso-provider.yaml"
/auth/oauth:
$ref: "./paths/auth/oauth.yaml"
/auth/oauth/{provider}:
$ref: "./paths/auth/oauth-provider.yaml"
# Items
/items/{collection}:

View File

@@ -1,21 +1,20 @@
get:
summary: List SSO providers
description: List the SSO providers.
summary: Authenticated using an OAuth provider
description: Start OAuth flow using the specified provider
tags:
- Authentication
operationId: ssoProvider
operationId: oauthProvider
parameters:
- name: provider
in: path
description: Key of the activated SSO provider.
description: Key of the activated OAuth provider.
required: true
schema:
type: string
- $ref: "../../openapi.yaml#/components/parameters/Mode"
- name: redirect_url
- name: redirect
in: query
required: true
description: Where to redirect on successful login.
required: false
description: Where to redirect on successful login.<br/>If set the authentication details are set inside cookies otherwise a JSON is returned.
schema:
type: string
responses:

View File

@@ -1,9 +1,9 @@
get:
tags:
- Authentication
operationId: sso
summary: List SSO Providers
description: List the SSO providers.
operationId: oauth
summary: List OAuth Providers
description: List configured OAuth providers.
responses:
"200":
description: Successful request