docs(api-reference): added local server to list of servers (#5572)

* docs(api-reference): added local server to list of servers

* fix publishable api key route
This commit is contained in:
Shahed Nasser
2023-11-06 17:30:56 +02:00
committed by GitHub
parent d7e1887221
commit 2576a0fd23
11 changed files with 133 additions and 130 deletions

View File

@@ -1,54 +0,0 @@
post:
operationId: PostPublishableApiKysPublishableApiKey
summary: Update Publishable API Key
description: Update a Publishable API Key's details.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Publishable API Key.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml
x-codegen:
method: update
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_publishable-api-key_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_publishable-api-key_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
tags:
- Publishable Api Keys
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPublishableApiKeysRes.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

View File

@@ -46,6 +46,60 @@ get:
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml
post:
operationId: PostPublishableApiKysPublishableApiKey
summary: Update Publishable API Key
description: Update a Publishable API Key's details.
x-authenticated: true
parameters:
- in: path
name: id
required: true
description: The ID of the Publishable API Key.
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: >-
../components/schemas/AdminPostPublishableApiKeysPublishableApiKeyReq.yaml
x-codegen:
method: update
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_publishable-api-keys_{id}/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_publishable-api-keys_{id}/post.sh
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
tags:
- Publishable Api Keys
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminPublishableApiKeysRes.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
delete:
operationId: DeletePublishableApiKeysPublishableApiKey
summary: Delete Publishable API Key