keitaro-api-skill/references/paths/traffic_sources_id_.yaml

97 lines
2.2 KiB
YAML

get:
tags:
- Traffic sources
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Traffic source ID
required: true
schema:
type: integer
summary: Get traffic source
description: Returns traffic source details.
responses:
'200':
description: Traffic source details
content:
application/json:
schema:
$ref: ../schemas/Source.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml
put:
tags:
- Traffic sources
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Traffic source ID
required: true
schema:
type: integer
summary: Update traffic source
description: Updates traffic source.
requestBody:
description: Traffic source fields to update
required: true
content:
application/json:
schema:
$ref: ../schemas/SourceRequest.yaml
responses:
'200':
description: Traffic source details
content:
application/json:
schema:
$ref: ../schemas/Source.yaml
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml
delete:
tags:
- Traffic sources
security:
- ApiKeyAuth: []
parameters:
- name: id
in: path
description: Traffic source ID
required: true
schema:
type: integer
summary: Delete traffic source
description: Changes the state to 'deleted'.
responses:
'200':
description: Success
'400':
$ref: ../responses/BadRequest.yaml
'401':
$ref: ../responses/Unauthorized.yaml
'402':
$ref: ../responses/PaymentRequired.yaml
'404':
$ref: ../responses/NotFound.yaml
'500':
$ref: ../responses/InternalError.yaml