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

schema

This commit is contained in:
Petitminion 2025-04-27 12:08:30 +02:00
parent 1a9644bedd
commit bd32521cb2
1 changed files with 110 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

223
api/funkwhale_api/common/schema.yml
View File

@ -6929,7 +6929,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v1/playlists/{id}/: /api/v1/playlists/{uuid}/:
get: get:
operationId: get_playlist operationId: get_playlist
parameters: parameters:
@ -6941,10 +6941,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -6972,10 +6972,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7018,10 +7018,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7063,10 +7063,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7076,7 +7076,7 @@ paths:
responses: responses:
'204': '204':
description: No response body description: No response body
/api/v1/playlists/{id}/add/: /api/v1/playlists/{uuid}/add/:
post: post:
operationId: add_to_playlist operationId: add_to_playlist
parameters: parameters:
@ -7088,10 +7088,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7123,7 +7123,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v1/playlists/{id}/albums/: /api/v1/playlists/{uuid}/albums/:
get: get:
operationId: get_playlist_albums operationId: get_playlist_albums
parameters: parameters:
@ -7135,10 +7135,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7155,7 +7155,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v1/playlists/{id}/artists/: /api/v1/playlists/{uuid}/artists/:
get: get:
operationId: get_playlist_artits operationId: get_playlist_artits
parameters: parameters:
@ -7167,10 +7167,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7187,7 +7187,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v1/playlists/{id}/clear/: /api/v1/playlists/{uuid}/clear/:
delete: delete:
operationId: clear_playlist operationId: clear_playlist
parameters: parameters:
@ -7199,10 +7199,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7212,7 +7212,7 @@ paths:
responses: responses:
'204': '204':
description: No response body description: No response body
/api/v1/playlists/{id}/move/: /api/v1/playlists/{uuid}/move/:
post: post:
operationId: reorder_track_in_playlist operationId: reorder_track_in_playlist
parameters: parameters:
@ -7224,10 +7224,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7259,7 +7259,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v1/playlists/{id}/remove/: /api/v1/playlists/{uuid}/remove/:
post: post:
operationId: remove_from_playlist_2 operationId: remove_from_playlist_2
parameters: parameters:
@ -7271,10 +7271,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7317,10 +7317,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -7330,7 +7330,7 @@ paths:
responses: responses:
'204': '204':
description: No response body description: No response body
/api/v1/playlists/{id}/tracks/: /api/v1/playlists/{uuid}/tracks/:
get: get:
operationId: get_playlist_tracks operationId: get_playlist_tracks
parameters: parameters:
@ -7349,12 +7349,6 @@ paths:
enum: enum:
- json - json
- xspf - xspf
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this playlist.
required: true
- in: query - in: query
name: name name: name
schema: schema:
@ -7397,6 +7391,12 @@ paths:
name: track name: track
schema: schema:
type: integer type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags: tags:
- playlists - playlists
security: security:
@ -16474,7 +16474,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v2/playlists/{id}/: /api/v2/playlists/{uuid}/:
get: get:
operationId: get_playlist_2 operationId: get_playlist_2
parameters: parameters:
@ -16486,10 +16486,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16517,10 +16517,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16563,10 +16563,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16608,10 +16608,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16621,7 +16621,7 @@ paths:
responses: responses:
'204': '204':
description: No response body description: No response body
/api/v2/playlists/{id}/add/: /api/v2/playlists/{uuid}/add/:
post: post:
operationId: add_to_playlist_2 operationId: add_to_playlist_2
parameters: parameters:
@ -16633,10 +16633,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16668,7 +16668,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v2/playlists/{id}/albums/: /api/v2/playlists/{uuid}/albums/:
get: get:
operationId: get_playlist_albums_2 operationId: get_playlist_albums_2
parameters: parameters:
@ -16680,10 +16680,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16700,7 +16700,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v2/playlists/{id}/artists/: /api/v2/playlists/{uuid}/artists/:
get: get:
operationId: get_playlist_artits_2 operationId: get_playlist_artits_2
parameters: parameters:
@ -16712,10 +16712,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16732,7 +16732,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v2/playlists/{id}/clear/: /api/v2/playlists/{uuid}/clear/:
delete: delete:
operationId: clear_playlist_2 operationId: clear_playlist_2
parameters: parameters:
@ -16744,10 +16744,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16757,7 +16757,7 @@ paths:
responses: responses:
'204': '204':
description: No response body description: No response body
/api/v2/playlists/{id}/move/: /api/v2/playlists/{uuid}/move/:
post: post:
operationId: reorder_track_in_playlist_2 operationId: reorder_track_in_playlist_2
parameters: parameters:
@ -16769,10 +16769,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16804,7 +16804,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/Playlist' $ref: '#/components/schemas/Playlist'
description: '' description: ''
/api/v2/playlists/{id}/remove/: /api/v2/playlists/{uuid}/remove/:
post: post:
operationId: remove_from_playlist_4 operationId: remove_from_playlist_4
parameters: parameters:
@ -16816,10 +16816,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16862,10 +16862,10 @@ paths:
- json - json
- xspf - xspf
- in: path - in: path
name: id name: uuid
schema: schema:
type: integer type: string
description: A unique integer value identifying this playlist. format: uuid
required: true required: true
tags: tags:
- playlists - playlists
@ -16875,7 +16875,7 @@ paths:
responses: responses:
'204': '204':
description: No response body description: No response body
/api/v2/playlists/{id}/tracks/: /api/v2/playlists/{uuid}/tracks/:
get: get:
operationId: get_playlist_tracks_2 operationId: get_playlist_tracks_2
parameters: parameters:
@ -16894,12 +16894,6 @@ paths:
enum: enum:
- json - json
- xspf - xspf
- in: path
name: id
schema:
type: integer
description: A unique integer value identifying this playlist.
required: true
- in: query - in: query
name: name name: name
schema: schema:
@ -16942,6 +16936,12 @@ paths:
name: track name: track
schema: schema:
type: integer type: integer
- in: path
name: uuid
schema:
type: string
format: uuid
required: true
tags: tags:
- playlists - playlists
security: security:
@ -20659,32 +20659,18 @@ components:
format: date-time format: date-time
readOnly: true readOnly: true
nullable: true nullable: true
type:
type: string
readOnly: true
object:
oneOf:
- $ref: '#/components/schemas/Artist'
- $ref: '#/components/schemas/Album'
- $ref: '#/components/schemas/Track'
- $ref: '#/components/schemas/APIActor'
- $ref: '#/components/schemas/Channel'
- $ref: '#/components/schemas/Playlist'
readOnly: true
required: required:
- actor - actor
- creation_date - creation_date
- detail - detail
- fetch_date - fetch_date
- id - id
- object
- status - status
- type
- url - url
FetchRequest: FetchRequest:
type: object type: object
properties: properties:
object_uri: object:
type: string type: string
writeOnly: true writeOnly: true
minLength: 1 minLength: 1
@ -20693,7 +20679,7 @@ components:
writeOnly: true writeOnly: true
default: false default: false
required: required:
- object_uri - object
FetchStatusEnum: FetchStatusEnum:
enum: enum:
- pending - pending
@ -24813,8 +24799,13 @@ components:
Playlist: Playlist:
type: object type: object
properties: properties:
id: uuid:
type: integer type: string
format: uuid
readOnly: true
fid:
type: string
format: uri
readOnly: true readOnly: true
name: name:
type: string type: string
@ -24851,16 +24842,22 @@ components:
type: string type: string
nullable: true nullable: true
maxLength: 5000 maxLength: 5000
library:
type: string
format: uri
readOnly: true
required: required:
- actor - actor
- album_covers - album_covers
- creation_date - creation_date
- duration - duration
- id - fid
- is_playable - is_playable
- library
- modification_date - modification_date
- name - name
- tracks_count - tracks_count
- uuid
PlaylistAddManyRequest: PlaylistAddManyRequest:
type: object type: object
properties: properties: