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

2025-03-06 13:05:50 +02:00
parent 3616003145
commit 08ce70a368
20 changed files with 228 additions and 58 deletions
@@ -3,7 +3,7 @@
 * operationId: DeleteInvitesId
 * summary: Delete Invite
 * description: Delete an invite.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: id
 *     in: path
@@ -56,6 +56,10 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: deleteInvitesWorkflow
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: DeleteUsersId
 * summary: Delete a User
 * description: Delete a user.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: id
 *     in: path
@@ -37,6 +37,9 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: removeUserAccountWorkflow
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: GetInvites
 * summary: List Invites
 * 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
@@ -512,6 +512,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: GetInvitesId
 * summary: Get an Invite
 * 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
@@ -48,6 +48,10 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: GetUsers
 * summary: List Users
 * 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
@@ -474,6 +474,9 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: GetUsersId
 * summary: Get a User
 * 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
@@ -48,6 +48,9 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * 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
@@ -42,6 +42,9 @@
 *     $ref: "#/components/responses/invalid_request_error"
 *   "500":
 *     $ref: "#/components/responses/500_error"
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: PostInvites
 * summary: Create Invite
 * description: Create a invite.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: fields
 *     in: query
@@ -65,6 +65,10 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: createInvitesWorkflow
+ * security:
+ *   - api_token: []
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

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

@@ -6,7 +6,7 @@
 *   Accept an invite and create a new user.
 * 
 *   Since the user isn't created yet, the JWT token used in the authorization 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:
@@ -76,6 +76,9 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: acceptInviteWorkflow
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */

@@ -3,7 +3,7 @@
 * operationId: PostUsersId
 * summary: Update a User
 * description: Update a user's details.
- * x-authenticated: false
+ * x-authenticated: true
 * parameters:
 *   - name: id
 *     in: path
@@ -61,6 +61,9 @@
 *   "500":
 *     $ref: "#/components/responses/500_error"
 * x-workflow: updateUsersWorkflow
+ * security:
+ *   - cookie_auth: []
+ *   - jwt_token: []
 * 
 */