e2b7f77ba9
* docs: fix id used in endpoint path in OAS * docs: small fixes to OAS comments * revert changes in core package * undo changes in core files
137 lines
3.9 KiB
YAML
137 lines
3.9 KiB
YAML
post:
|
|
operationId: PostPublishableApiKeySalesChannelsChannelsBatch
|
|
summary: Add sales channel to a publishable api key scope
|
|
description: Assign a batch of sales channels to a publishable api key.
|
|
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:
|
|
required:
|
|
- sales_channel_ids
|
|
properties:
|
|
sales_channel_ids:
|
|
description: The IDs of the sales channels to add to the publishable api key
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the sales channel
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: >-
|
|
../code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/postundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: >-
|
|
../code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/postundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- PublishableApiKey
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
publishable_api_key:
|
|
$ref: ../components/schemas/publishable_api_key.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: DeletePublishableApiKeySalesChannelsChannelsBatch
|
|
summary: Remove sales channel from a publishable api key scope
|
|
description: Remove a batch of sales channels from a publishable api key.
|
|
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:
|
|
required:
|
|
- sales_channel_ids
|
|
properties:
|
|
sales_channel_ids:
|
|
description: >-
|
|
The IDs of the sales channels to delete from the publishable api
|
|
key
|
|
type: array
|
|
items:
|
|
type: object
|
|
required:
|
|
- id
|
|
properties:
|
|
id:
|
|
type: string
|
|
description: The ID of the sales channel
|
|
x-codeSamples:
|
|
- lang: JavaScript
|
|
label: JS Client
|
|
source:
|
|
$ref: >-
|
|
../code_samples/JavaScript/publishable-api-keys_{id}_sales-channels_batch/deleteundefined
|
|
- lang: Shell
|
|
label: cURL
|
|
source:
|
|
$ref: >-
|
|
../code_samples/Shell/publishable-api-keys_{id}_sales-channels_batch/deleteundefined
|
|
security:
|
|
- api_token: []
|
|
- cookie_auth: []
|
|
tags:
|
|
- PublishableApiKey
|
|
responses:
|
|
'200':
|
|
description: OK
|
|
content:
|
|
application/json:
|
|
schema:
|
|
properties:
|
|
publishable_api_key:
|
|
$ref: ../components/schemas/publishable_api_key.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
|