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

@@ -10,6 +10,18 @@ delete:
description: The ID of the Note to delete.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notes_{id}/deleteundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes_{id}/deleteundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Note
responses:
@@ -30,6 +42,18 @@ delete:
type: boolean
description: Whether or not the Note was deleted.
default: true
'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: GetNotesNote
summary: Get Note
@@ -42,6 +66,18 @@ get:
description: The ID of the note to retrieve.
schema:
type: string
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notes_{id}/getundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes_{id}/getundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Note
responses:
@@ -53,6 +89,18 @@ get:
properties:
note:
$ref: ../components/schemas/note.yaml
'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
post:
operationId: PostNotesNote
summary: Updates a Note
@@ -75,6 +123,18 @@ post:
value:
type: string
description: The updated description of the Note.
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/notes_{id}/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/notes_{id}/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Note
responses:
@@ -86,3 +146,15 @@ post:
properties:
note:
$ref: ../components/schemas/note.yaml
'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