chore(docs): Updated API Reference (v2) (#9437)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-10-03 07:48:54 +00:00
committed by GitHub
parent 97c193be1b
commit 21badd069d
894 changed files with 35649 additions and 28168 deletions

View File

@@ -32,6 +32,8 @@ get:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
- name: offset
in: query
description: The number of items to skip when retrieving a list.
@@ -40,6 +42,8 @@ get:
type: number
title: offset
description: The number of items to skip when retrieving a list.
externalDocs:
url: '#pagination'
- name: limit
in: query
description: Limit the number of items returned in the list.
@@ -48,6 +52,8 @@ get:
type: number
title: limit
description: Limit the number of items returned in the list.
externalDocs:
url: '#pagination'
- name: order
in: query
description: >-
@@ -965,7 +971,7 @@ get:
schema:
allOf:
- type: object
description: SUMMARY
description: The paginated list of exchanges.
required:
- limit
- offset
@@ -974,22 +980,27 @@ get:
limit:
type: number
title: limit
description: The exchange's limit.
description: The maximum number of items returned.
offset:
type: number
title: offset
description: The exchange's offset.
description: >-
The number of items skipped before retrieving the returned
items.
count:
type: number
title: count
description: The exchange's count.
description: The total number of items.
- type: object
description: SUMMARY
description: The paginated list of exchanges.
required:
- exchanges
properties:
exchanges:
$ref: ../components/schemas/AdminExchange.yaml
type: array
description: The exchange's exchanges.
items:
$ref: ../components/schemas/AdminExchange.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
@@ -1036,6 +1047,8 @@ post:
if a field is prefixed with `+` it will be added to the default
fields, using `-` will remove it from the default fields. without
prefix it will replace the entire default fields.
externalDocs:
url: '#select-fields-and-relations'
security:
- api_token: []
- cookie_auth: []