docs-util: add exceptions for routes with custom auth middleware (#11755)

This commit is contained in:
Shahed Nasser
2025-03-06 13:05:50 +02:00
committed by GitHub
parent 3616003145
commit 08ce70a368
20 changed files with 228 additions and 58 deletions

View File

@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a list of invites. The invites can be filtered by fields such as
`id`. The invites can also be sorted or paginated.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -589,11 +589,15 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
post:
operationId: PostInvites
summary: Create Invite
description: Create a invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -657,3 +661,7 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: createInvitesWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []

View File

@@ -8,7 +8,7 @@ post:
header is retrieved from the `/auth/user/emailpass/register` API route (or a
provider other than `emailpass`). The user can then authenticate using the
`/auth/user/emailpass` API route.
x-authenticated: false
x-authenticated: true
requestBody:
content:
application/json:
@@ -72,3 +72,6 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: acceptInviteWorkflow
security:
- cookie_auth: []
- jwt_token: []

View File

@@ -4,7 +4,7 @@ get:
description: >-
Retrieve an invite by its ID. You can expand the invite's relations or
select the fields that should be returned.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -56,11 +56,15 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
delete:
operationId: DeleteInvitesId
summary: Delete Invite
description: Delete an invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -114,3 +118,7 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: deleteInvitesWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []

View File

@@ -2,7 +2,7 @@ post:
operationId: PostInvitesIdResend
summary: Refresh Invite Token
description: Refresh the token of an invite.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -55,3 +55,7 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: refreshInviteTokensWorkflow
security:
- api_token: []
- cookie_auth: []
- jwt_token: []

View File

@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a list of users. The users can be filtered by fields such as `id`.
The users can also be sorted or paginated.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -547,3 +547,6 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- cookie_auth: []
- jwt_token: []

View File

@@ -2,7 +2,7 @@ get:
operationId: GetUsersMe
summary: Get Logged-In User
description: Retrieve the logged-in user's details.
x-authenticated: false
x-authenticated: true
parameters:
- name: fields
in: query
@@ -48,3 +48,6 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- cookie_auth: []
- jwt_token: []

View File

@@ -4,7 +4,7 @@ get:
description: >-
Retrieve a user by its ID. You can expand the user's relations or select the
fields that should be returned.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -56,11 +56,14 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
security:
- cookie_auth: []
- jwt_token: []
post:
operationId: PostUsersId
summary: Update a User
description: Update a user's details.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -118,11 +121,14 @@ post:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: updateUsersWorkflow
security:
- cookie_auth: []
- jwt_token: []
delete:
operationId: DeleteUsersId
summary: Delete a User
description: Delete a user.
x-authenticated: false
x-authenticated: true
parameters:
- name: id
in: path
@@ -157,3 +163,6 @@ delete:
'500':
$ref: ../components/responses/500_error.yaml
x-workflow: removeUserAccountWorkflow
security:
- cookie_auth: []
- jwt_token: []