chore(docs): Generated API Reference (#2143)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2022-09-05 10:23:46 +03:00
committed by GitHub
parent 4961aece1c
commit a1350bfaec
662 changed files with 51365 additions and 29004 deletions

View File

@@ -5,6 +5,15 @@ post:
Logs a Customer in and authorizes them to view their details. Successful
authentication will set a session cookie in the Customer's browser.
parameters: []
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/postundefined
tags:
- Auth
responses:
@@ -16,6 +25,18 @@ post:
properties:
customer:
$ref: ../components/schemas/customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/incorrect_credentials.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
@@ -35,16 +56,47 @@ delete:
operationId: DeleteAuth
summary: Log out
description: Destroys a Customer's authenticated session.
x-authenticated: true
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/deleteundefined
security:
- cookie_auth: []
tags:
- Auth
responses:
'200':
description: OK
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
get:
operationId: GetAuth
summary: Get Session
description: Gets the currently logged in Customer.
x-authenticated: true
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/getundefined
security:
- cookie_auth: []
tags:
- Auth
responses:
@@ -56,5 +108,15 @@ get:
properties:
customer:
$ref: ../components/schemas/customer.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
description: Unauthorized
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml