kopia lustrzana https://dev.funkwhale.audio/funkwhale/funkwhale
216 wiersze
4.3 KiB
YAML
216 wiersze
4.3 KiB
YAML
ChannelOrdering:
|
|
$ref: "#/Ordering"
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
default: "creation_date"
|
|
example: "creation_date"
|
|
enum:
|
|
- creation_date
|
|
- artist__modification_date
|
|
|
|
PlaylistOrdering:
|
|
$ref: "#/Ordering"
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
default: "creation_date"
|
|
example: "creation_date"
|
|
enum:
|
|
- creation_date
|
|
- modification_date
|
|
- id
|
|
- name
|
|
|
|
ArtistOrdering:
|
|
$ref: "#/Ordering"
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
default: "creation_date"
|
|
example: "creation_date"
|
|
enum:
|
|
- creation_date
|
|
- id
|
|
- name
|
|
- random
|
|
|
|
AlbumOrdering:
|
|
$ref: "#/Ordering"
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
default: "creation_date"
|
|
example: "creation_date"
|
|
enum:
|
|
- creation_date
|
|
- release_date
|
|
- title
|
|
- random
|
|
|
|
TrackOrdering:
|
|
$ref: "#/Ordering"
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
default: "creation_date"
|
|
example: "creation_date"
|
|
enum:
|
|
- creation_date
|
|
- release_date
|
|
- title
|
|
- random
|
|
|
|
External:
|
|
name: "external"
|
|
in: "query"
|
|
required: false
|
|
description: "Filter/exclude channels created from a third-party, non-Funkwhale RSS feed"
|
|
schema:
|
|
default: null
|
|
type: "boolean"
|
|
|
|
|
|
Library:
|
|
name: library
|
|
in: query
|
|
description: Restrict to results contained in the given library
|
|
schema:
|
|
type: string
|
|
format: uuid
|
|
|
|
ObjectId:
|
|
name: id
|
|
in: path
|
|
description: Object ID
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
format: int64
|
|
Ordering:
|
|
name: "ordering"
|
|
in: "query"
|
|
description: "Ordering for the results, prefix with - for DESC ordering"
|
|
|
|
PageNumber:
|
|
in: query
|
|
name: page
|
|
schema:
|
|
type: "integer"
|
|
format: "int64"
|
|
example: 1
|
|
default: 1
|
|
minimum: 1
|
|
PageSize:
|
|
in: query
|
|
name: page_size
|
|
schema:
|
|
type: "integer"
|
|
format: "int64"
|
|
example: 16
|
|
default: 25
|
|
minimum: 1
|
|
maximum: 25
|
|
Playable:
|
|
name: "playable"
|
|
in: "query"
|
|
required: false
|
|
description: "Filter/exclude resources with playable tracks"
|
|
schema:
|
|
default: null
|
|
type: "boolean"
|
|
HasAlbums:
|
|
name: "has_albums"
|
|
in: "query"
|
|
required: false
|
|
description: "Filter/exclude artists with no associated albums"
|
|
schema:
|
|
default: null
|
|
type: "boolean"
|
|
Refresh:
|
|
name: "refresh"
|
|
in: "query"
|
|
required: false
|
|
description: "Trigger an ActivityPub fetch to refresh local data"
|
|
schema:
|
|
default: false
|
|
type: "boolean"
|
|
|
|
|
|
Related:
|
|
name: related
|
|
in: query
|
|
description: Restrict to results similar to the given object (based on tags)
|
|
schema:
|
|
type: integer
|
|
format: int64
|
|
|
|
|
|
Scope:
|
|
name: "scope"
|
|
in: "query"
|
|
required: false
|
|
description: |
|
|
Limit the results to a given user or pod:
|
|
- Use `all` (or do not specify the property to disable scope filtering)
|
|
- Use `me` to retrieve content relative to the current user
|
|
- Use `subscribed` to retrieve content in libraries you follow
|
|
- Use `actor:alice@example.com` to retrieve content relative to the account `alice@example.com
|
|
- Use `domain:example.com` to retrieve content relative to the domain `example.com
|
|
|
|
You can specify multiple coma separated scopes, e.g `scope=me,subscribed` to retrieve content matching either scopes.
|
|
|
|
schema:
|
|
default: "all"
|
|
type: "string"
|
|
enum:
|
|
- "me"
|
|
- "all"
|
|
- "subscribed"
|
|
- "actor:alice@example.com"
|
|
- "domain:example.com"
|
|
|
|
ContentCategory:
|
|
name: "content_category"
|
|
in: "query"
|
|
description: |
|
|
Limits the results to those whose artist content type matches the query.
|
|
|
|
required: false
|
|
schema:
|
|
type: "string"
|
|
enum:
|
|
- "podcast"
|
|
- "music"
|
|
|
|
Search:
|
|
name: "q"
|
|
in: "query"
|
|
required: false
|
|
description: "Limit the results to the corresponding search query"
|
|
schema:
|
|
default: "all"
|
|
type: "string"
|
|
example: "Bonobo"
|
|
|
|
Subscribed:
|
|
name: "subscribed"
|
|
in: "query"
|
|
description: "Limit or exclude results with a matching subsription from the current user"
|
|
required: false
|
|
schema:
|
|
type: boolean
|
|
|
|
Tags:
|
|
name: "tag"
|
|
in: "query"
|
|
description: "Limit the results to the corresponding tags. May be used multiple times, to retrieve objects matching al provided tags"
|
|
required: false
|
|
schema:
|
|
type: array
|
|
items:
|
|
type: string
|
|
example:
|
|
- rock
|
|
- metal
|