Update releases and tracks examples
This commit is contained in:
parent
7be06396a7
commit
e2158adc25
|
@ -300,6 +300,28 @@ paths:
|
||||||
$ref: "#/components/schemas/SimpleRelease"
|
$ref: "#/components/schemas/SimpleRelease"
|
||||||
"401":
|
"401":
|
||||||
$ref: "#/components/responses/Unauthorized"
|
$ref: "#/components/responses/Unauthorized"
|
||||||
|
/api/v2/releases/{guid}:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Releases
|
||||||
|
summary: Retrieve a specific release from the server
|
||||||
|
description: Retrieve a specific release from the server
|
||||||
|
operationId: getRelease
|
||||||
|
parameters:
|
||||||
|
- name: guid
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
description: The GUID of the collection
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
responses:
|
||||||
|
"200":
|
||||||
|
description: Successful operation
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: "#/components/schemas/SimpleRelease"
|
||||||
/api/v2/release-groups:
|
/api/v2/release-groups:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
|
@ -670,6 +692,7 @@ components:
|
||||||
- createdDate
|
- createdDate
|
||||||
- user
|
- user
|
||||||
- recording
|
- recording
|
||||||
|
- actor
|
||||||
properties:
|
properties:
|
||||||
guid:
|
guid:
|
||||||
type: string
|
type: string
|
||||||
|
@ -681,8 +704,12 @@ components:
|
||||||
description: "The date on which the listening was recorded"
|
description: "The date on which the listening was recorded"
|
||||||
recording:
|
recording:
|
||||||
$ref: "#/components/schemas/SimpleRecording"
|
$ref: "#/components/schemas/SimpleRecording"
|
||||||
|
release:
|
||||||
|
$ref: "#/components/schemas/SimpleRelease"
|
||||||
user:
|
user:
|
||||||
$ref: "#/components/schemas/SimpleUser"
|
$ref: "#/components/schemas/SimpleUser"
|
||||||
|
actor:
|
||||||
|
$ref: "#/components/schemas/SimpleActor"
|
||||||
Pagination:
|
Pagination:
|
||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
|
@ -721,10 +748,6 @@ components:
|
||||||
format: uuid
|
format: uuid
|
||||||
downloadsCount:
|
downloadsCount:
|
||||||
type: integer
|
type: integer
|
||||||
discNumber:
|
|
||||||
type: integer
|
|
||||||
position:
|
|
||||||
type: integer
|
|
||||||
attributedTo:
|
attributedTo:
|
||||||
$ref: "#/components/schemas/SimpleActor"
|
$ref: "#/components/schemas/SimpleActor"
|
||||||
collections:
|
collections:
|
||||||
|
@ -738,12 +761,12 @@ components:
|
||||||
required:
|
required:
|
||||||
- artistCredit
|
- artistCredit
|
||||||
- creationDate
|
- creationDate
|
||||||
- recordingCount
|
- trackCount
|
||||||
- duration
|
- duration
|
||||||
- attributedTo
|
- attributedTo
|
||||||
- local
|
- local
|
||||||
- releaseGroup
|
- releaseGroup
|
||||||
- recordings
|
- tracks
|
||||||
properties:
|
properties:
|
||||||
artistCredit:
|
artistCredit:
|
||||||
$ref: "specs/multi-artist/schema.yml#/ArtistCredit"
|
$ref: "specs/multi-artist/schema.yml#/ArtistCredit"
|
||||||
|
@ -753,7 +776,7 @@ components:
|
||||||
releaseDate:
|
releaseDate:
|
||||||
type: string
|
type: string
|
||||||
format: date
|
format: date
|
||||||
recordingCount:
|
trackCount:
|
||||||
type: integer
|
type: integer
|
||||||
duration:
|
duration:
|
||||||
type: integer
|
type: integer
|
||||||
|
@ -763,10 +786,10 @@ components:
|
||||||
type: boolean
|
type: boolean
|
||||||
releaseGroup:
|
releaseGroup:
|
||||||
$ref: "#/components/schemas/SimpleReleaseGroup"
|
$ref: "#/components/schemas/SimpleReleaseGroup"
|
||||||
recordings:
|
tracks:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/SimpleRecording"
|
$ref: "#/components/schemas/Track"
|
||||||
collections:
|
collections:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
@ -862,8 +885,6 @@ components:
|
||||||
type: boolean
|
type: boolean
|
||||||
local:
|
local:
|
||||||
type: boolean
|
type: boolean
|
||||||
release:
|
|
||||||
$ref: "#/components/schemas/SimpleRelease"
|
|
||||||
artistCredit:
|
artistCredit:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
@ -929,6 +950,21 @@ components:
|
||||||
type: string
|
type: string
|
||||||
avatar:
|
avatar:
|
||||||
$ref: "#/components/schemas/CoverUrls"
|
$ref: "#/components/schemas/CoverUrls"
|
||||||
|
Track:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- recording
|
||||||
|
properties:
|
||||||
|
recording:
|
||||||
|
type: string
|
||||||
|
format: uuid
|
||||||
|
description: "The unique ID of the recording associated with the track"
|
||||||
|
entryNumber:
|
||||||
|
type: integer
|
||||||
|
description: "The disc or chapter the track is contained in"
|
||||||
|
position:
|
||||||
|
type: integer
|
||||||
|
description: "The position of the track in the disc or chapter"
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
oauth2:
|
oauth2:
|
||||||
type: oauth2
|
type: oauth2
|
||||||
|
|
Loading…
Reference in New Issue