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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-09 09:50:55 +02:00
committed by GitHub
parent 9997485c55
commit 14b2de94e2
952 changed files with 13745 additions and 9192 deletions

View File

@@ -4,16 +4,22 @@ post:
description: >-
Logs a Customer in and authorizes them to view their details. Successful
authentication will set a session cookie in the Customer's browser.
parameters: []
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/StorePostAuthReq.yaml
x-codegen:
method: authenticate
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/postundefined
$ref: ../code_samples/JavaScript/auth/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/postundefined
$ref: ../code_samples/Shell/auth/post.sh
tags:
- Auth
responses:
@@ -35,31 +41,18 @@ post:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
requestBody:
content:
application/json:
schema:
type: object
required:
- email
- password
properties:
email:
type: string
description: The Customer's email.
password:
type: string
description: The Customer's password.
delete:
operationId: DeleteAuth
summary: Customer Log out
description: Destroys a Customer's authenticated session.
x-authenticated: true
x-codegen:
method: deleteSession
x-codeSamples:
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/deleteundefined
$ref: ../code_samples/Shell/auth/delete.sh
security:
- cookie_auth: []
tags:
@@ -84,15 +77,17 @@ get:
summary: Get Current Customer
description: Gets the currently logged in Customer.
x-authenticated: true
x-codegen:
method: getSession
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/auth/getundefined
$ref: ../code_samples/JavaScript/auth/get.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/auth/getundefined
$ref: ../code_samples/Shell/auth/get.sh
security:
- cookie_auth: []
tags: