diff --git a/.gitignore b/.gitignore index 2243b42c0..6a18b5871 100644 --- a/.gitignore +++ b/.gitignore @@ -24,4 +24,5 @@ navidrome.db-wal tags .gitinfo docker-compose.yml -!contrib/docker-compose.yml \ No newline at end of file +!contrib/docker-compose.yml +/api/openapi.yaml diff --git a/api/parameters/_index.yml b/api/parameters/_index.yml new file mode 100644 index 000000000..d06a9aac7 --- /dev/null +++ b/api/parameters/_index.yml @@ -0,0 +1,24 @@ +pageOffset: + $ref: './query/pageOffset.yml' +pageLimit: + $ref: './query/pageLimit.yml' +filterEquals: + $ref: './query/filterEquals.yml' +filterLessThan: + $ref: './query/filterLessThan.yml' +filterLessOrEqual: + $ref: './query/filterLessOrEqual.yml' +filterGreaterThan: + $ref: './query/filterGreaterThan.yml' +filterGreaterOrEqual: + $ref: './query/filterGreaterOrEqual.yml' +filterContains: + $ref: './query/filterContains.yml' +filterStartsWith: + $ref: './query/filterStartsWith.yml' +filterEndsWith: + $ref: './query/filterEndsWith.yml' +sort: + $ref: './query/sort.yml' +include: + $ref: './query/include.yml' diff --git a/api/parameters/query/filterContains.yml b/api/parameters/query/filterContains.yml new file mode 100644 index 000000000..71cee77c4 --- /dev/null +++ b/api/parameters/query/filterContains.yml @@ -0,0 +1,9 @@ +name: filter[contains] +in: query +description: 'Filter by any property containing text. Usage: filter[contains]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\w+' diff --git a/api/parameters/query/filterEndsWith.yml b/api/parameters/query/filterEndsWith.yml new file mode 100644 index 000000000..390bd5606 --- /dev/null +++ b/api/parameters/query/filterEndsWith.yml @@ -0,0 +1,9 @@ +name: filter[endsWith] +in: query +description: 'Filter by any property that ends with text. Usage: filter[endsWith]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\w+' diff --git a/api/parameters/query/filterEquals.yml b/api/parameters/query/filterEquals.yml new file mode 100644 index 000000000..a523e04b8 --- /dev/null +++ b/api/parameters/query/filterEquals.yml @@ -0,0 +1,9 @@ +name: filter[equals] +in: query +description: 'Filter by any property with an exact match. Usage: filter[equals]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\w+' diff --git a/api/parameters/query/filterGreaterOrEqual.yml b/api/parameters/query/filterGreaterOrEqual.yml new file mode 100644 index 000000000..8a1ed8ec0 --- /dev/null +++ b/api/parameters/query/filterGreaterOrEqual.yml @@ -0,0 +1,9 @@ +name: filter[greaterOrEqual] +in: query +description: 'Filter by any numeric property greater than or equal to a value. Usage: filter[greaterOrEqual]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\d+' diff --git a/api/parameters/query/filterGreaterThan.yml b/api/parameters/query/filterGreaterThan.yml new file mode 100644 index 000000000..009a70d19 --- /dev/null +++ b/api/parameters/query/filterGreaterThan.yml @@ -0,0 +1,9 @@ +name: filter[greaterThan] +in: query +description: 'Filter by any numeric property greater than a value. Usage: filter[greaterThan]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\d+' diff --git a/api/parameters/query/filterLessOrEqual.yml b/api/parameters/query/filterLessOrEqual.yml new file mode 100644 index 000000000..33d029983 --- /dev/null +++ b/api/parameters/query/filterLessOrEqual.yml @@ -0,0 +1,9 @@ +name: filter[lessOrEqual] +in: query +description: 'Filter by any numeric property less than or equal to a value. Usage: filter[lessOrEqual]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\d+' diff --git a/api/parameters/query/filterLessThan.yml b/api/parameters/query/filterLessThan.yml new file mode 100644 index 000000000..5eb0657f6 --- /dev/null +++ b/api/parameters/query/filterLessThan.yml @@ -0,0 +1,9 @@ +name: filter[lessThan] +in: query +description: 'Filter by any numeric property less than a value. Usage: filter[lessThan]=property:value' +required: false +schema: + type: array + items: + type: string + pattern: '^\w+:\d+' diff --git a/api/parameters/query/filterStartsWith.yml b/api/parameters/query/filterStartsWith.yml new file mode 100644 index 000000000..1f7fa0039 --- /dev/null +++ b/api/parameters/query/filterStartsWith.yml @@ -0,0 +1,9 @@ + name: filter[startsWith] + in: query + description: 'Filter by any property that starts with text. Usage: filter[startsWith]=property:value' + required: false + schema: + type: array + items: + type: string + pattern: '^\w+:\w+' diff --git a/api/parameters/query/include.yml b/api/parameters/query/include.yml new file mode 100644 index 000000000..f3b0a579f --- /dev/null +++ b/api/parameters/query/include.yml @@ -0,0 +1,6 @@ +name: include +in: query +description: Related resources to include in the response, separated by commas +required: false +schema: + type: string diff --git a/api/parameters/query/pageLimit.yml b/api/parameters/query/pageLimit.yml new file mode 100644 index 000000000..7f49946cf --- /dev/null +++ b/api/parameters/query/pageLimit.yml @@ -0,0 +1,9 @@ +name: page[limit] +in: query +description: The number of items per page +required: false +schema: + type: integer + format: int32 + minimum: 0 + default: 10 diff --git a/api/parameters/query/pageOffset.yml b/api/parameters/query/pageOffset.yml new file mode 100644 index 000000000..831f6b914 --- /dev/null +++ b/api/parameters/query/pageOffset.yml @@ -0,0 +1,9 @@ +name: page[offset] +in: query +description: The offset for pagination +required: false +schema: + type: integer + format: int32 + minimum: 0 + default: 0 diff --git a/api/parameters/query/sort.yml b/api/parameters/query/sort.yml new file mode 100644 index 000000000..99e439df4 --- /dev/null +++ b/api/parameters/query/sort.yml @@ -0,0 +1,6 @@ +name: sort +in: query +description: Sort the results by one or more properties, separated by commas. Prefix the property with '-' for descending order. +required: false +schema: + type: string diff --git a/api/paths/albums.yml b/api/paths/albums.yml deleted file mode 100644 index 7e95ce18a..000000000 --- a/api/paths/albums.yml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: Retrieve a list of albums - operationId: getAlbums - parameters: - - $ref: '../spec.yml#/components/parameters/pageLimit' - - $ref: '../spec.yml#/components/parameters/pageOffset' - - $ref: '../spec.yml#/components/parameters/filterEquals' - - $ref: '../spec.yml#/components/parameters/filterContains' - - $ref: '../spec.yml#/components/parameters/filterLessThan' - - $ref: '../spec.yml#/components/parameters/filterLessOrEqual' - - $ref: '../spec.yml#/components/parameters/filterGreaterThan' - - $ref: '../spec.yml#/components/parameters/filterGreaterOrEqual' - - $ref: '../spec.yml#/components/parameters/filterStartsWith' - - $ref: '../spec.yml#/components/parameters/filterEndsWith' - - $ref: '../spec.yml#/components/parameters/sort' - - $ref: '../spec.yml#/components/parameters/include' - responses: - '200': - description: A list of albums - content: - application/vnd.api+json: - schema: - type: object - required: [data, links] - properties: - data: - type: array - items: - $ref: '../spec.yml#/components/schemas/Album' - links: - $ref: '../spec.yml#/components/schemas/PaginationLinks' - meta: - $ref: '../spec.yml#/components/schemas/PaginationMeta' - '400': - $ref: '../spec.yml#/components/responses/BadRequest' - '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' - '500': - $ref: '../spec.yml#/components/responses/InternalServerError' diff --git a/api/paths/artists.yml b/api/paths/artists.yml deleted file mode 100644 index 17f32feb0..000000000 --- a/api/paths/artists.yml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: Retrieve a list of artists - operationId: getArtists - parameters: - - $ref: '../spec.yml#/components/parameters/pageLimit' - - $ref: '../spec.yml#/components/parameters/pageOffset' - - $ref: '../spec.yml#/components/parameters/filterEquals' - - $ref: '../spec.yml#/components/parameters/filterContains' - - $ref: '../spec.yml#/components/parameters/filterLessThan' - - $ref: '../spec.yml#/components/parameters/filterLessOrEqual' - - $ref: '../spec.yml#/components/parameters/filterGreaterThan' - - $ref: '../spec.yml#/components/parameters/filterGreaterOrEqual' - - $ref: '../spec.yml#/components/parameters/filterStartsWith' - - $ref: '../spec.yml#/components/parameters/filterEndsWith' - - $ref: '../spec.yml#/components/parameters/sort' - - $ref: '../spec.yml#/components/parameters/include' - responses: - '200': - description: A list of artists - content: - application/vnd.api+json: - schema: - type: object - required: [data, links] - properties: - data: - type: array - items: - $ref: '../spec.yml#/components/schemas/Artist' - links: - $ref: '../spec.yml#/components/schemas/PaginationLinks' - meta: - $ref: '../spec.yml#/components/schemas/PaginationMeta' - '400': - $ref: '../spec.yml#/components/responses/BadRequest' - '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' - '500': - $ref: '../spec.yml#/components/responses/InternalServerError' diff --git a/api/paths/tracks.yml b/api/paths/tracks.yml deleted file mode 100644 index 3a2a11fc8..000000000 --- a/api/paths/tracks.yml +++ /dev/null @@ -1,39 +0,0 @@ -get: - summary: Get a list of tracks - operationId: getTracks - parameters: - - $ref: '../spec.yml#/components/parameters/pageLimit' - - $ref: '../spec.yml#/components/parameters/pageOffset' - - $ref: '../spec.yml#/components/parameters/filterEquals' - - $ref: '../spec.yml#/components/parameters/filterContains' - - $ref: '../spec.yml#/components/parameters/filterLessThan' - - $ref: '../spec.yml#/components/parameters/filterLessOrEqual' - - $ref: '../spec.yml#/components/parameters/filterGreaterThan' - - $ref: '../spec.yml#/components/parameters/filterGreaterOrEqual' - - $ref: '../spec.yml#/components/parameters/filterStartsWith' - - $ref: '../spec.yml#/components/parameters/filterEndsWith' - - $ref: '../spec.yml#/components/parameters/sort' - - $ref: '../spec.yml#/components/parameters/include' - responses: - '200': - description: A list of tracks - content: - application/vnd.api+json: - schema: - type: object - required: [data, links] - properties: - data: - type: array - items: - $ref: '../spec.yml#/components/schemas/Track' - links: - $ref: '../spec.yml#/components/schemas/PaginationLinks' - meta: - $ref: '../spec.yml#/components/schemas/PaginationMeta' - '400': - $ref: '../spec.yml#/components/responses/BadRequest' - '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' - '500': - $ref: '../spec.yml#/components/responses/InternalServerError' diff --git a/api/paths/album.yml b/api/resources/album.yml similarity index 61% rename from api/paths/album.yml rename to api/resources/album.yml index 7dfb7b953..c04ee0b35 100644 --- a/api/paths/album.yml +++ b/api/resources/album.yml @@ -2,7 +2,7 @@ get: summary: Retrieve an individual album operationId: getAlbum parameters: - - $ref: '../spec.yml#/components/parameters/include' + - $ref: '../parameters/query/include.yml' - name: albumId in: path description: The unique identifier of the album @@ -19,10 +19,10 @@ get: required: [data] properties: data: - $ref: '../spec.yml#/components/schemas/Album' + $ref: '../schemas/Album.yml' '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' + $ref: '../responses/NotAuthorized.yml' '404': - $ref: '../spec.yml#/components/responses/NotFound' + $ref: '../responses/NotFound.yml' '500': - $ref: '../spec.yml#/components/responses/InternalServerError' + $ref: '../responses/InternalServerError.yml' diff --git a/api/resources/albums.yml b/api/resources/albums.yml new file mode 100644 index 000000000..d3beedb08 --- /dev/null +++ b/api/resources/albums.yml @@ -0,0 +1,39 @@ +get: + summary: Retrieve a list of albums + operationId: getAlbums + 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' + - $ref: '../parameters/query/include.yml' + responses: + '200': + description: A list of albums + content: + application/vnd.api+json: + schema: + type: object + required: [data, links] + properties: + data: + type: array + items: + $ref: '../schemas/Album.yml' + links: + $ref: '../schemas/PaginationLinks.yml' + meta: + $ref: '../schemas/PaginationMeta.yml' + '400': + $ref: '../responses/BadRequest.yml' + '403': + $ref: '../responses/NotAuthorized.yml' + '500': + $ref: '../responses/InternalServerError.yml' diff --git a/api/paths/artist.yml b/api/resources/artist.yml similarity index 61% rename from api/paths/artist.yml rename to api/resources/artist.yml index 7bf4ed8eb..b600c8716 100644 --- a/api/paths/artist.yml +++ b/api/resources/artist.yml @@ -2,7 +2,7 @@ get: summary: Retrieve an individual artist operationId: getArtist parameters: - - $ref: '../spec.yml#/components/parameters/include' + - $ref: '../parameters/query/include.yml' - name: artistId in: path description: The unique identifier of the artist @@ -19,10 +19,10 @@ get: required: [data] properties: data: - $ref: '../spec.yml#/components/schemas/Artist' + $ref: '../schemas/Artist.yml' '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' + $ref: '../responses/NotAuthorized.yml' '404': - $ref: '../spec.yml#/components/responses/NotFound' + $ref: '../responses/NotFound.yml' '500': - $ref: '../spec.yml#/components/responses/InternalServerError' + $ref: '../responses/InternalServerError.yml' diff --git a/api/resources/artists.yml b/api/resources/artists.yml new file mode 100644 index 000000000..44db745e8 --- /dev/null +++ b/api/resources/artists.yml @@ -0,0 +1,39 @@ +get: + summary: Retrieve a list of artists + operationId: getArtists + 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' + - $ref: '../parameters/query/include.yml' + responses: + '200': + description: A list of artists + content: + application/vnd.api+json: + schema: + type: object + required: [data, links] + properties: + data: + type: array + items: + $ref: '../schemas/Artist.yml' + links: + $ref: '../schemas/PaginationLinks.yml' + meta: + $ref: '../schemas/PaginationMeta.yml' + '400': + $ref: '../responses/BadRequest.yml' + '403': + $ref: '../responses/NotAuthorized.yml' + '500': + $ref: '../responses/InternalServerError.yml' diff --git a/api/paths/server.yml b/api/resources/server.yml similarity index 66% rename from api/paths/server.yml rename to api/resources/server.yml index eeb8c79ba..f57467335 100644 --- a/api/paths/server.yml +++ b/api/resources/server.yml @@ -11,8 +11,8 @@ get: required: [data] properties: data: - $ref: '../spec.yml#/components/schemas/ServerInfo' + $ref: '../schemas/ServerInfo.yml' '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' + $ref: '../responses/NotAuthorized.yml' '500': - $ref: '../spec.yml#/components/responses/InternalServerError' + $ref: '../responses/InternalServerError.yml' diff --git a/api/paths/track.yml b/api/resources/track.yml similarity index 61% rename from api/paths/track.yml rename to api/resources/track.yml index a7c4c8a14..4d2d1c56a 100644 --- a/api/paths/track.yml +++ b/api/resources/track.yml @@ -2,7 +2,7 @@ get: summary: Retrieve an individual track operationId: getTrack parameters: - - $ref: '../spec.yml#/components/parameters/include' + - $ref: '../parameters/query/include.yml' - name: trackId in: path description: The unique identifier of the track @@ -19,10 +19,10 @@ get: required: [data] properties: data: - $ref: '../spec.yml#/components/schemas/Track' + $ref: '../schemas/Track.yml' '403': - $ref: '../spec.yml#/components/responses/NotAuthorized' + $ref: '../responses/NotAuthorized.yml' '404': - $ref: '../spec.yml#/components/responses/NotFound' + $ref: '../responses/NotFound.yml' '500': - $ref: '../spec.yml#/components/responses/InternalServerError' + $ref: '../responses/InternalServerError.yml' diff --git a/api/resources/tracks.yml b/api/resources/tracks.yml new file mode 100644 index 000000000..e13d25613 --- /dev/null +++ b/api/resources/tracks.yml @@ -0,0 +1,39 @@ +get: + summary: Get a list of tracks + 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' + - $ref: '../parameters/query/include.yml' + 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' + '400': + $ref: '../responses/BadRequest.yml' + '403': + $ref: '../responses/NotAuthorized.yml' + '500': + $ref: '../responses/InternalServerError.yml' diff --git a/api/responses/BadRequest.yml b/api/responses/BadRequest.yml new file mode 100644 index 000000000..2b3e88ed7 --- /dev/null +++ b/api/responses/BadRequest.yml @@ -0,0 +1,5 @@ +description: Bad Request +content: + application/vnd.api+json: + schema: + $ref: '../schemas/ErrorList.yml' diff --git a/api/responses/InternalServerError.yml b/api/responses/InternalServerError.yml new file mode 100644 index 000000000..8d0f6bded --- /dev/null +++ b/api/responses/InternalServerError.yml @@ -0,0 +1,5 @@ +description: Internal Server Error +content: + application/vnd.api+json: + schema: + $ref: '../schemas/ErrorList.yml' diff --git a/api/responses/NotAuthorized.yml b/api/responses/NotAuthorized.yml new file mode 100644 index 000000000..70a10441c --- /dev/null +++ b/api/responses/NotAuthorized.yml @@ -0,0 +1,5 @@ +description: Not Authorized +content: + application/vnd.api+json: + schema: + $ref: '../schemas/ErrorList.yml' diff --git a/api/responses/NotFound.yml b/api/responses/NotFound.yml new file mode 100644 index 000000000..426976152 --- /dev/null +++ b/api/responses/NotFound.yml @@ -0,0 +1,5 @@ +description: Not Found +content: + application/vnd.api+json: + schema: + $ref: '../schemas/ErrorList.yml' diff --git a/api/responses/_index.yml b/api/responses/_index.yml new file mode 100644 index 000000000..fe735b55a --- /dev/null +++ b/api/responses/_index.yml @@ -0,0 +1,8 @@ +NotFound: + $ref: './NotFound.yml' +NotAuthorized: + $ref: './NotAuthorized.yml' +BadRequest: + $ref: './BadRequest.yml' +InternalServerError: + $ref: './InternalServerError.yml' diff --git a/api/schemas/Album.yml b/api/schemas/Album.yml new file mode 100644 index 000000000..49c959be8 --- /dev/null +++ b/api/schemas/Album.yml @@ -0,0 +1,20 @@ +allOf: + - $ref: './ResourceObject.yml' + - type: object + properties: + attributes: + $ref: './AlbumAttributes.yml' + relationships: + type: object + properties: + artists: + type: array + items: + $ref: './AlbumArtistRelationship.yml' + tracks: + type: array + items: + $ref: './AlbumTrackRelationship.yml' + required: + - artists + - tracks diff --git a/api/schemas/AlbumArtistRelationship.yml b/api/schemas/AlbumArtistRelationship.yml new file mode 100644 index 000000000..39b688c15 --- /dev/null +++ b/api/schemas/AlbumArtistRelationship.yml @@ -0,0 +1,9 @@ +type: object +properties: + meta: + $ref: './ArtistMetaObject.yml' + data: + $ref: './ResourceObject.yml' +required: + - meta + - data diff --git a/api/schemas/AlbumAttributes.yml b/api/schemas/AlbumAttributes.yml new file mode 100644 index 000000000..e0386adb9 --- /dev/null +++ b/api/schemas/AlbumAttributes.yml @@ -0,0 +1,16 @@ +type: object +properties: + title: + type: string + description: The title of the album + releaseDate: + type: string + format: date + description: The release date of the album + genre: + type: string + description: The genre of the album +required: + - title + - releaseDate + - genre diff --git a/api/schemas/AlbumTrackRelationship.yml b/api/schemas/AlbumTrackRelationship.yml new file mode 100644 index 000000000..a83f5b2b6 --- /dev/null +++ b/api/schemas/AlbumTrackRelationship.yml @@ -0,0 +1,6 @@ +type: object +properties: + data: + $ref: './ResourceObject.yml' +required: + - data diff --git a/api/schemas/Artist.yml b/api/schemas/Artist.yml new file mode 100644 index 000000000..a9b2102bd --- /dev/null +++ b/api/schemas/Artist.yml @@ -0,0 +1,27 @@ +allOf: + - $ref: './ResourceObject.yml' + - type: object + properties: + attributes: + $ref: './ArtistAttributes.yml' + relationships: + type: object + properties: + tracks: + type: object + properties: + data: + type: array + items: + $ref: './ArtistTrackRelationship.yml' + required: + - data + albums: + type: object + properties: + data: + type: array + items: + $ref: './ArtistAlbumRelationship.yml' + required: + - data diff --git a/api/schemas/ArtistAlbumRelationship.yml b/api/schemas/ArtistAlbumRelationship.yml new file mode 100644 index 000000000..39b688c15 --- /dev/null +++ b/api/schemas/ArtistAlbumRelationship.yml @@ -0,0 +1,9 @@ +type: object +properties: + meta: + $ref: './ArtistMetaObject.yml' + data: + $ref: './ResourceObject.yml' +required: + - meta + - data diff --git a/api/schemas/ArtistAttributes.yml b/api/schemas/ArtistAttributes.yml new file mode 100644 index 000000000..2ebbe3729 --- /dev/null +++ b/api/schemas/ArtistAttributes.yml @@ -0,0 +1,8 @@ +type: object +properties: + name: + type: string + description: The name of the artist + bio: + type: string + description: A short biography of the artist diff --git a/api/schemas/ArtistMetaObject.yml b/api/schemas/ArtistMetaObject.yml new file mode 100644 index 000000000..7143815f4 --- /dev/null +++ b/api/schemas/ArtistMetaObject.yml @@ -0,0 +1,6 @@ +type: object +properties: + role: + $ref: './ArtistRole.yml' +required: + - role diff --git a/api/schemas/ArtistRole.yml b/api/schemas/ArtistRole.yml new file mode 100644 index 000000000..61106a350 --- /dev/null +++ b/api/schemas/ArtistRole.yml @@ -0,0 +1,5 @@ +type: string +enum: + - artist + - albumArtist +description: The role of an artist in a track or album diff --git a/api/schemas/ArtistTrackRelationship.yml b/api/schemas/ArtistTrackRelationship.yml new file mode 100644 index 000000000..0c3583e10 --- /dev/null +++ b/api/schemas/ArtistTrackRelationship.yml @@ -0,0 +1,14 @@ +type: object +properties: + meta: + type: object + properties: + role: + $ref: './ArtistRole.yml' + required: + - role + data: + $ref: './ResourceObject.yml' +required: + - meta + - data diff --git a/api/schemas/ErrorList.yml b/api/schemas/ErrorList.yml new file mode 100644 index 000000000..4fbaea236 --- /dev/null +++ b/api/schemas/ErrorList.yml @@ -0,0 +1,7 @@ +type: object +required: [errors] +properties: + errors: + type: array + items: + $ref: './ErrorObject.yml' diff --git a/api/schemas/ErrorObject.yml b/api/schemas/ErrorObject.yml new file mode 100644 index 000000000..db6501970 --- /dev/null +++ b/api/schemas/ErrorObject.yml @@ -0,0 +1,12 @@ +type: object +properties: + id: + type: string + status: + type: string + title: + type: string + detail: + type: string +required: + - errors diff --git a/api/schemas/IncludedResource.yml b/api/schemas/IncludedResource.yml new file mode 100644 index 000000000..db98610a0 --- /dev/null +++ b/api/schemas/IncludedResource.yml @@ -0,0 +1,9 @@ +oneOf: + - $ref: './Track.yml' + - $ref: './Artist.yml' +discriminator: + propertyName: type + mapping: + track: './Track.yml' + album: './Album.yml' + artist: './Artist.yml' diff --git a/api/schemas/PaginationLinks.yml b/api/schemas/PaginationLinks.yml new file mode 100644 index 000000000..31690c6a8 --- /dev/null +++ b/api/schemas/PaginationLinks.yml @@ -0,0 +1,14 @@ +type: object +properties: + first: + type: string + format: uri + prev: + type: string + format: uri + next: + type: string + format: uri + last: + type: string + format: uri diff --git a/api/schemas/PaginationMeta.yml b/api/schemas/PaginationMeta.yml new file mode 100644 index 000000000..877237652 --- /dev/null +++ b/api/schemas/PaginationMeta.yml @@ -0,0 +1,14 @@ +type: object +properties: + currentPage: + type: integer + format: int32 + description: The current page in the collection + totalPages: + type: integer + format: int32 + description: The total number of pages in the collection + totalItems: + type: integer + format: int32 + description: The total number of items in the collection diff --git a/api/schemas/ResourceList.yml b/api/schemas/ResourceList.yml new file mode 100644 index 000000000..45fc844b3 --- /dev/null +++ b/api/schemas/ResourceList.yml @@ -0,0 +1,18 @@ +type: object +properties: + data: + oneOf: + - $ref: './Track.yml' + - $ref: './Album.yml' + - $ref: './Artist.yml' + - type: array + items: + $ref: './ResourceObject.yml' + included: + type: array + items: + $ref: './IncludedResource.yml' + links: + $ref: './PaginationLinks.yml' + meta: + $ref: './PaginationMeta.yml' diff --git a/api/schemas/ResourceObject.yml b/api/schemas/ResourceObject.yml new file mode 100644 index 000000000..adbc88140 --- /dev/null +++ b/api/schemas/ResourceObject.yml @@ -0,0 +1,8 @@ +type: object +required: [id, type] +properties: + id: + type: string + description: The unique identifier for the resource + type: + $ref: './ResourceType.yml' diff --git a/api/schemas/ResourceType.yml b/api/schemas/ResourceType.yml new file mode 100644 index 000000000..70b12e7ec --- /dev/null +++ b/api/schemas/ResourceType.yml @@ -0,0 +1,6 @@ +type: string +description: The type of the resource +enum: + - album + - artist + - track diff --git a/api/schemas/ServerInfo.yml b/api/schemas/ServerInfo.yml new file mode 100644 index 000000000..58e7379e6 --- /dev/null +++ b/api/schemas/ServerInfo.yml @@ -0,0 +1,24 @@ +type: object +required: [server, serverVersion, authRequired, features] +properties: + server: + type: string + description: The name of the server software. + example: "navidrome" + serverVersion: + type: string + description: The version number of the server. + example: "0.60.0" + authRequired: + type: boolean + description: Whether the user has access to the server. + example: true + features: + type: array + description: A list of optional features the server supports. + items: + type: string + enum: + - albums + - artists + - images diff --git a/api/schemas/Track.yml b/api/schemas/Track.yml new file mode 100644 index 000000000..bd730fae7 --- /dev/null +++ b/api/schemas/Track.yml @@ -0,0 +1,8 @@ +allOf: + - $ref: './ResourceObject.yml' + - type: object + properties: + attributes: + $ref: './TrackAttributes.yml' + relationships: + $ref: './TrackRelationships.yml' diff --git a/api/schemas/TrackArtistRelationship.yml b/api/schemas/TrackArtistRelationship.yml new file mode 100644 index 000000000..39b688c15 --- /dev/null +++ b/api/schemas/TrackArtistRelationship.yml @@ -0,0 +1,9 @@ +type: object +properties: + meta: + $ref: './ArtistMetaObject.yml' + data: + $ref: './ResourceObject.yml' +required: + - meta + - data diff --git a/api/schemas/TrackAttributes.yml b/api/schemas/TrackAttributes.yml new file mode 100644 index 000000000..bb238e41d --- /dev/null +++ b/api/schemas/TrackAttributes.yml @@ -0,0 +1,55 @@ +type: object +required: [title, artist, album, albumartist, track, mimetype, duration, channels, bitrate, size] +properties: + title: + type: string + description: The title of the track + artist: # TODO: Remove + type: string + description: The name of the artist who performed the track + albumartist: # TODO: Remove + type: string + description: The primary artist of the album the track belongs to. + album: # TODO Remove + type: string + description: The name of the album the track belongs to + genre: # TODO Remove + type: string + description: The genre of the track. + track: + type: integer + description: The track number within the album. + disc: + type: integer + description: The disc number within a multi-disc album. + year: + type: integer + description: The release year of the track or album. + bpm: + type: integer + description: The beats per minute (BPM) of the track. + recording-mbid: + type: string + description: The MusicBrainz identifier for the recording of the track. + track-mbid: + type: string + description: The MusicBrainz identifier for the track. + comments: + type: string + description: Any additional comments or notes about the track. + mimetype: + type: string + description: The MIME type of the audio file. + duration: + type: number + format: float + description: The duration of the track in seconds + channels: + type: integer + description: The number of audio channels in the track. + bitrate: + type: integer + description: The bitrate of the audio file in kilobits per second (kbps). + size: + type: integer + description: The size of the audio file in bytes. diff --git a/api/schemas/TrackRelationships.yml b/api/schemas/TrackRelationships.yml new file mode 100644 index 000000000..43a69a712 --- /dev/null +++ b/api/schemas/TrackRelationships.yml @@ -0,0 +1,12 @@ +type: object +properties: + artists: + type: array + items: + $ref: './TrackArtistRelationship.yml' + albums: + type: array + items: + $ref: './AlbumTrackRelationship.yml' +required: + - artists diff --git a/api/schemas/_index.yml b/api/schemas/_index.yml new file mode 100644 index 000000000..cb371569f --- /dev/null +++ b/api/schemas/_index.yml @@ -0,0 +1,46 @@ +ServerInfo: + $ref: './ServerInfo.yml' +ResourceObject: + $ref: './ResourceObject.yml' +ResourceType: + $ref: './ResourceType.yml' +ResourceList: + $ref: './ResourceList.yml' +IncludedResource: + $ref: './IncludedResource.yml' +Track: + $ref: './Track.yml' +TrackAttributes: + $ref: './TrackAttributes.yml' +TrackRelationships: + $ref: './TrackRelationships.yml' +TrackArtistRelationship: + $ref: './TrackArtistRelationship.yml' +ArtistRole: + $ref: './ArtistRole.yml' +Artist: + $ref: './Artist.yml' +ArtistAttributes: + $ref: './ArtistAttributes.yml' +ArtistAlbumRelationship: + $ref: './ArtistAlbumRelationship.yml' +ArtistTrackRelationship: + $ref: './ArtistTrackRelationship.yml' +ArtistMetaObject: + $ref: './ArtistMetaObject.yml' +Album: + $ref: './Album.yml' +AlbumAttributes: + $ref: './AlbumAttributes.yml' +AlbumArtistRelationship: + $ref: './AlbumArtistRelationship.yml' +AlbumTrackRelationship: + $ref: './AlbumTrackRelationship.yml' +PaginationLinks: + $ref: './PaginationLinks.yml' +PaginationMeta: + $ref: './PaginationMeta.yml' +ErrorList: + $ref: './ErrorList.yml' +ErrorObject: + $ref: './ErrorObject.yml' diff --git a/api/spec.yml b/api/spec.yml index fa8f3c6f7..9bddd64ac 100644 --- a/api/spec.yml +++ b/api/spec.yml @@ -17,498 +17,24 @@ servers: paths: /server: - $ref: './paths/server.yml' + $ref: './resources/server.yml' /tracks: - $ref: './paths/tracks.yml' + $ref: './resources/tracks.yml' /tracks/{trackId}: - $ref: './paths/track.yml' + $ref: './resources/track.yml' /artists: - $ref: './paths/artists.yml' + $ref: './resources/artists.yml' /artists/{artistId}: - $ref: './paths/artist.yml' + $ref: './resources/artist.yml' /albums: - $ref: './paths/albums.yml' + $ref: './resources/albums.yml' /albums/{albumId}: - $ref: './paths/album.yml' + $ref: './resources/album.yml' components: parameters: - pageOffset: - name: page[offset] - in: query - description: The offset for pagination - required: false - schema: - type: integer - format: int32 - minimum: 0 - default: 0 - pageLimit: - name: page[limit] - in: query - description: The number of items per page - required: false - schema: - type: integer - format: int32 - minimum: 0 - default: 10 - filterEquals: - name: filter[equals] - in: query - description: 'Filter by any property with an exact match. Usage: filter[equals]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\w+' - filterLessThan: - name: filter[lessThan] - in: query - description: 'Filter by any numeric property less than a value. Usage: filter[lessThan]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\d+' - filterLessOrEqual: - name: filter[lessOrEqual] - in: query - description: 'Filter by any numeric property less than or equal to a value. Usage: filter[lessOrEqual]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\d+' - filterGreaterThan: - name: filter[greaterThan] - in: query - description: 'Filter by any numeric property greater than a value. Usage: filter[greaterThan]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\d+' - filterGreaterOrEqual: - name: filter[greaterOrEqual] - in: query - description: 'Filter by any numeric property greater than or equal to a value. Usage: filter[greaterOrEqual]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\d+' - filterContains: - name: filter[contains] - in: query - description: 'Filter by any property containing text. Usage: filter[contains]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\w+' - filterStartsWith: - name: filter[startsWith] - in: query - description: 'Filter by any property that starts with text. Usage: filter[startsWith]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\w+' - filterEndsWith: - name: filter[endsWith] - in: query - description: 'Filter by any property that ends with text. Usage: filter[endsWith]=property:value' - required: false - schema: - type: array - items: - type: string - pattern: '^\w+:\w+' - sort: - name: sort - in: query - description: Sort the results by one or more properties, separated by commas. Prefix the property with '-' for descending order. - required: false - schema: - type: string - include: - name: include - in: query - description: Related resources to include in the response, separated by commas - required: false - schema: - type: string + $ref: './parameters/_index.yml' schemas: - ServerInfo: - type: object - required: [server, serverVersion, authRequired, features] - properties: - server: - type: string - description: The name of the server software. - example: "navidrome" - serverVersion: - type: string - description: The version number of the server. - example: "0.60.0" - authRequired: - type: boolean - description: Whether the user has access to the server. - example: true - features: - type: array - description: A list of optional features the server supports. - items: - type: string - enum: - - albums - - artists - - images - ResourceObject: - type: object - required: [id, type] - properties: - id: - type: string - description: The unique identifier for the resource - type: - $ref: '#/components/schemas/ResourceType' - ResourceType: - type: string - description: The type of the resource - enum: - - album - - artist - - track - ResourceList: - type: object - properties: - data: - oneOf: - - $ref: '#/components/schemas/Track' - - $ref: '#/components/schemas/Album' - - $ref: '#/components/schemas/Artist' - - type: array - items: - $ref: '#/components/schemas/ResourceObject' - included: - type: array - items: - $ref: '#/components/schemas/IncludedResource' - links: - $ref: '#/components/schemas/PaginationLinks' - meta: - $ref: '#/components/schemas/PaginationMeta' - IncludedResource: - oneOf: - - $ref: '#/components/schemas/Track' - - $ref: '#/components/schemas/Artist' - discriminator: - propertyName: type - mapping: - track: '#/components/schemas/Track' - album: '#/components/schemas/Album' - artist: '#/components/schemas/Artist' - Track: - allOf: - - $ref: '#/components/schemas/ResourceObject' - - type: object - properties: - attributes: - $ref: '#/components/schemas/TrackAttributes' - relationships: - $ref: '#/components/schemas/TrackRelationships' - TrackAttributes: - type: object - required: [title, artist, album, albumartist, track, mimetype, duration, channels, bitrate, size] - properties: - title: - type: string - description: The title of the track - artist: # TODO: Remove - type: string - description: The name of the artist who performed the track - albumartist: # TODO: Remove - type: string - description: The primary artist of the album the track belongs to. - album: # TODO Remove - type: string - description: The name of the album the track belongs to - genre: # TODO Remove - type: string - description: The genre of the track. - track: - type: integer - description: The track number within the album. - disc: - type: integer - description: The disc number within a multi-disc album. - year: - type: integer - description: The release year of the track or album. - bpm: - type: integer - description: The beats per minute (BPM) of the track. - recording-mbid: - type: string - description: The MusicBrainz identifier for the recording of the track. - track-mbid: - type: string - description: The MusicBrainz identifier for the track. - comments: - type: string - description: Any additional comments or notes about the track. - mimetype: - type: string - description: The MIME type of the audio file. - duration: - type: number - format: float - description: The duration of the track in seconds - channels: - type: integer - description: The number of audio channels in the track. - bitrate: - type: integer - description: The bitrate of the audio file in kilobits per second (kbps). - size: - type: integer - description: The size of the audio file in bytes. - TrackRelationships: - type: object - properties: - artists: - type: array - items: - $ref: '#/components/schemas/TrackArtistRelationship' - albums: - type: array - items: - $ref: '#/components/schemas/AlbumTrackRelationship' - required: - - artists - TrackArtistRelationship: - type: object - properties: - meta: - $ref: '#/components/schemas/ArtistMetaObject' - data: - $ref: '#/components/schemas/ResourceObject' - required: - - meta - - data - ArtistRole: - type: string - enum: - - artist - - albumArtist - description: The role of an artist in a track or album - Artist: - allOf: - - $ref: '#/components/schemas/ResourceObject' - - type: object - properties: - attributes: - $ref: '#/components/schemas/ArtistAttributes' - relationships: - type: object - properties: - tracks: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/ArtistTrackRelationship' - required: - - data - albums: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/ArtistAlbumRelationship' - required: - - data - ArtistAttributes: - type: object - properties: - name: - type: string - description: The name of the artist - bio: - type: string - description: A short biography of the artist - ArtistAlbumRelationship: - type: object - properties: - meta: - $ref: '#/components/schemas/ArtistMetaObject' - data: - $ref: '#/components/schemas/ResourceObject' - required: - - meta - - data - ArtistTrackRelationship: - type: object - properties: - meta: - type: object - properties: - role: - $ref: '#/components/schemas/ArtistRole' - required: - - role - data: - $ref: '#/components/schemas/ResourceObject' - required: - - meta - - data - ArtistMetaObject: - type: object - properties: - role: - $ref: '#/components/schemas/ArtistRole' - required: - - role - Album: - allOf: - - $ref: '#/components/schemas/ResourceObject' - - type: object - properties: - attributes: - $ref: '#/components/schemas/AlbumAttributes' - relationships: - type: object - properties: - artists: - type: array - items: - $ref: '#/components/schemas/AlbumArtistRelationship' - tracks: - type: array - items: - $ref: '#/components/schemas/AlbumTrackRelationship' - required: - - artists - - tracks - AlbumAttributes: - type: object - properties: - title: - type: string - description: The title of the album - releaseDate: - type: string - format: date - description: The release date of the album - genre: - type: string - description: The genre of the album - required: - - title - - releaseDate - - genre - AlbumArtistRelationship: - type: object - properties: - meta: - $ref: '#/components/schemas/ArtistMetaObject' - data: - $ref: '#/components/schemas/ResourceObject' - required: - - meta - - data - AlbumTrackRelationship: - type: object - properties: - data: - $ref: '#/components/schemas/ResourceObject' - required: - - data - PaginationLinks: - type: object - properties: - first: - type: string - format: uri - prev: - type: string - format: uri - next: - type: string - format: uri - last: - type: string - format: uri - PaginationMeta: - type: object - properties: - currentPage: - type: integer - format: int32 - description: The current page in the collection - totalPages: - type: integer - format: int32 - description: The total numeber of pages in the collection - totalItems: - type: integer - format: int32 - description: The total number of items in the collection - ErrorList: - type: object - required: [errors] - properties: - errors: - type: array - items: - $ref: '#/components/schemas/ErrorObject' - ErrorObject: - type: object - properties: - id: - type: string - status: - type: string - title: - type: string - detail: - type: string - required: - - errors + $ref: './schemas/_index.yml' responses: - NotFound: - description: Not Found - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/ErrorList' - NotAuthorized: - description: Not Authorized - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/ErrorList' - BadRequest: - description: Bad Request - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/ErrorList' - InternalServerError: - description: Internal Server Error - content: - application/vnd.api+json: - schema: - $ref: '#/components/schemas/ErrorList' + $ref: './responses/_index.yml' diff --git a/server/api/api.go b/server/api/api.go index 83fb3d82c..304e6c5c6 100644 --- a/server/api/api.go +++ b/server/api/api.go @@ -1,5 +1,6 @@ -//go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -config ./openapi_api.cfg.yaml "../../api/spec.yml" -//go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -config ./openapi_types.cfg.yaml "../../api/spec.yml" +//go:generate npx swagger-cli bundle ../../api/spec.yml --outfile ../../api/openapi.yaml --type yaml +//go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -config ./openapi_api.cfg.yaml "../../api/openapi.yaml" +//go:generate go run github.com/deepmap/oapi-codegen/cmd/oapi-codegen -config ./openapi_types.cfg.yaml "../../api/openapi.yaml" package api diff --git a/server/api/openapi_api.gen.go b/server/api/openapi_api.gen.go index 47fec91a1..d400e53cf 100644 --- a/server/api/openapi_api.gen.go +++ b/server/api/openapi_api.gen.go @@ -1250,52 +1250,52 @@ func (sh *strictHandler) GetTrack(w http.ResponseWriter, r *http.Request, trackI // Base64 encoded, gzipped, json marshaled Swagger object var swaggerSpec = []string{ - "H4sIAAAAAAAC/+xb724buRF/FYItcHe4PclN0n4Q0A/ONRe4iBPDcZsPiQtwd0daXnbJDcmVrRgC+hp9", - "vT5JwSH3n8SVVkqcNEa+xPaSM/Ob4XD+kMwdTWRRSgHCaDq7oyVTrAADCv+a89yA+lUKw7jALynoRPHS", - "cCnojP6G4yReESZWpFSyBGVWJHEEXCyIgVszIf/QbAEz4ti99cP6+q81xWzJ8gpoRLnl+qECtaIRFawA", - "OqObVDSiOsmgYBYPN1B44MaAsuT/evfu5ueZ/YdG1KxKy0MbxcWCrpsPTCm2out15Nk/E6l+w002WkeT", - "MUNApJrccJMF9QTP8zA9G6r70fNDxfLxK4m6MUHgliWGFMwk2ZaWyPFAHR3NvWj4XAEzoF45VfdpKqoC", - "FE9ajReO3K6vIFIRhEqMJIygYpvqL3riDjPDBu1Yc6RHmOMqY+LTbLFbf8v/KOWR8F40fwFaH+sFOWg9", - "2gXyVtBhJugS3psJjlr5Vv8dOh++5g3VvWj72jBljojiGumG47hu+B6mbYfuM0c6LpK8SmFbzUvImYGU", - "KNCyUglo67Z+NuGCmAzsWCmFhohosOnezo9t0i4Kpgc0qgV21diAuY5oyRbwghfcbAO7ysB6WQyKyDlB", - "C5ASFLEkAzLt0NvcsuubL4U5q3JDZ386iehcqoIZRGgeP6IRLbjgRVXQ2UljNy4MLEA1EF/N5xoGMEoc", - "I3OJ0LhgOLYDoCMYQHgEQC1VANprqUy9eFVutF0wKcBGp0IqqB2agw6u6oRcKJjzW2TRT+4//PIDamvl", - "gUhtzSZVCmoyoDTi2+UG64jWHoZO/pSll/ChAo1q2SoOBP7KyjLnCRp4uhTphJX859+1xGDVsv+jgjmd", - "0T9M2zp16kb19JlSUr3g2jixfZM9ZSmpBa8jeibsVmP5a1BLUEj5ZfHUAIhDQByEdURfSnNamUwq/hHS", - "L4vppTSkI9uB+U1W4ivgcGJxCzgSy/E0j+1WuaMsz1/N6eztbiGXPuy9in+HxC77HW13BrIxRvG4Mu6v", - "XaxQ8mk7Hd06RwvojJcufvd5K8O166KaCL9fAhJddjhvB/yIGsWS9wdyvrI0uxmjTh8qrqzfvW0UaORd", - "NwTSG3S99eV6HdEhTbZMlDKz11G21pAW0KUSVZ5vIscZkWO/DboG2Fv7PrAFCAXhjIBDNmnZ2MnQHwMp", - "WkEOTMPfmBlg4yeQlJktbk2OsIPBAoCbfIAvDu2Bt2Etx62POfImGLTetjt9ltXdgDa8guhdXycSoOjD", - "QoG1mB620Lhd7ORaVgdt40EbtlHkk1EdHlwGUK3HhpgBY9xLiNml+TkYNuC8e6PQpiNtgY+53N7lp0Rn", - "tvyLuVwoVmarZre7PRGIF65WC9bgrIB99OtB7B3lt7Ar6ULUfhNe2pmbxkPyYatdyqEAaAmtRrZXxam2", - "z2EEnd3Wx3VMBGEriTrL0chtUh9XrgNGHPL0z+xyX8KKBzpqW6tt4QM7NL4SQU6tzjsjhGc9CGjI8VIw", - "jOeBViSiPA1+1oaZSgeHmky7O4XuwHrRtI0vuAiF2zlXzrJN2q8UD+3inI2bJ+B21LxSwXL/vPVOnc6D", - "XptUSoEwF7aZD25SPwHb/focIpF5Donvr7fa5M3WOKJGGpaf1V4XqITs+NYhw6cIs/rsEwZemtXsSGkh", - "i2/Eiy2LO8/exlUJ/qECwlMQhs85KGzu/ckBchw+YBoXwa7s3M39wNOa7fUOZa68mIA5V2WTljpAm5jt", - "Y3ibsWxUDkZt112fibkMlGWVyS4b1Js43mRgMnDGqjQokjFNWJLgUajEzxqZTyyyW1aUNlIYVUEDI5Yy", - "ByYsjjkwU6mQ+5yS3GYpOScSP7Gc1JM7QoiuylIqo/Egpvb6nkF0YxE8tivQW6/3nh9G1EnYXyDUSOTc", - "3DAFPb2pYEueKlkEHcpR/hOU5lKEBS3dYGfDDliYnkz+cjI52dvWeK02hUf9Ze+sTMhVMd1/lTYDJe/p", - "MvbSX/YoBmppJ+n/uF3fNEW4vxpR4Npp+JurBmPIpVjY3RzyWZzNmj5zm3WpeMHUqi4z9wqZBKXsELBd", - "nJObTJISlM0hkLZSQpxjbtTg8YMfbLhXKZdkznPMxu95LmNu3Im8hkSKlPz4Pi71T5NgcozLAePHwDyX", - "govKAPnx6cX5T7VQRB7mmGRMCMj1vosDh7ueXafbXYxlUdRvGzbCsFgRlqbch+B6om0ZhDSgCYtlZYL8", - "W5unXCdhzHakBn7DTYZNSVHlhv+CQ+g2Ycxppdy1Q5ixH+1Z1VrCLZzuVhzzXLJOg+fgWBFjz7uGNS94", - "AWYwn5+fnT/rJfXW4Sbh47NEqpSLxS9FPFTanFeaJ08V4+JjuL7xLPZj1/zjAG47Et4j8cqADq/X2NO5", - "wZ1r6qQTYICr2/ejJuoMwLEkx9tx2GwrYGr34aad0ffLugGfhOve0LFkv0Gn/cBcG6vjgJ0N0wkkbTz0", - "6z2YaC7HnuV91rP36OD7gqG0PfZYP3AsgFfJrlLG51Wu0/A3fS87BV6lcjqjmTGlnk2nTek3kcqFwQ2P", - "4JroEhLivse+sG0YktOLs4jcZDzJCMtzeaOx4MYyO1byRgNhIiUFE7ZdNBlwRQrrtSTnsbIpeMkZYeTv", - "r1+9nJ1enBESMw0psZ6l5iyBCbFeaUdKJZc8BU1ApKXkNsDPa5/UkXNSHflsqyNS5mxly3ONCFxNHRFm", - "U7p/IIBoSK80m5Bfc47JI2GCKDCKw9JGDReIbbBuk0mvLfX6RP6pAQrVUpn6njfCL3UFQBj2lJroylpO", - "k0QBMzbk2Vkp5IB/NDpMyBsHmWtn8hSWkFvndkjjiueptywrS6czluAcnw5kzKBNF1g6oPrtGjoyV2tH", - "3s4IhWhgBT4ggdsSFAeRABq9WWPfVKG0wCK33fPknd3TPr7Snv/QiC7r9oKeTB5NTqwjyhIEKzmd0ccT", - "1zOUzGS4tabtRl64239rCFyds5TO6HNwx8saidpXkAMdQDtl2j57sPX/iMn+AcKI2b1He6PnNw82R1M0", - "D4UOoqhfV40m6j5GO5ToYGGd50DjLV0/Ax1BgS8hRsyr386srzdeRjw6OTnqmv1Tbm8wpQaSUV6fVe6i", - "3jzaHHlxsnF6GLwZqhGEk9TQAYrf0uuIPnG2DMFobD7tPEVBksf7SfqPM9YR/fMYQaHHJviyoSpsB4kP", - "tXySYFvKrKM6Vk3v8OdZut4btQ4OWo1XRuOOETdumPFpkI2t7csgj5V2V9edjg0/FrrfLTFiJ4y8pdz2", - "QeEb/7aYPM6fnpw8GUXln8fcgwMKwkXKlzytWO7X1/lgW58Oul5z+vg9Y37PmA8zY7q+8+GkTL9lH0jO", - "rLXpBKzpnftlX9qsDxS+TN6spYUSp4f7rWROvyM+JXX6E/QHljtbw0zbK7Yh/+tcVH61pexgOHo5rzr/", - "peC///6PJpaSvIcVKVjp2v3mStevOEk5tvdMrYiCUoG220UsejeAXzvaPAfjsfygySKXMcvxRMetb/uW", - "bmh9r9yM76XR99LogZZG7q78wVRGfkt/g4WRDVVsS482TE3v8OeegujKX6x8kXqovsUJlEMe6zdSDflN", - "cHQxVN+TPaxSyHirNE+BnC+5a6QpK/l0+Yiur9f/CwAA//8K6nqbf0AAAA==", + "H4sIAAAAAAAC/+xbbW8bufH/KgT/f+DucHuSm0v7QkBfONdc4CKODcdtXiQuwN0daXnZJTckV7ZiCOjX", + "6NfrJyk45D5JXGmlxAli5E1sLzkzvxkO54Fk7mkii1IKEEbT2T0tmWIFGFD415znBtRvUhjGBX5JQSeK", + "l4ZLQWf0dxwn8YowsSKlkiUosyKJI+BiQQzcmQn5h2YLmBHH7q0f1jd/rSlmS5ZXQCPKLdcPFagVjahg", + "BdAZ3aSiEdVJBgWzeLiBwgM3BpQl/9e7d7c/z+w/NKJmVVoe2iguFnTdfGBKsRVdryPP/rlI9RtustE6", + "mowZAiLV5JabLKgneJ6H6dlQPYyeHyqWj19J1I0JAncsMaRgJsm2tESOB+roaB5EwxcKmAF14VTdp6mo", + "ClA8aTVeOHK7voJIRRAqMZIwgoptqr/oiTvMDBu0Y82RHmGO64yJT7PFbv0t/6OUR8IH0fwlaH2sF+Sg", + "9WgXyFtBh5mgS/hgJjhq5Vv9d+h8+Jo3VA+i7WvDlDkiimukG47juuF7mLYdus8c6bhI8iqFbTWvIGcG", + "UqJAy0oloK3b+tmEC2IysGOlFBoiosGmezs/tkm7KJge0KgW2FVjA+Y6oiVbwEtecLMN7DoD62UxKCLn", + "BC1ASlDEkgzItENvc8uub74U5qzKDZ396SSic6kKZhCh+fUJjWjBBS+qgs5OGrtxYWABqoF4MZ9rGMAo", + "cYzMJULjguHYDoCOYADhEQC1VAFor6Uy9eJVudF2waQAG50KqaB2aA46uKoTcqlgzu+QRT+5//DLD6it", + "lQcitTWbVCmoyYDSiG+XG6wjWnsYOvkzll7Bhwo0qmWrOBD4KyvLnCdo4OlSpBNW8p//0BKDVcv+/xXM", + "6Yz+37StU6duVE+fKyXVS66NE9s32TOWklrwOqJnwm41lr8GtQSFlF8WTw2AOATEQVhH9JU0p5XJpOIf", + "If2ymF5JQzqyHZjfZSW+Ag4nFreAI7EcT/PYbpV7yvL8Yk5nb3cLufJh7yL+AxK77Pe03RnIxhjF48q4", + "v3axQsmn7XR06xwtoDNeuvjd560M166LaiL8fglIdNXhvB3wI2oUS94fyPna0uxmjDp9qLiyfve2UaCR", + "d9MQSG/Q9daXm3VEhzTZMlHKzF5H2VpDWsB+Kif9HAy7aKF2lUMmkUOwrVetQ889+tgXIBSEkwYO2bxm", + "wytDlw1kcQU5MA1/Y2aAjZ9AUma2uDVpxA4GawRu8gG+OLQH3oa1HLc+5sibYNB62x73WRxgA9rwCqIL", + "fJ1ggaIPixbWYnrYQuM2upNrWR200wdt2AaaT0Z1ePwZQLUeG4UGjPFNRaFNR9oCH3O5vctPic5shRhz", + "uVCszFbNbnd7IhAvXDkXLNNZAfvo14PYO8pvYVfShaj9JryyMzeNh+TDVruSQwHQElqNbDuLU20rxAg6", + "uy2h65gIwhYbdSKkkdukPq7cBIw45Omf2eW+hBUPdNS2nNvCB3ZofLGCnFqdd0YIz3oQ0JDjpWAYzwPd", + "SkR5GvysDTOVDg41mXZ3Ct2B9bLpLF9yEQq3c66cZZu0Xyke2sU5GzdPwN2oeaWC5f556506nQe9NqmU", + "AmEubb8f3KR+Ap4I1EcVicxzSHwLvtVJb3bPETXSsPys9rpAJWTHt84hPkWY1WekMKvYkcJCBt8IF1sG", + "d469DasS/EMFhKcgDJ9zUNj++7MF5Dh8BDUugF3buZvbgac125sdylx7MQFrrsomK3WANiHbh/A2Ydmg", + "HAzarv8+E3MZqMoqk101qDdxvMnAZOCMVWlQJGOasCTBw1KJnzUyn1hkd6wobaAwqoIGRixlDkxYHHNg", + "plIh7zkluU1Sck4kfmI5qSd3hBBdlaVURuNRTe30PYPoxiJ4sFegs97sPWGMqJOwvz6okci5uWUKenpT", + "wZY8VbIIOpSj/CcozaUIC1q6wc4WGrAwPZn85WRysrer8VptCo/6y95ZmZCrYrb/Kl0GSt7TZOylv+pR", + "DJTSTtK33dBvWivcgY0oge00/M3VizHkUizshg+5Nc5mTSe6zbpUvGBqVReie4VMglJ2CNgu38ltJkkJ", + "yqYZSFspIc4xN2rwgMIPNtyrlEsy5znm6/c8lzE37lhfQyJFSn58H5f6p0kwfcblgPFjYJ5LwUVlgPz4", + "7PL8p1ooIg9zTDImBOR63+2Dw13PrjPyLsayKOoHEhuRWqwIS1Puo3Q90TYVQhrQhMWyMkH+rc1TrpMw", + "ZjtSA7/lJsO2pahyw3/BIXSbMOa0Uu7uIszYj/asai3hFk53i5J5LlmnBXRwrIixJ2LDmhe8ADOY8s/P", + "zp/38n7rcJPwAVsiVcrF4pciHqp+zivNk2eKcfExXAJ5Fvuxa/5xALcdCe+ReGVAh9dr7Pnd4M41dV4K", + "MMDV7ftRE3UG4FiS4+04bLYVMLX7+NPO6Ptl3aJPwqVx6OCy38LTfmCujdVxwM6G6QSSNh769R5MNFdj", + "T/s+6wF+dPClw1BmH3s3EDg4wPtoV0zjGy3XjPjrwledGrBSOZ3RzJhSz6bTpjqcSOXC4IZHcE10CQlx", + "32Nf+zYMyenlWURuM55khOW5vNVYk2MlHit5q4EwkZKCCdtQmgy4IoX1WpLzWNkUvOSMMPL31xevZqeX", + "Z4TETENKrGepOUtgQqxX2pFSySVPQRMQaSm5DfDz2id15JxURz7b6oiUOVvZCl4jAld2R4TZlO5fGSAa", + "0qveJuS3nGPySJggCozisLRRwwViG6zbZNJrXL0+kX+vgEK1VKa+LI7wS10BEIZtpya6spbTJFHAjA15", + "dlYKOeAfjQ4T8sZB5tqZPIUl5Na5HdK44nnqLcvK0umMVTrH9wcZM2jTBZYOqH67ho7MleORtzNCIRpY", + "ga9Q4K4ExUEkgEZv1tj3XSgtsMhtgz15Z/e0j6+05z80osu6A6EnkyeTE+uIsgTBSk5n9NeJaytKZjLc", + "WtN2Iy/cEwJrCFyds5TO6AtwB9AaidqnlANNQjtl2r6dsC3CiMn+FcOI2b2Xf6PnN68+R1M0r40Ooqif", + "aI0m6r5oO5ToYGGdN0XjLV2/JR1Bgc8pRsyrH+CsbzaeVzw5OTnqrv5T7ncwpQaSUV6fZu6i3jz8HNkP", + "bpwvBu+OagThJDV0xuK39DqiT50tQzAam08771mQ5Nf9JP0XHuuI/nmMoNCLFXweURW2g8TXXj5JsC1l", + "1lEdq6b3+PMsXe+NWgcHrcYro3EnjRt30Pi+yMbW9nmRx0q7q+sO0IZfHD3slhixE0beY277oPCNf1tM", + "HudPT0+ejqLyb2wewAEF4SLlS55WLPfr63ywrU8HXa85oPyeMb9nzMeZMV3f+XhSpt+yjyRn1tp0Atb0", + "3v2yL23WBwpfJm/W0kKJ08P9VjKn3xGfkjr9Cfojy52tYabtLdyQ/3XuMr/aUnYwHL2c153/l/Dff/9H", + "E0tJ3sOKFKx07X5z6+tXnKQc23umVkRBqUDb7SIWvUvCrx1tXoDxWH7QZJHLmOV4ouPWt31tN7S+127G", + "99Loe2n0SEsjd53+aCojv6W/wcLIhiq2pUcbpqb3+HNPQXTtL1a+SD1U3+IEyiGP9RuphvwmOLoYqu/J", + "HlcpZLxVmtdCzpfcNdKUlXy6fELXN+v/BQAA//+BkQ+RxEAAAA==", } // GetSwagger returns the content of the embedded swagger specification file diff --git a/server/api/openapi_types.gen.go b/server/api/openapi_types.gen.go index 0f5ef82a8..8266c20d1 100644 --- a/server/api/openapi_types.gen.go +++ b/server/api/openapi_types.gen.go @@ -44,8 +44,8 @@ type Album struct { // AlbumArtistRelationship defines model for AlbumArtistRelationship. type AlbumArtistRelationship struct { - Data ResourceObject `json:"data"` - Meta interface{} `json:"meta"` + Data ResourceObject `json:"data"` + Meta ArtistMetaObject `json:"meta"` } // AlbumAttributes defines model for AlbumAttributes. @@ -146,7 +146,7 @@ type PaginationMeta struct { // TotalItems The total number of items in the collection TotalItems *int32 `json:"totalItems,omitempty"` - // TotalPages The total numeber of pages in the collection + // TotalPages The total number of pages in the collection TotalPages *int32 `json:"totalPages,omitempty"` } @@ -194,8 +194,8 @@ type Track struct { // TrackArtistRelationship defines model for TrackArtistRelationship. type TrackArtistRelationship struct { - Data ResourceObject `json:"data"` - Meta interface{} `json:"meta"` + Data ResourceObject `json:"data"` + Meta ArtistMetaObject `json:"meta"` } // TrackAttributes defines model for TrackAttributes.