MirrorMirror
/
funkwhale
mirror of https://dev.funkwhale.audio/funkwhale/funkwhale.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into develop

This commit is contained in:
Agate 2020-07-11 15:16:13 +02:00
parent 820b53c3b4 0f2b332eb0
commit 6e3656aaeb
2 changed files with 133 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/admin/importing-music.rst
View File

@ -9,7 +9,7 @@ it extensively using a proper tool, such as Beets or Musicbrainz Picard.
Funkwhale supports two different import modes: Funkwhale supports two different import modes:
- copy (the default): files are copied into Funkwhale's internal storage. This means importing a 1GB library will result in the same amount of space being used by Funkwhale. - copy (the default): files are copied into Funkwhale's internal storage. This means importing a 1GB library will result in the same amount of space being used by Funkwhale.
- :ref:`in-place <in-place-import>` (when the ``--in-place`` is provided): files are referenced in Funkwhale's DB but not copied or touched in anyway. This is useful if you have a huge library, or one that is updated by an external tool such as Beets.. - :ref:`in-place <in-place-import>` (when the ``--in-place`` is provided): files are referenced in Funkwhale's DB but not copied or touched in anyway. This is useful if you have a huge library, or one that is updated by an external tool such as Beets.
.. note:: .. note::

264
docs/swagger.yml
View File

@ -204,8 +204,8 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#OAuthApplication" - $ref: "./api/definitions.yml#/OAuthApplication"
- $ref: "./api/definitions.yml#OAuthApplicationCreation" - $ref: "./api/definitions.yml#/OAuthApplicationCreation"
requestBody: requestBody:
required: true required: true
content: content:
@ -322,7 +322,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Me" $ref: "./api/definitions.yml#/Me"
/api/v1/rate-limit/: /api/v1/rate-limit/:
get: get:
@ -335,7 +335,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#RateLimitStatus" $ref: "./api/definitions.yml#/RateLimitStatus"
/api/v1/artists/: /api/v1/artists/:
get: get:
@ -347,9 +347,9 @@ paths:
- "read:libraries" - "read:libraries"
parameters: parameters:
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- allOf: - allOf:
- $ref: "./api/parameters.yml#Ordering" - $ref: "./api/parameters.yml#/Ordering"
- default: "-creation_date" - default: "-creation_date"
schema: schema:
required: false required: false
@ -360,31 +360,31 @@ paths:
- id - id
- name - name
- random - random
- $ref: "./api/parameters/Playable" - $ref: "./api/parameters.yml#/Playable"
- $ref: "./api/parameters/Library" - $ref: "./api/parameters.yml#/Library"
- $ref: "./api/parameters/PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters/PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters/Related" - $ref: "./api/parameters.yml#/Related"
- $ref: "./api/parameters/Scope" - $ref: "./api/parameters.yml#/Scope"
responses: responses:
200: 200:
content: content:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#Artist" $ref: "./api/definitions.yml#/Artist"
/api/v1/artists/{id}/: /api/v1/artists/{id}/:
get: get:
summary: Retrieve a single artist summary: Retrieve a single artist
parameters: parameters:
- $ref: "./api/parameters.yml#ObjectId" - $ref: "./api/parameters.yml#/ObjectId"
- $ref: "./api/parameters.yml#Refresh" - $ref: "./api/parameters.yml#/Refresh"
security: security:
- oauth2: - oauth2:
- "read:libraries" - "read:libraries"
@ -395,12 +395,12 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Artist" $ref: "./api/definitions.yml#/Artist"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/artists/{id}/libraries/: /api/v1/artists/{id}/libraries/:
get: get:
summary: List available user libraries containing work from this artist summary: List available user libraries containing work from this artist
@ -408,9 +408,9 @@ paths:
- oauth2: - oauth2:
- "read:libraries" - "read:libraries"
parameters: parameters:
- $ref: "./api/parameters.yml#ObjectId" - $ref: "./api/parameters.yml#/ObjectId"
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
tags: tags:
- "Library and metadata" - "Library and metadata"
@ -419,12 +419,12 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#LibraryPage" $ref: "./api/definitions.yml#/LibraryPage"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/albums/: /api/v1/albums/:
get: get:
@ -437,7 +437,7 @@ paths:
- "read:libraries" - "read:libraries"
parameters: parameters:
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- name: "artist" - name: "artist"
in: "query" in: "query"
default: null default: null
@ -447,7 +447,7 @@ paths:
type: "integer" type: "integer"
format: "int64" format: "int64"
- allOf: - allOf:
- $ref: "./api/parameters.yml#Ordering" - $ref: "./api/parameters.yml#/Ordering"
- default: "-creation_date" - default: "-creation_date"
schema: schema:
required: false required: false
@ -458,12 +458,12 @@ paths:
- release_date - release_date
- title - title
- random - random
- $ref: "./api/parameters/Library" - $ref: "./api/parameters.yml#/Library"
- $ref: "./api/parameters/Playable" - $ref: "./api/parameters.yml#/Playable"
- $ref: "./api/parameters/PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters/PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters/Related" - $ref: "./api/parameters.yml#/Related"
- $ref: "./api/parameters/Scope" - $ref: "./api/parameters.yml#/Scope"
responses: responses:
200: 200:
@ -471,19 +471,19 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#Album" $ref: "./api/definitions.yml#/Album"
/api/v1/albums/{id}/: /api/v1/albums/{id}/:
get: get:
summary: Retrieve a single album summary: Retrieve a single album
parameters: parameters:
- $ref: "./api/parameters.yml#ObjectId" - $ref: "./api/parameters.yml#/ObjectId"
- $ref: "./api/parameters.yml#Refresh" - $ref: "./api/parameters.yml#/Refresh"
security: security:
- oauth2: - oauth2:
@ -495,20 +495,20 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Album" $ref: "./api/definitions.yml#/Album"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/albums/{id}/libraries/: /api/v1/albums/{id}/libraries/:
get: get:
summary: List available user libraries containing tracks from this album summary: List available user libraries containing tracks from this album
parameters: parameters:
- $ref: "./api/parameters.yml#ObjectId" - $ref: "./api/parameters.yml#/ObjectId"
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
security: security:
- oauth2: - oauth2:
@ -520,12 +520,12 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#LibraryPage" $ref: "./api/definitions.yml#/LibraryPage"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/tracks/: /api/v1/tracks/:
get: get:
@ -538,7 +538,7 @@ paths:
- "read:libraries" - "read:libraries"
parameters: parameters:
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- name: "artist" - name: "artist"
in: "query" in: "query"
default: null default: null
@ -571,7 +571,7 @@ paths:
required: false required: false
type: "string" type: "string"
- allOf: - allOf:
- $ref: "./api/parameters.yml#Ordering" - $ref: "./api/parameters.yml#/Ordering"
- default: "-creation_date" - default: "-creation_date"
schema: schema:
required: false required: false
@ -582,12 +582,12 @@ paths:
- release_date - release_date
- title - title
- random - random
- $ref: "./api/parameters/Library" - $ref: "./api/parameters.yml#/Library"
- $ref: "./api/parameters/Playable" - $ref: "./api/parameters.yml#/Playable"
- $ref: "./api/parameters/PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters/PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters/Related" - $ref: "./api/parameters.yml#/Related"
- $ref: "./api/parameters/Scope" - $ref: "./api/parameters.yml#/Scope"
responses: responses:
200: 200:
@ -595,18 +595,18 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#Track" $ref: "./api/definitions.yml#/Track"
/api/v1/tracks/{id}/: /api/v1/tracks/{id}/:
get: get:
parameters: parameters:
- $ref: "./api/parameters.yml#ObjectId" - $ref: "./api/parameters.yml#/ObjectId"
- $ref: "./api/parameters.yml#Refresh" - $ref: "./api/parameters.yml#/Refresh"
summary: Retrieve a single track summary: Retrieve a single track
security: security:
@ -619,20 +619,20 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Track" $ref: "./api/definitions.yml#/Track"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/tracks/{id}/libraries/: /api/v1/tracks/{id}/libraries/:
get: get:
summary: List available user libraries containing given track summary: List available user libraries containing given track
parameters: parameters:
- $ref: "./api/parameters.yml#ObjectId" - $ref: "./api/parameters.yml#/ObjectId"
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
security: security:
- oauth2: - oauth2:
- "read:libraries" - "read:libraries"
@ -643,12 +643,12 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#LibraryPage" $ref: "./api/definitions.yml#/LibraryPage"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/listen/{uuid}/: /api/v1/listen/{uuid}/:
get: get:
summary: Download the audio file matching the given track uuid summary: Download the audio file matching the given track uuid
@ -680,7 +680,7 @@ paths:
This endpoint support bytess-range requests. This endpoint support bytess-range requests.
schema: schema:
$ref: "./api/properties.yml#transcode_options" $ref: "./api/properties.yml#/transcode_options"
- name: upload - name: upload
in: query in: query
required: false required: false
@ -718,7 +718,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/licenses/: /api/v1/licenses/:
get: get:
@ -729,21 +729,21 @@ paths:
tags: tags:
- "Library and metadata" - "Library and metadata"
parameters: parameters:
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
responses: responses:
200: 200:
content: content:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#License" $ref: "./api/definitions.yml#/License"
/api/v1/licenses/{code}/: /api/v1/licenses/{code}/:
get: get:
@ -767,12 +767,12 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#License" $ref: "./api/definitions.yml#/License"
404: 404:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ResourceNotFound" $ref: "./api/definitions.yml#/ResourceNotFound"
/api/v1/libraries/: /api/v1/libraries/:
get: get:
@ -780,23 +780,23 @@ paths:
tags: tags:
- "Uploads and audio content" - "Uploads and audio content"
parameters: parameters:
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- $ref: "./api/parameters.yml#Scope" - $ref: "./api/parameters.yml#/Scope"
responses: responses:
200: 200:
content: content:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#OwnedLibrary" $ref: "./api/definitions.yml#/OwnedLibrary"
post: post:
tags: tags:
- "Uploads and audio content" - "Uploads and audio content"
@ -812,7 +812,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#OwnedLibraryCreate" $ref: "./api/definitions.yml#/OwnedLibraryCreate"
/api/v1/libraries/{uuid}/: /api/v1/libraries/{uuid}/:
parameters: parameters:
@ -831,7 +831,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#OwnedLibrary" $ref: "./api/definitions.yml#/OwnedLibrary"
post: post:
summary: Update a library summary: Update a library
tags: tags:
@ -841,13 +841,13 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#OwnedLibraryCreate" $ref: "./api/definitions.yml#/OwnedLibraryCreate"
responses: responses:
201: 201:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#OwnedLibrary" $ref: "./api/definitions.yml#/OwnedLibrary"
delete: delete:
summary: Delete a library and all associated uploads summary: Delete a library and all associated uploads
description: | description: |
@ -866,7 +866,7 @@ paths:
- "Channels and subscriptions" - "Channels and subscriptions"
parameters: parameters:
- allOf: - allOf:
- $ref: "#/parameters/Ordering" - $ref: "./api/parameters.yml#/Ordering"
- default: "-creation_date" - default: "-creation_date"
schema: schema:
required: false required: false
@ -876,14 +876,14 @@ paths:
- creation_date - creation_date
- modification_date - modification_date
- random - random
- $ref: "./api/parameters/PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters/PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters/Scope" - $ref: "./api/parameters.yml#/Scope"
- $ref: "./api/parameters/Search" - $ref: "./api/parameters.yml#/Search"
- $ref: "./api/parameters/Tags" - $ref: "./api/parameters.yml#/Tags"
- $ref: "./api/parameters/Subscribed" - $ref: "./api/parameters.yml#/Subscribed"
- $ref: "./api/parameters/External" - $ref: "./api/parameters.yml#/External"
- $ref: "./api/parameters/ChannelOrdering" - $ref: "./api/parameters.yml#/ChannelOrdering"
responses: responses:
200: 200:
@ -891,13 +891,13 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#Channel" $ref: "./api/definitions.yml#/Channel"
post: post:
summary: Create a new channel summary: Create a new channel
tags: tags:
@ -912,7 +912,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ChannelCreate" $ref: "./api/definitions.yml#/ChannelCreate"
/api/v1/channels/metadata-choices: /api/v1/channels/metadata-choices:
summary: List metadata (locales, itunes categories) for creating and editing channels. summary: List metadata (locales, itunes categories) for creating and editing channels.
@ -978,7 +978,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Channel" $ref: "./api/definitions.yml#/Channel"
post: post:
summary: Update a channel summary: Update a channel
tags: tags:
@ -988,13 +988,13 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#ChannelUpdate" $ref: "./api/definitions.yml#/ChannelUpdate"
responses: responses:
201: 201:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Channel" $ref: "./api/definitions.yml#/Channel"
delete: delete:
summary: Delete a channel and all associated uploads summary: Delete a channel and all associated uploads
description: | description: |
@ -1028,7 +1028,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Subscription" $ref: "./api/definitions.yml#/Subscription"
/api/v1/channels/{uuid}/rss/: /api/v1/channels/{uuid}/rss/:
parameters: parameters:
@ -1064,7 +1064,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Subscription" $ref: "./api/definitions.yml#/Subscription"
/api/v1/channels/{uuid}/unsubscribe/: /api/v1/channels/{uuid}/unsubscribe/:
parameters: parameters:
@ -1088,23 +1088,23 @@ paths:
- "Uploads and audio content" - "Uploads and audio content"
parameters: parameters:
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters.yml#Scope" - $ref: "./api/parameters.yml#/Scope"
responses: responses:
200: 200:
content: content:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#OwnedUpload" $ref: "./api/definitions.yml#/OwnedUpload"
post: post:
tags: tags:
- "Uploads and audio content" - "Uploads and audio content"
@ -1145,7 +1145,7 @@ paths:
- "pending" - "pending"
import_metadata: import_metadata:
required: false required: false
$ref: "./api/definitions.yml#ImportMetadata" $ref: "./api/definitions.yml#/ImportMetadata"
/api/v1/subscriptions/{uuid}/: /api/v1/subscriptions/{uuid}/:
@ -1165,7 +1165,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Subscription" $ref: "./api/definitions.yml#/Subscription"
/api/v1/subscriptions/: /api/v1/subscriptions/:
get: get:
@ -1178,13 +1178,13 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#Subscription" $ref: "./api/definitions.yml#/Subscription"
/api/v1/subscriptions/all/: /api/v1/subscriptions/all/:
get: get:
@ -1201,7 +1201,7 @@ paths:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#SubscriptionsAll" $ref: "./api/definitions.yml#/SubscriptionsAll"
/api/v1/uploads/{uuid}/: /api/v1/uploads/{uuid}/:
parameters: parameters:
@ -1220,7 +1220,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#OwnedUpload" $ref: "./api/definitions.yml#/OwnedUpload"
patch: patch:
summary: Update a draft upload summary: Update a draft upload
description: | description: |
@ -1238,7 +1238,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#OwnedUpload" $ref: "./api/definitions.yml#/OwnedUpload"
delete: delete:
summary: Delete an upload summary: Delete an upload
description: | description: |
@ -1275,10 +1275,10 @@ paths:
tags: tags:
- "Content curation" - "Content curation"
parameters: parameters:
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
- $ref: "./api/parameters.yml#Scope" - $ref: "./api/parameters.yml#/Scope"
responses: responses:
200: 200:
@ -1286,13 +1286,13 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#TrackFavorite" $ref: "./api/definitions.yml#/TrackFavorite"
post: post:
summary: Mark the given track as favorite summary: Mark the given track as favorite
tags: tags:
@ -1324,7 +1324,7 @@ paths:
format: "int64" format: "int64"
example: 98 example: 98
creation_date: creation_date:
$ref: "./api/properties.yml#creation_date" $ref: "./api/properties.yml#/creation_date"
/api/v1/favorites/tracks/remove/: /api/v1/favorites/tracks/remove/:
post: post:
summary: Remove the given track from favorites summary: Remove the given track from favorites
@ -1384,7 +1384,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Attachment" $ref: "./api/definitions.yml#/Attachment"
delete: delete:
summary: Delete an attachment summary: Delete an attachment
tags: tags:
@ -1399,9 +1399,9 @@ paths:
tags: tags:
- "Content curation" - "Content curation"
parameters: parameters:
- $ref: "./api/parameters.yml#Search" - $ref: "./api/parameters.yml#/Search"
- allOf: - allOf:
- $ref: "./api/parameters.yml#Ordering" - $ref: "./api/parameters.yml#/Ordering"
- default: "-creation_date" - default: "-creation_date"
schema: schema:
required: false required: false
@ -1430,22 +1430,22 @@ paths:
schema: schema:
type: "integer" type: "integer"
format: "int64" format: "int64"
- $ref: "./api/parameters.yml#Playable" - $ref: "./api/parameters.yml#/Playable"
- $ref: "./api/parameters.yml#PageNumber" - $ref: "./api/parameters.yml#/PageNumber"
- $ref: "./api/parameters.yml#PageSize" - $ref: "./api/parameters.yml#/PageSize"
responses: responses:
200: 200:
content: content:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#Playlist" $ref: "./api/definitions.yml#/Playlist"
post: post:
tags: tags:
- "Content curation" - "Content curation"
@ -1460,7 +1460,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#PlaylistCreate" $ref: "./api/definitions.yml#/PlaylistCreate"
/api/v1/playlists/{id}/: /api/v1/playlists/{id}/:
parameters: parameters:
- name: id - name: id
@ -1478,7 +1478,7 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Playlist" $ref: "./api/definitions.yml#/Playlist"
post: post:
summary: Update a playlist summary: Update a playlist
tags: tags:
@ -1488,13 +1488,13 @@ paths:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#PlaylistCreate" $ref: "./api/definitions.yml#/PlaylistCreate"
responses: responses:
201: 201:
content: content:
application/json: application/json:
schema: schema:
$ref: "./api/definitions.yml#Playlist" $ref: "./api/definitions.yml#/Playlist"
delete: delete:
description: Delete the playlist description: Delete the playlist
tags: tags:
@ -1520,13 +1520,13 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#PlaylistTrack" $ref: "./api/definitions.yml#/PlaylistTrack"
/api/v1/playlists/{id}/add: /api/v1/playlists/{id}/add:
parameters: parameters:
- name: id - name: id
@ -1565,13 +1565,13 @@ paths:
application/json: application/json:
schema: schema:
allOf: allOf:
- $ref: "./api/definitions.yml#ResultPage" - $ref: "./api/definitions.yml#/ResultPage"
- type: "object" - type: "object"
properties: properties:
results: results:
type: "array" type: "array"
items: items:
$ref: "./api/definitions.yml#PlaylistTrack" $ref: "./api/definitions.yml#/PlaylistTrack"
/api/v1/playlists/{id}/clear: /api/v1/playlists/{id}/clear:
parameters: parameters:
- name: id - name: id