2023-05-21 13:16:49 -04:00
|
|
|
get:
|
2023-05-22 20:45:18 -04:00
|
|
|
summary: Retrieve a list of tracks
|
2023-05-21 13:16:49 -04:00
|
|
|
operationId: getTracks
|
|
|
|
|
parameters:
|
|
|
|
|
- $ref: '../parameters/query/pageLimit.yml'
|
|
|
|
|
- $ref: '../parameters/query/pageOffset.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterEquals.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterContains.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterLessThan.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterLessOrEqual.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterGreaterThan.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterGreaterOrEqual.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterStartsWith.yml'
|
|
|
|
|
- $ref: '../parameters/query/filterEndsWith.yml'
|
|
|
|
|
- $ref: '../parameters/query/sort.yml'
|
2023-05-22 20:45:18 -04:00
|
|
|
- $ref: '../parameters/query/includeForTracks.yml'
|
2023-05-21 13:16:49 -04:00
|
|
|
responses:
|
|
|
|
|
'200':
|
|
|
|
|
description: A list of tracks
|
|
|
|
|
content:
|
|
|
|
|
application/vnd.api+json:
|
|
|
|
|
schema:
|
|
|
|
|
type: object
|
|
|
|
|
required: [data, links]
|
|
|
|
|
properties:
|
|
|
|
|
data:
|
|
|
|
|
type: array
|
|
|
|
|
items:
|
|
|
|
|
$ref: '../schemas/Track.yml'
|
|
|
|
|
links:
|
|
|
|
|
$ref: '../schemas/PaginationLinks.yml'
|
|
|
|
|
meta:
|
|
|
|
|
$ref: '../schemas/PaginationMeta.yml'
|
2023-05-23 18:36:38 -04:00
|
|
|
included:
|
2023-05-23 19:47:00 -04:00
|
|
|
description: Included resources, as requested by the `include` query parameter
|
2023-05-23 18:36:38 -04:00
|
|
|
type: array
|
|
|
|
|
items:
|
|
|
|
|
$ref: '../schemas/IncludedResource.yml'
|
2023-05-21 13:16:49 -04:00
|
|
|
'400':
|
|
|
|
|
$ref: '../responses/BadRequest.yml'
|
|
|
|
|
'403':
|
|
|
|
|
$ref: '../responses/NotAuthorized.yml'
|
|
|
|
|
'500':
|
|
|
|
|
$ref: '../responses/InternalServerError.yml'
|