mirror of
https://github.com/Sea-Haven-Industries/seahaven-ap.git
synced 2026-10-02 13:13:24 +00:00
fix(api): document only the auth statuses the routes return
This commit is contained in:
parent
b9a384d1c9
commit
26f6f48de8
4 changed files with 7 additions and 36 deletions
|
|
@ -1,5 +1,9 @@
|
|||
# This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
|
||||
# See https://redocly.com/docs/cli/ for more information.
|
||||
#
|
||||
# Intentionally empty for AP-14 foundation. Add justified ignores in the same
|
||||
# style as Sea-Haven-Industries/procurement-ingest when needed.
|
||||
# Login and callback fail with a 302 redirect, or 500 when Cognito is not configured.
|
||||
packages/api/openapi/paths/auth-login.yaml:
|
||||
operation-4xx-response:
|
||||
- '#/get/responses'
|
||||
packages/api/openapi/paths/auth-callback.yaml:
|
||||
operation-4xx-response:
|
||||
- '#/get/responses'
|
||||
|
|
|
|||
|
|
@ -30,14 +30,3 @@ get:
|
|||
responses:
|
||||
"302":
|
||||
description: Redirect to the SPA or the login error page.
|
||||
"400":
|
||||
description: Bad request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas.yaml#/Error
|
||||
example:
|
||||
error:
|
||||
code: VALIDATION_ERROR
|
||||
message: Bad request.
|
||||
correlationId: 11111111-1111-4111-8111-111111111111
|
||||
|
|
|
|||
|
|
@ -17,17 +17,6 @@ get:
|
|||
responses:
|
||||
"302":
|
||||
description: Redirect to Cognito hosted UI.
|
||||
"400":
|
||||
description: Bad request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas.yaml#/Error
|
||||
example:
|
||||
error:
|
||||
code: VALIDATION_ERROR
|
||||
message: Bad request.
|
||||
correlationId: 11111111-1111-4111-8111-111111111111
|
||||
"500":
|
||||
description: Cognito is not configured.
|
||||
content:
|
||||
|
|
|
|||
|
|
@ -19,14 +19,3 @@ post:
|
|||
code: FORBIDDEN
|
||||
message: Origin is not allowed.
|
||||
correlationId: 11111111-1111-4111-8111-111111111111
|
||||
"400":
|
||||
description: Bad request.
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: ../components/schemas.yaml#/Error
|
||||
example:
|
||||
error:
|
||||
code: VALIDATION_ERROR
|
||||
message: Bad request.
|
||||
correlationId: 11111111-1111-4111-8111-111111111111
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue