diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index b9f792346..71f445080 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -175,7 +175,7 @@ lint_api: - if: $CI_COMMIT_BRANCH =~ /(stable|develop)/ - changes: [api/**/*] - image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:3.11 + image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:3.13 cache: *api_cache before_script: - cd api @@ -339,7 +339,7 @@ build_api_schema: # Add build_docs rules because it depends on the build_api_schema artifact - changes: [docs/**/*] - image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:3.11 + image: $CI_REGISTRY/funkwhale/ci/python-funkwhale-api:3.13 services: - postgres:15-alpine - redis:7-alpine @@ -357,6 +357,11 @@ build_api_schema: - poetry run funkwhale-manage migrate script: - poetry run funkwhale-manage spectacular --file ../docs/schema.yml + - diff ../docs/schema.yml ./funkwhale_api/common/schema.yml || ( + echo "Schema files do not match! run sudo docker compose run --rm + api funkwhale-manage spectacular > ./api/funkwhale_api/common/schema.yml" && + exit 1 + ) artifacts: expire_in: 2 weeks paths: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 648c11fc4..9a489dba3 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -6,7 +6,8 @@ repos: rev: v4.4.0 hooks: - id: check-added-large-files - args: ['--maxkb=1000'] + exclude: 'api/funkwhale_api/common/schema.yml' + - id: check-case-conflict - id: check-executables-have-shebangs - id: check-shebang-scripts-are-executable @@ -63,6 +64,7 @@ repos: hooks: - id: prettier files: \.(md|yml|yaml|json)$ + exclude: 'api/funkwhale_api/common/schema.yml' - repo: https://github.com/codespell-project/codespell rev: v2.2.6 diff --git a/api/funkwhale_api/common/schema.yml b/api/funkwhale_api/common/schema.yml index fd81f89e0..589a05aea 100644 --- a/api/funkwhale_api/common/schema.yml +++ b/api/funkwhale_api/common/schema.yml @@ -47,29 +47,29 @@ paths: get: operationId: get_activity parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - activity + - activity security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -77,136 +77,136 @@ paths: get: operationId: get_albums parameters: - - in: query - name: artist - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -217,7 +217,7 @@ paths: post: operationId: create_album tags: - - albums + - albums requestBody: content: application/json: @@ -234,8 +234,8 @@ paths: $ref: '#/components/schemas/AlbumCreateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -247,17 +247,17 @@ paths: get: operationId: get_album parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -268,17 +268,17 @@ paths: delete: operationId: delete_album parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -286,142 +286,142 @@ paths: get: operationId: get_album_fetches parameters: - - in: query - name: artist - schema: - type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: type: integer - description: A unique integer value identifying this album. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -432,14 +432,14 @@ paths: post: operationId: create_album_fetch parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums requestBody: content: application/json: @@ -456,8 +456,8 @@ paths: $ref: '#/components/schemas/AlbumRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -469,142 +469,142 @@ paths: get: operationId: get_album_libraries parameters: - - in: query - name: artist - schema: - type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: type: integer - description: A unique integer value identifying this album. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -616,142 +616,142 @@ paths: get: operationId: get_album_mutations parameters: - - in: query - name: artist - schema: - type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: type: integer - description: A unique integer value identifying this album. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -762,14 +762,14 @@ paths: post: operationId: create_album_mutation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums requestBody: content: application/json: @@ -786,8 +786,8 @@ paths: $ref: '#/components/schemas/AlbumRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -799,128 +799,128 @@ paths: get: operationId: get_artists parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -932,17 +932,17 @@ paths: get: operationId: get_artist parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -954,134 +954,134 @@ paths: get: operationId: get_artist_fetches parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1092,14 +1092,14 @@ paths: post: operationId: create_artist_fetch parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - artists + - artists requestBody: content: application/json: @@ -1116,8 +1116,8 @@ paths: $ref: '#/components/schemas/ArtistWithAlbumsRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1129,134 +1129,134 @@ paths: get: operationId: get_artist_libraries parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1268,134 +1268,134 @@ paths: get: operationId: get_artist_mutations parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1406,14 +1406,14 @@ paths: post: operationId: create_artist_mutation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - artists + - artists requestBody: content: application/json: @@ -1430,8 +1430,8 @@ paths: $ref: '#/components/schemas/ArtistWithAlbumsRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1443,7 +1443,7 @@ paths: post: operationId: create_attachment tags: - - attachments + - attachments requestBody: content: application/json: @@ -1460,8 +1460,8 @@ paths: $ref: '#/components/schemas/AttachmentRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -1473,17 +1473,17 @@ paths: get: operationId: get_attachment parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - attachments + - attachments security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1494,17 +1494,17 @@ paths: delete: operationId: delete_attachment parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - attachments + - attachments security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -1512,14 +1512,14 @@ paths: get: operationId: get_attachment_proxy parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - attachments + - attachments responses: '200': content: @@ -1532,7 +1532,7 @@ paths: operationId: change_password description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -1549,8 +1549,8 @@ paths: $ref: '#/components/schemas/PasswordChangeRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1563,7 +1563,7 @@ paths: operationId: reset_password description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -1580,9 +1580,9 @@ paths: $ref: '#/components/schemas/PasswordResetRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] - - {} + - oauth2: [] + - ApplicationToken: [] + - {} responses: '200': content: @@ -1595,7 +1595,7 @@ paths: operationId: confirm_password_reset description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -1612,9 +1612,9 @@ paths: $ref: '#/components/schemas/PasswordResetConfirmRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] - - {} + - oauth2: [] + - ApplicationToken: [] + - {} responses: '200': content: @@ -1627,7 +1627,7 @@ paths: operationId: register description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -1644,8 +1644,8 @@ paths: $ref: '#/components/schemas/RegisterRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -1658,7 +1658,7 @@ paths: operationId: change_password_2 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -1675,8 +1675,8 @@ paths: $ref: '#/components/schemas/PasswordChangeRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1689,7 +1689,7 @@ paths: operationId: verify_email description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -1706,9 +1706,9 @@ paths: $ref: '#/components/schemas/VerifyEmailRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] - - {} + - oauth2: [] + - ApplicationToken: [] + - {} responses: '200': description: No response body @@ -1725,10 +1725,10 @@ paths: Returns UserModel fields. tags: - - auth + - auth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1748,7 +1748,7 @@ paths: Returns UserModel fields. tags: - - auth + - auth requestBody: content: application/json: @@ -1765,8 +1765,8 @@ paths: $ref: '#/components/schemas/UserDetailsRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1786,7 +1786,7 @@ paths: Returns UserModel fields. tags: - - auth + - auth requestBody: content: application/json: @@ -1802,8 +1802,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUserDetailsRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1815,75 +1815,75 @@ paths: get: operationId: get_channels parameters: - - in: query - name: external - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -modification_date - - -random - - creation_date - - modification_date - - random - description: |- - Ordering + - in: query + name: external + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: ordering + schema: + type: array + items: + type: string + enum: + - -creation_date + - -modification_date + - -random + - creation_date + - modification_date + - random + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: subscribed + schema: + type: boolean + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: scope - schema: - type: string - - in: query - name: subscribed - schema: - type: boolean - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1894,7 +1894,7 @@ paths: post: operationId: create_channel tags: - - channels + - channels requestBody: content: application/json: @@ -1911,8 +1911,8 @@ paths: $ref: '#/components/schemas/ChannelCreateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -1924,17 +1924,17 @@ paths: get: operationId: get_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1945,14 +1945,14 @@ paths: put: operationId: update_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -1969,8 +1969,8 @@ paths: $ref: '#/components/schemas/ChannelUpdateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -1981,14 +1981,14 @@ paths: patch: operationId: partial_update_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -2004,8 +2004,8 @@ paths: schema: $ref: '#/components/schemas/PatchedChannelUpdateRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2016,17 +2016,17 @@ paths: delete: operationId: delete_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -2034,17 +2034,17 @@ paths: get: operationId: get_channel_rss parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2056,14 +2056,14 @@ paths: post: operationId: subscribe_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -2080,8 +2080,8 @@ paths: $ref: '#/components/schemas/ChannelRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2093,14 +2093,14 @@ paths: post: operationId: unsubscribe_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -2117,25 +2117,25 @@ paths: $ref: '#/components/schemas/ChannelRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body delete: operationId: unsubscribe_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -2143,10 +2143,10 @@ paths: get: operationId: get_channel_metadata_choices tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2158,7 +2158,7 @@ paths: post: operationId: subscribe_channel_rss tags: - - channels + - channels requestBody: content: application/json: @@ -2175,8 +2175,8 @@ paths: $ref: '#/components/schemas/ChannelRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2188,41 +2188,41 @@ paths: get: operationId: get_favorite_tracks parameters: - - in: query - name: hidden - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string + - in: query + name: hidden + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2233,7 +2233,7 @@ paths: post: operationId: favorite_track tags: - - favorites + - favorites requestBody: content: application/json: @@ -2250,8 +2250,8 @@ paths: $ref: '#/components/schemas/UserTrackFavoriteWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -2263,17 +2263,17 @@ paths: delete: operationId: delete_favorite_track parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track favorite. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track favorite. + required: true tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -2285,10 +2285,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display favorites status in the UI tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2300,7 +2300,7 @@ paths: post: operationId: unfavorite_track_2 tags: - - favorites + - favorites requestBody: content: application/json: @@ -2317,8 +2317,8 @@ paths: $ref: '#/components/schemas/UserTrackFavoriteWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2329,10 +2329,10 @@ paths: delete: operationId: unfavorite_track tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -2340,17 +2340,17 @@ paths: get: operationId: get_federation_actor parameters: - - in: path - name: full_username - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: full_username + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2362,17 +2362,17 @@ paths: get: operationId: get_federation_actor_library parameters: - - in: path - name: full_username - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: full_username + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2384,29 +2384,29 @@ paths: get: operationId: get_federation_domains parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2418,17 +2418,17 @@ paths: get: operationId: get_federation_domain parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2440,7 +2440,7 @@ paths: post: operationId: create_federation_fetch tags: - - federation + - federation requestBody: content: application/json: @@ -2457,8 +2457,8 @@ paths: $ref: '#/components/schemas/FetchRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -2470,17 +2470,17 @@ paths: get: operationId: get_federation_fetch parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this fetch. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this fetch. + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2492,33 +2492,33 @@ paths: get: operationId: get_federation_library_follows parameters: - - in: query - name: approved - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - in: query + name: approved + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2529,7 +2529,7 @@ paths: post: operationId: create_federation_library_follow tags: - - federation + - federation requestBody: content: application/json: @@ -2546,8 +2546,8 @@ paths: $ref: '#/components/schemas/LibraryFollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -2559,17 +2559,17 @@ paths: get: operationId: get_federation_library_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2580,17 +2580,17 @@ paths: delete: operationId: delete_federation_library_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -2598,14 +2598,14 @@ paths: post: operationId: accept_federation_library_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -2622,8 +2622,8 @@ paths: $ref: '#/components/schemas/LibraryFollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '404': description: No response body @@ -2633,14 +2633,14 @@ paths: post: operationId: reject_federation_library_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -2657,8 +2657,8 @@ paths: $ref: '#/components/schemas/LibraryFollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2674,10 +2674,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display subscription status in the UI tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2689,29 +2689,29 @@ paths: get: operationId: get_federation_received_follows parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2722,7 +2722,7 @@ paths: post: operationId: create_federation_user_follow tags: - - federation + - federation requestBody: content: application/json: @@ -2739,8 +2739,8 @@ paths: $ref: '#/components/schemas/FollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -2752,17 +2752,17 @@ paths: get: operationId: get_federation_user_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2773,17 +2773,17 @@ paths: delete: operationId: delete_federation_user_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -2791,14 +2791,14 @@ paths: post: operationId: accept_federation_user_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -2815,8 +2815,8 @@ paths: $ref: '#/components/schemas/FollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '404': description: No response body @@ -2826,14 +2826,14 @@ paths: post: operationId: reject_federation_user_follow parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -2850,8 +2850,8 @@ paths: $ref: '#/components/schemas/FollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2867,10 +2867,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display subscription status in the UI tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2882,45 +2882,45 @@ paths: get: operationId: get_federation_inboxes parameters: - - in: query - name: activity__actor - schema: - type: integer - - in: query - name: activity__type - schema: - type: string - - in: query - name: before - schema: - type: number - - in: query - name: is_read - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - in: query + name: activity__actor + schema: + type: integer + - in: query + name: activity__type + schema: + type: string + - in: query + name: before + schema: + type: number + - in: query + name: is_read + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2932,17 +2932,17 @@ paths: get: operationId: get_federation_inbox parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this inbox item. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inbox item. + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2953,14 +2953,14 @@ paths: put: operationId: update_federation_inbox parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this inbox item. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inbox item. + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -2977,8 +2977,8 @@ paths: $ref: '#/components/schemas/InboxItemRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -2989,14 +2989,14 @@ paths: patch: operationId: partial_update_federation_inbox parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this inbox item. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inbox item. + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -3012,8 +3012,8 @@ paths: schema: $ref: '#/components/schemas/PatchedInboxItemRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3036,7 +3036,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - federation + - federation requestBody: content: application/json: @@ -3053,8 +3053,8 @@ paths: $ref: '#/components/schemas/InboxItemRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3066,17 +3066,17 @@ paths: get: operationId: get_federation_library parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3088,14 +3088,14 @@ paths: post: operationId: create_federation_library_scan parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -3112,8 +3112,8 @@ paths: $ref: '#/components/schemas/LibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3125,7 +3125,7 @@ paths: post: operationId: create_federation_library_fetch tags: - - federation + - federation requestBody: content: application/json: @@ -3142,8 +3142,8 @@ paths: $ref: '#/components/schemas/LibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3155,45 +3155,45 @@ paths: get: operationId: get_history_listenings parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: hidden - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: scope - schema: - type: string - - in: query - name: username - schema: - type: string + - in: query + name: domain + schema: + type: string + - in: query + name: hidden + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: scope + schema: + type: string + - in: query + name: username + schema: + type: string tags: - - history + - history security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3204,7 +3204,7 @@ paths: post: operationId: create_history_listening tags: - - history + - history requestBody: content: application/json: @@ -3221,8 +3221,8 @@ paths: $ref: '#/components/schemas/ListeningWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -3234,17 +3234,17 @@ paths: get: operationId: get_history_listening parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this listening. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this listening. + required: true tags: - - history + - history security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3261,17 +3261,17 @@ paths: - batch update preferences - update a single preference parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string tags: - - instance + - instance security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3290,17 +3290,17 @@ paths: - batch update preferences - update a single preference parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this Global preference. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Global preference. + required: true tags: - - instance + - instance security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3316,14 +3316,14 @@ paths: - batch update preferences - update a single preference parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this Global preference. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Global preference. + required: true tags: - - instance + - instance requestBody: content: application/json: @@ -3340,8 +3340,8 @@ paths: $ref: '#/components/schemas/GlobalPreferenceRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3357,14 +3357,14 @@ paths: - batch update preferences - update a single preference parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this Global preference. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Global preference. + required: true tags: - - instance + - instance requestBody: content: application/json: @@ -3380,8 +3380,8 @@ paths: schema: $ref: '#/components/schemas/PatchedGlobalPreferenceRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3398,7 +3398,7 @@ paths: this is a long method because we ensure everything is valid before actually persisting the changes tags: - - instance + - instance requestBody: content: application/json: @@ -3415,8 +3415,8 @@ paths: $ref: '#/components/schemas/GlobalPreferenceRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3428,7 +3428,7 @@ paths: get: operationId: getNodeInfo20 tags: - - instance + - instance responses: '200': content: @@ -3440,7 +3440,7 @@ paths: get: operationId: get_instance_settings tags: - - instance + - instance responses: '200': content: @@ -3452,7 +3452,7 @@ paths: get: operationId: get_spa_manifest tags: - - instance + - instance responses: '200': content: @@ -3464,49 +3464,49 @@ paths: get: operationId: get_libraries parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: privacy_level - schema: - type: string - enum: - - everyone - - instance - - me - description: |- - * `me` - Only me - * `instance` - Everyone on my instance, and my followers - * `everyone` - Everyone, including people on other instances - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: privacy_level + schema: + type: string + enum: + - everyone + - instance + - me + description: |- + * `me` - Only me + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3518,17 +3518,17 @@ paths: get: operationId: get_library parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3540,17 +3540,17 @@ paths: get: operationId: get_library_fs_import tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body post: operationId: create_library_fs_import tags: - - libraries + - libraries requestBody: content: application/json: @@ -3567,18 +3567,18 @@ paths: $ref: '#/components/schemas/LibraryForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body delete: operationId: delete_library_fs_import tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -3586,29 +3586,29 @@ paths: get: operationId: get_licenses parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - licenses + - licenses security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3620,17 +3620,17 @@ paths: get: operationId: get_license parameters: - - in: path - name: code - schema: - type: string - description: A unique value identifying this license. - required: true + - in: path + name: code + schema: + type: string + description: A unique value identifying this license. + required: true tags: - - licenses + - licenses security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3642,17 +3642,17 @@ paths: get: operationId: get_listen parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - listen + - listen security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3665,63 +3665,63 @@ paths: get: operationId: admin_get_accounts parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: local - schema: - type: boolean - - in: query - name: manually_approves_followers - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: type - schema: - type: string - enum: - - Application - - Group - - Organization - - Person - - Service - - Tombstone - description: |- - * `Person` - Person - * `Tombstone` - Tombstone - * `Application` - Application - * `Group` - Group - * `Organization` - Organization - * `Service` - Service + - in: query + name: domain + schema: + type: string + - in: query + name: local + schema: + type: boolean + - in: query + name: manually_approves_followers + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: type + schema: + type: string + enum: + - Application + - Group + - Organization + - Person + - Service + - Tombstone + description: |- + * `Person` - Person + * `Tombstone` - Tombstone + * `Application` - Application + * `Group` - Group + * `Organization` - Organization + * `Service` - Service tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3733,17 +3733,17 @@ paths: get: operationId: admin_get_account parameters: - - in: path - name: id - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: id + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3755,17 +3755,17 @@ paths: get: operationId: admin_get_account_stats parameters: - - in: path - name: id - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: id + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3788,7 +3788,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -3805,8 +3805,8 @@ paths: $ref: '#/components/schemas/ManageActorRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3818,33 +3818,33 @@ paths: get: operationId: admin_get_channels parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3856,17 +3856,17 @@ paths: get: operationId: admin_get_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3877,17 +3877,17 @@ paths: delete: operationId: admin_delete_channel parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -3895,17 +3895,17 @@ paths: get: operationId: admin_get_channel_stats parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3917,41 +3917,41 @@ paths: get: operationId: admin_get_federation_domains parameters: - - in: query - name: allowed - schema: - type: boolean - - in: query - name: name - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - in: query + name: allowed + schema: + type: boolean + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -3962,7 +3962,7 @@ paths: post: operationId: admin_create_federation_domain tags: - - manage + - manage requestBody: content: application/json: @@ -3979,8 +3979,8 @@ paths: $ref: '#/components/schemas/ManageDomainRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -3992,17 +3992,17 @@ paths: get: operationId: admin_get_federation_domain parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4013,14 +4013,14 @@ paths: put: operationId: admin_update_federation_domain parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -4036,8 +4036,8 @@ paths: schema: $ref: '#/components/schemas/ManageDomainUpdateRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4048,14 +4048,14 @@ paths: patch: operationId: admin_partial_update_federation_domain parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -4071,8 +4071,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageDomainUpdateRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4084,17 +4084,17 @@ paths: get: operationId: admin_get_federation_domain_nodeinfo parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4106,17 +4106,17 @@ paths: get: operationId: admin_get_federation_domain_stats parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4139,7 +4139,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -4156,8 +4156,8 @@ paths: $ref: '#/components/schemas/ManageDomainRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4169,54 +4169,54 @@ paths: get: operationId: admin_get_albums parameters: - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: fid - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: + - in: query + name: artist_credit + schema: + type: array + items: type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: title - schema: - type: string + explode: true + style: form + - in: query + name: fid + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: title + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4228,17 +4228,17 @@ paths: get: operationId: admin_get_album parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4249,17 +4249,17 @@ paths: delete: operationId: admin_delete_album parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -4267,17 +4267,17 @@ paths: get: operationId: admin_get_library_album_stats parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4300,7 +4300,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -4317,8 +4317,8 @@ paths: $ref: '#/components/schemas/ManageAlbumRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4330,58 +4330,58 @@ paths: get: operationId: admin_get_artists parameters: - - in: query - name: content_category - schema: - type: string - enum: - - music - - other - - podcast - description: |- - * `music` - music - * `podcast` - podcast - * `other` - other - - in: query - name: fid - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - in: query + name: content_category + schema: + type: string + enum: + - music + - other + - podcast + description: |- + * `music` - music + * `podcast` - podcast + * `other` - other + - in: query + name: fid + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4393,17 +4393,17 @@ paths: get: operationId: admin_get_artist parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4414,17 +4414,17 @@ paths: delete: operationId: admin_delete_artist parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -4432,17 +4432,17 @@ paths: get: operationId: admin_get_library_artist_stats parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4465,7 +4465,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -4482,8 +4482,8 @@ paths: $ref: '#/components/schemas/ManageArtistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4495,75 +4495,75 @@ paths: get: operationId: admin_get_libraries parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: fid - schema: - type: string - - in: query - name: name - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -followers_count - - -uploads_count - - creation_date - - followers_count - - uploads_count - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `uploads_count` - Uploads count - * `-uploads_count` - Uploads count (descending) - * `followers_count` - Followers count - * `-followers_count` - Followers count (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: privacy_level - schema: + - in: query + name: domain + schema: + type: string + - in: query + name: fid + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string enum: - - everyone - - instance - - me - description: |- - * `me` - Only me - * `instance` - Everyone on my instance, and my followers - * `everyone` - Everyone, including people on other instances - - in: query - name: q - schema: - type: string + - -creation_date + - -followers_count + - -uploads_count + - creation_date + - followers_count + - uploads_count + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `uploads_count` - Uploads count + * `-uploads_count` - Uploads count (descending) + * `followers_count` - Followers count + * `-followers_count` - Followers count (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: privacy_level + schema: + type: string + enum: + - everyone + - instance + - me + description: |- + * `me` - Only me + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4575,17 +4575,17 @@ paths: get: operationId: admin_get_library parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4596,14 +4596,14 @@ paths: put: operationId: admin_update_library parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -4620,8 +4620,8 @@ paths: $ref: '#/components/schemas/ManageLibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4632,14 +4632,14 @@ paths: patch: operationId: admin_partial_update_library parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -4655,8 +4655,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageLibraryRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4667,17 +4667,17 @@ paths: delete: operationId: admin_delete_library parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -4685,17 +4685,17 @@ paths: get: operationId: admin_get_library_stats parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4718,7 +4718,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -4735,8 +4735,8 @@ paths: $ref: '#/components/schemas/ManageLibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4748,62 +4748,62 @@ paths: get: operationId: admin_get_tracks parameters: - - in: query - name: album - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist_credit + schema: + type: array + items: type: integer - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: fid - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: title - schema: - type: string + explode: true + style: form + - in: query + name: fid + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: title + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4815,17 +4815,17 @@ paths: get: operationId: admin_get_track parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4836,17 +4836,17 @@ paths: delete: operationId: admin_delete_track parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -4854,17 +4854,17 @@ paths: get: operationId: admin_get_track_stats parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4887,7 +4887,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -4904,8 +4904,8 @@ paths: $ref: '#/components/schemas/ManageTrackRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -4917,99 +4917,99 @@ paths: get: operationId: admin_get_uploads parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: fid - schema: - type: string - - in: query - name: import_reference - schema: - type: string - - in: query - name: import_status - schema: + - in: query + name: domain + schema: + type: string + - in: query + name: fid + schema: + type: string + - in: query + name: import_reference + schema: + type: string + - in: query + name: import_status + schema: + type: string + enum: + - draft + - errored + - finished + - pending + - skipped + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped + - in: query + name: mimetype + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string enum: - - draft - - errored - - finished - - pending - - skipped - description: |- - * `draft` - Draft - * `pending` - Pending - * `finished` - Finished - * `errored` - Errored - * `skipped` - Skipped - - in: query - name: mimetype - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -accessed_date - - -bitrate - - -creation_date - - -duration - - -modification_date - - -size - - accessed_date - - bitrate - - creation_date - - duration - - modification_date - - size - description: |- - Ordering + - -accessed_date + - -bitrate + - -creation_date + - -duration + - -modification_date + - -size + - accessed_date + - bitrate + - creation_date + - duration + - modification_date + - size + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `accessed_date` - Accessed date - * `-accessed_date` - Accessed date (descending) - * `size` - Size - * `-size` - Size (descending) - * `bitrate` - Bitrate - * `-bitrate` - Bitrate (descending) - * `duration` - Duration - * `-duration` - Duration (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: privacy_level - schema: - type: string - - in: query - name: q - schema: - type: string + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `accessed_date` - Accessed date + * `-accessed_date` - Accessed date (descending) + * `size` - Size + * `-size` - Size (descending) + * `bitrate` - Bitrate + * `-bitrate` - Bitrate (descending) + * `duration` - Duration + * `-duration` - Duration (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: privacy_level + schema: + type: string + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5021,17 +5021,17 @@ paths: get: operationId: admin_get_upload parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5042,17 +5042,17 @@ paths: delete: operationId: admin_delete_upload parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -5071,7 +5071,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -5088,8 +5088,8 @@ paths: $ref: '#/components/schemas/ManageUploadRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5101,61 +5101,61 @@ paths: get: operationId: moderation_get_instance_policies parameters: - - in: query - name: block_all - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: reject_media - schema: - type: boolean - - in: query - name: silence_activity - schema: - type: boolean - - in: query - name: silence_notifications - schema: - type: boolean - - in: query - name: target_account_domain - schema: - type: string - - in: query - name: target_account_username - schema: - type: string - - in: query - name: target_domain - schema: - type: string + - in: query + name: block_all + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: reject_media + schema: + type: boolean + - in: query + name: silence_activity + schema: + type: boolean + - in: query + name: silence_notifications + schema: + type: boolean + - in: query + name: target_account_domain + schema: + type: string + - in: query + name: target_account_username + schema: + type: string + - in: query + name: target_domain + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5166,7 +5166,7 @@ paths: post: operationId: moderation_create_instance_policy tags: - - manage + - manage requestBody: content: application/json: @@ -5183,8 +5183,8 @@ paths: $ref: '#/components/schemas/ManageInstancePolicyRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -5196,17 +5196,17 @@ paths: get: operationId: moderation_get_instance_policy parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5217,14 +5217,14 @@ paths: put: operationId: moderation_update_instance_policy parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5241,8 +5241,8 @@ paths: $ref: '#/components/schemas/ManageInstancePolicyRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5253,14 +5253,14 @@ paths: patch: operationId: moderation_partial_update_instance_policy parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5276,8 +5276,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageInstancePolicyRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5288,17 +5288,17 @@ paths: delete: operationId: moderation_delete_instance_policy parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -5306,33 +5306,33 @@ paths: get: operationId: moderation_get_notes parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5343,7 +5343,7 @@ paths: post: operationId: moderation_create_note tags: - - manage + - manage requestBody: content: application/json: @@ -5360,8 +5360,8 @@ paths: $ref: '#/components/schemas/ManageNoteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -5373,17 +5373,17 @@ paths: get: operationId: moderation_get_note parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5394,17 +5394,17 @@ paths: delete: operationId: moderation_delete_note parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -5412,57 +5412,57 @@ paths: get: operationId: moderation_get_reports parameters: - - in: query - name: is_handled - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: submitter_email - schema: - type: string - - in: query - name: type - schema: - type: string - enum: - - illegal_content - - invalid_metadata - - offensive_content - - other - - takedown_request - description: |- - * `takedown_request` - Takedown request - * `invalid_metadata` - Invalid metadata - * `illegal_content` - Illegal content - * `offensive_content` - Offensive content - * `other` - Other + - in: query + name: is_handled + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: submitter_email + schema: + type: string + - in: query + name: type + schema: + type: string + enum: + - illegal_content + - invalid_metadata + - offensive_content + - other + - takedown_request + description: |- + * `takedown_request` - Takedown request + * `invalid_metadata` - Invalid metadata + * `illegal_content` - Illegal content + * `offensive_content` - Offensive content + * `other` - Other tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5474,17 +5474,17 @@ paths: get: operationId: moderation_get_report parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5495,14 +5495,14 @@ paths: put: operationId: moderation_update_report parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5519,8 +5519,8 @@ paths: $ref: '#/components/schemas/ManageReportRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5531,14 +5531,14 @@ paths: patch: operationId: moderation_partial_update_report parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5554,8 +5554,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageReportRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5567,52 +5567,52 @@ paths: get: operationId: moderation_get_requests parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: status - schema: - type: string - enum: - - approved - - pending - - refused - description: |- - * `pending` - Pending - * `refused` - Refused - * `approved` - Approved - - in: query - name: type - schema: - type: string - enum: - - signup - description: '* `signup` - Sign-up' + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: status + schema: + type: string + enum: + - approved + - pending + - refused + description: |- + * `pending` - Pending + * `refused` - Refused + * `approved` - Approved + - in: query + name: type + schema: + type: string + enum: + - signup + description: '* `signup` - Sign-up' tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5624,17 +5624,17 @@ paths: get: operationId: moderation_get_request parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5645,14 +5645,14 @@ paths: put: operationId: moderation_update_request parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5669,8 +5669,8 @@ paths: $ref: '#/components/schemas/ManageUserRequestRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5681,14 +5681,14 @@ paths: patch: operationId: moderation_partial_update_request parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5704,8 +5704,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageUserRequestRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5717,33 +5717,33 @@ paths: get: operationId: admin_get_tags parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5754,7 +5754,7 @@ paths: post: operationId: admin_create_tag tags: - - manage + - manage requestBody: content: application/json: @@ -5771,8 +5771,8 @@ paths: $ref: '#/components/schemas/ManageTagRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -5784,16 +5784,16 @@ paths: get: operationId: admin_get_tag parameters: - - in: path - name: name - schema: - type: string - required: true + - in: path + name: name + schema: + type: string + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5804,16 +5804,16 @@ paths: delete: operationId: admin_delete_tag parameters: - - in: path - name: name - schema: - type: string - required: true + - in: path + name: name + schema: + type: string + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -5832,7 +5832,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -5849,8 +5849,8 @@ paths: $ref: '#/components/schemas/ManageTagRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5862,37 +5862,37 @@ paths: get: operationId: admin_get_invitations parameters: - - in: query - name: is_open - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - in: query + name: is_open + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5903,7 +5903,7 @@ paths: post: operationId: admin_create_invitation tags: - - manage + - manage requestBody: content: application/json: @@ -5919,8 +5919,8 @@ paths: schema: $ref: '#/components/schemas/ManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -5932,17 +5932,17 @@ paths: get: operationId: admin_get_invitation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5953,14 +5953,14 @@ paths: put: operationId: admin_update_invitation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -5976,8 +5976,8 @@ paths: schema: $ref: '#/components/schemas/ManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -5988,14 +5988,14 @@ paths: patch: operationId: admin_partial_update_invitation parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -6011,8 +6011,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6035,7 +6035,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -6051,8 +6051,8 @@ paths: schema: $ref: '#/components/schemas/ManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6064,71 +6064,71 @@ paths: get: operationId: admin_get_users parameters: - - in: query - name: is_active - schema: - type: boolean - - in: query - name: is_staff - schema: - type: boolean - - in: query - name: is_superuser - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: permission_library - schema: - type: boolean - - in: query - name: permission_moderation - schema: - type: boolean - - in: query - name: permission_settings - schema: - type: boolean - - in: query - name: privacy_level - schema: - type: string - enum: - - everyone - - followers - - instance - - me - description: |- - * `me` - Only me - * `followers` - Me and my followers - * `instance` - Everyone on my instance, and my followers - * `everyone` - Everyone, including people on other instances - - in: query - name: q - schema: - type: string + - in: query + name: is_active + schema: + type: boolean + - in: query + name: is_staff + schema: + type: boolean + - in: query + name: is_superuser + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: permission_library + schema: + type: boolean + - in: query + name: permission_moderation + schema: + type: boolean + - in: query + name: permission_settings + schema: + type: boolean + - in: query + name: privacy_level + schema: + type: string + enum: + - everyone + - followers + - instance + - me + description: |- + * `me` - Only me + * `followers` - Me and my followers + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6140,17 +6140,17 @@ paths: get: operationId: admin_get_user parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this user. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6161,14 +6161,14 @@ paths: put: operationId: admin_update_user parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this user. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -6184,8 +6184,8 @@ paths: schema: $ref: '#/components/schemas/ManageUserRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6196,14 +6196,14 @@ paths: patch: operationId: admin_partial_update_user parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this user. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -6219,8 +6219,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageUserRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6232,29 +6232,29 @@ paths: get: operationId: get_moderation_content_filters parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - moderation + - moderation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6265,7 +6265,7 @@ paths: post: operationId: create_moderation_content_filter tags: - - moderation + - moderation requestBody: content: application/json: @@ -6282,8 +6282,8 @@ paths: $ref: '#/components/schemas/UserFilterRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -6295,17 +6295,17 @@ paths: get: operationId: get_moderation_content_filter parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - moderation + - moderation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6316,17 +6316,17 @@ paths: delete: operationId: delete_moderation_content_filter parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - moderation + - moderation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -6334,7 +6334,7 @@ paths: post: operationId: create_moderation_report tags: - - moderation + - moderation requestBody: content: application/json: @@ -6351,8 +6351,8 @@ paths: $ref: '#/components/schemas/ReportRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -6364,45 +6364,45 @@ paths: get: operationId: get_mutations parameters: - - in: query - name: is_applied - schema: - type: boolean - - in: query - name: is_approved - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: type - schema: - type: string + - in: query + name: is_applied + schema: + type: boolean + - in: query + name: is_approved + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: type + schema: + type: string tags: - - mutations + - mutations security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6414,17 +6414,17 @@ paths: get: operationId: get_mutation parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6435,17 +6435,17 @@ paths: delete: operationId: delete_mutation parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -6453,14 +6453,14 @@ paths: post: operationId: approve_mutation parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations requestBody: content: application/json: @@ -6477,8 +6477,8 @@ paths: $ref: '#/components/schemas/APIMutationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6490,14 +6490,14 @@ paths: post: operationId: reject_mutation parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations requestBody: content: application/json: @@ -6514,8 +6514,8 @@ paths: $ref: '#/components/schemas/APIMutationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6527,29 +6527,29 @@ paths: get: operationId: get_oauth_apps parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6560,7 +6560,7 @@ paths: post: operationId: create_oauth_app tags: - - oauth + - oauth requestBody: content: application/json: @@ -6577,8 +6577,8 @@ paths: $ref: '#/components/schemas/CreateApplicationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -6590,16 +6590,16 @@ paths: get: operationId: get_oauth_app parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6610,13 +6610,13 @@ paths: put: operationId: update_oauth_app parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth requestBody: content: application/json: @@ -6633,8 +6633,8 @@ paths: $ref: '#/components/schemas/ApplicationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6645,13 +6645,13 @@ paths: patch: operationId: partial_update_oauth_app parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth requestBody: content: application/json: @@ -6667,8 +6667,8 @@ paths: schema: $ref: '#/components/schemas/PatchedApplicationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6679,16 +6679,16 @@ paths: delete: operationId: delete_oauth_app parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -6696,13 +6696,13 @@ paths: post: operationId: refresh_oauth_token parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth requestBody: content: application/json: @@ -6719,8 +6719,8 @@ paths: $ref: '#/components/schemas/CreateApplicationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6735,17 +6735,17 @@ paths: This is a viewset that list applications that have access to the request user account, to allow revoking tokens easily. parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6762,16 +6762,16 @@ paths: This is a viewset that list applications that have access to the request user account, to allow revoking tokens easily. parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6785,16 +6785,16 @@ paths: This is a viewset that list applications that have access to the request user account, to allow revoking tokens easily. parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -6802,10 +6802,10 @@ paths: get: operationId: get_oembed tags: - - oembed + - oembed security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6817,68 +6817,68 @@ paths: get: operationId: get_playlists parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: - type: integer - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: track - schema: - type: integer + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: integer + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: track + schema: + type: integer tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6892,15 +6892,15 @@ paths: post: operationId: create_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf + - in: query + name: format + schema: + type: string + enum: + - json + - xspf tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -6917,8 +6917,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -6933,24 +6933,24 @@ paths: get: operationId: get_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -6964,21 +6964,21 @@ paths: put: operationId: update_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -6995,8 +6995,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7010,21 +7010,21 @@ paths: patch: operationId: partial_update_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -7040,8 +7040,8 @@ paths: schema: $ref: '#/components/schemas/PatchedPlaylistRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7055,24 +7055,24 @@ paths: delete: operationId: delete_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -7080,21 +7080,21 @@ paths: post: operationId: add_to_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -7111,8 +7111,8 @@ paths: $ref: '#/components/schemas/PlaylistAddManyRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7127,24 +7127,24 @@ paths: get: operationId: get_playlist_albums parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7159,24 +7159,24 @@ paths: get: operationId: get_playlist_artits parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7191,24 +7191,24 @@ paths: delete: operationId: clear_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -7216,21 +7216,21 @@ paths: post: operationId: reorder_track_in_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -7247,8 +7247,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7263,21 +7263,21 @@ paths: post: operationId: remove_from_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -7294,8 +7294,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7309,24 +7309,24 @@ paths: delete: operationId: remove_from_playlist parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -7334,74 +7334,74 @@ paths: get: operationId: get_playlist_tracks parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: - type: integer - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: track - schema: - type: integer + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: integer + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: track + schema: + type: integer tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7416,39 +7416,39 @@ paths: get: operationId: get_plugins parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body post: operationId: create_plugin tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': description: No response body @@ -7456,17 +7456,17 @@ paths: get: operationId: get_plugin parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -7474,17 +7474,17 @@ paths: post: operationId: disable_plugin parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -7492,17 +7492,17 @@ paths: post: operationId: enable_plugin parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -7510,17 +7510,17 @@ paths: post: operationId: create_plugin_scan parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -7528,53 +7528,53 @@ paths: get: operationId: get_radios parameters: - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7585,7 +7585,7 @@ paths: post: operationId: create_radio tags: - - radios + - radios requestBody: content: application/json: @@ -7602,8 +7602,8 @@ paths: $ref: '#/components/schemas/RadioRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -7615,17 +7615,17 @@ paths: get: operationId: get_radio parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7636,14 +7636,14 @@ paths: put: operationId: update_radio parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios requestBody: content: application/json: @@ -7660,8 +7660,8 @@ paths: $ref: '#/components/schemas/RadioRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7672,14 +7672,14 @@ paths: patch: operationId: partial_update_radio parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios requestBody: content: application/json: @@ -7695,8 +7695,8 @@ paths: schema: $ref: '#/components/schemas/PatchedRadioRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7707,17 +7707,17 @@ paths: delete: operationId: delete_radio parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -7725,17 +7725,17 @@ paths: get: operationId: get_radio_track parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7747,10 +7747,10 @@ paths: get: operationId: get_radio_filter tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7762,7 +7762,7 @@ paths: post: operationId: validate_radio tags: - - radios + - radios requestBody: content: application/json: @@ -7779,8 +7779,8 @@ paths: $ref: '#/components/schemas/RadioRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7792,7 +7792,7 @@ paths: post: operationId: create_radio_session tags: - - radios + - radios requestBody: content: application/json: @@ -7809,8 +7809,8 @@ paths: $ref: '#/components/schemas/RadioSessionRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -7822,17 +7822,17 @@ paths: get: operationId: get_radio_session parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio session. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio session. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7844,7 +7844,7 @@ paths: post: operationId: get_next_radio_track tags: - - radios + - radios requestBody: content: application/json: @@ -7861,8 +7861,8 @@ paths: $ref: '#/components/schemas/RadioSessionTrackSerializerCreateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -7874,10 +7874,10 @@ paths: get: operationId: get_rate_limit tags: - - rate-limit + - rate-limit security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7889,10 +7889,10 @@ paths: get: operationId: get_search_results tags: - - search + - search security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7904,17 +7904,17 @@ paths: get: operationId: get_track_stream parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - stream + - stream security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7927,29 +7927,29 @@ paths: get: operationId: get_subscriptions parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - subscriptions + - subscriptions security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7961,17 +7961,17 @@ paths: get: operationId: get_subscription parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - subscriptions + - subscriptions security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -7987,10 +7987,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display subscription status in the UI tags: - - subscriptions + - subscriptions security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8002,55 +8002,55 @@ paths: get: operationId: get_tags parameters: - - in: query - name: name - schema: + - in: query + name: name + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -length - - -name - - creation_date - - length - - name - description: |- - Ordering + enum: + - -creation_date + - -length + - -name + - creation_date + - length + - name + description: |- + Ordering - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `length` - Length - * `-length` - Length (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `length` - Length + * `-length` - Length (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - tags + - tags security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8062,16 +8062,16 @@ paths: get: operationId: get_tag parameters: - - in: path - name: name - schema: - type: string - required: true + - in: path + name: name + schema: + type: string + required: true tags: - - tags + - tags security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8083,7 +8083,7 @@ paths: post: operationId: preview_text tags: - - text-preview + - text-preview requestBody: content: application/json: @@ -8100,8 +8100,8 @@ paths: $ref: '#/components/schemas/TextPreviewRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8120,182 +8120,182 @@ paths: operationId: get_tracks description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: type: integer - - in: query - name: artist - schema: + explode: true + style: form + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: id - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8308,17 +8308,17 @@ paths: operationId: get_track description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8330,17 +8330,17 @@ paths: operationId: delete_track description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -8349,180 +8349,180 @@ paths: operationId: get_track_fetches description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8534,14 +8534,14 @@ paths: operationId: create_track_fetch description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks requestBody: content: application/json: @@ -8558,8 +8558,8 @@ paths: $ref: '#/components/schemas/TrackRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8572,180 +8572,180 @@ paths: operationId: get_track_libraries description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8758,180 +8758,180 @@ paths: operationId: get_track_mutations description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8943,14 +8943,14 @@ paths: operationId: create_track_mutation description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks requestBody: content: application/json: @@ -8967,8 +8967,8 @@ paths: $ref: '#/components/schemas/TrackRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -8980,97 +8980,97 @@ paths: get: operationId: get_uploads parameters: - - in: query - name: album_artist - schema: + - in: query + name: album_artist + schema: + type: string + format: uuid + - in: query + name: channel + schema: + type: string + - in: query + name: import_reference + schema: + type: string + - in: query + name: import_status + schema: + type: array + items: type: string - format: uuid - - in: query - name: channel - schema: - type: string - - in: query - name: import_reference - schema: - type: string - - in: query - name: import_status - schema: - type: array - items: - type: string - enum: - - draft - - errored - - finished - - pending - - skipped - description: |- - * `draft` - Draft - * `pending` - Pending - * `finished` - Finished - * `errored` - Errored - * `skipped` - Skipped - explode: true - style: form - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - format: uuid - - in: query - name: mimetype - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: track - schema: - type: string - format: uuid - - in: query - name: track_artist - schema: - type: string - format: uuid + enum: + - draft + - errored + - finished + - pending + - skipped + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped + explode: true + style: form + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + format: uuid + - in: query + name: mimetype + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: track + schema: + type: string + format: uuid + - in: query + name: track_artist + schema: + type: string + format: uuid tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9081,7 +9081,7 @@ paths: post: operationId: create_upload tags: - - uploads + - uploads requestBody: content: application/json: @@ -9098,8 +9098,8 @@ paths: $ref: '#/components/schemas/UploadForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -9111,17 +9111,17 @@ paths: get: operationId: get_upload parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9132,14 +9132,14 @@ paths: put: operationId: update_upload parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads requestBody: content: application/json: @@ -9156,8 +9156,8 @@ paths: $ref: '#/components/schemas/UploadForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9168,14 +9168,14 @@ paths: patch: operationId: partial_update_upload parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads requestBody: content: application/json: @@ -9191,8 +9191,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUploadForOwnerRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9203,17 +9203,17 @@ paths: delete: operationId: delete_upload parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -9221,17 +9221,17 @@ paths: get: operationId: get_upload_metadata parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9254,7 +9254,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - uploads + - uploads requestBody: content: application/json: @@ -9271,8 +9271,8 @@ paths: $ref: '#/components/schemas/UploadForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9286,33 +9286,24 @@ paths: description: Used to move an upload from one library to another. Receive a upload uuid and a privacy_level tags: - - uploads + - uploads requestBody: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' application/x-www-form-urlencoded: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' multipart/form-data: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' application/activity+json: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' - required: true + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9324,14 +9315,14 @@ paths: put: operationId: update_user parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -9348,8 +9339,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9360,14 +9351,14 @@ paths: patch: operationId: partial_update_user parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -9383,8 +9374,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUserWriteRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9396,17 +9387,17 @@ paths: get: operationId: get_user_subsonic_token parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9417,14 +9408,14 @@ paths: post: operationId: create_user_subsonic_token parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -9441,8 +9432,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9453,17 +9444,17 @@ paths: delete: operationId: delete_user_subsonic_token parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -9471,7 +9462,7 @@ paths: post: operationId: change_email tags: - - users + - users requestBody: content: application/json: @@ -9488,8 +9479,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -9500,10 +9491,10 @@ paths: operationId: get_authenticated_user description: Return information about the current user or delete it tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9515,10 +9506,10 @@ paths: operationId: delete_authenticated_user description: Return information about the current user or delete it tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -9527,7 +9518,7 @@ paths: operationId: update_settings description: Return information about the current user or delete it tags: - - users + - users requestBody: content: application/json: @@ -9544,8 +9535,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9557,29 +9548,29 @@ paths: get: operationId: get_activity_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - activity + - activity security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -9587,136 +9578,136 @@ paths: get: operationId: get_albums_2 parameters: - - in: query - name: artist - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: + type: integer + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9727,7 +9718,7 @@ paths: post: operationId: create_album_2 tags: - - albums + - albums requestBody: content: application/json: @@ -9744,8 +9735,8 @@ paths: $ref: '#/components/schemas/AlbumCreateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -9757,17 +9748,17 @@ paths: get: operationId: get_album_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9778,17 +9769,17 @@ paths: delete: operationId: delete_album_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -9796,142 +9787,142 @@ paths: get: operationId: get_album_fetches_2 parameters: - - in: query - name: artist - schema: - type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: type: integer - description: A unique integer value identifying this album. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9942,14 +9933,14 @@ paths: post: operationId: create_album_fetch_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums requestBody: content: application/json: @@ -9966,8 +9957,8 @@ paths: $ref: '#/components/schemas/AlbumRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -9979,142 +9970,142 @@ paths: get: operationId: get_album_libraries_2 parameters: - - in: query - name: artist - schema: - type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: type: integer - description: A unique integer value identifying this album. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10126,142 +10117,142 @@ paths: get: operationId: get_album_mutations_2 parameters: - - in: query - name: artist - schema: - type: string - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: channel - schema: - type: string - - in: query - name: content_category - schema: - type: string - - in: query - name: has_cover - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: has_release_date - schema: - type: boolean - - in: query - name: has_tags - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: + - in: query + name: artist + schema: + type: string + - in: query + name: artist_credit + schema: + type: array + items: type: integer - description: A unique integer value identifying this album. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: + explode: true + style: form + - in: query + name: channel + schema: + type: string + - in: query + name: content_category + schema: + type: string + - in: query + name: has_cover + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: has_release_date + schema: + type: boolean + - in: query + name: has_tags + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -artist_credit__artist__modification_date - - -creation_date - - -random - - -related - - -release_date - - -title - - artist_credit__artist__modification_date - - creation_date - - random - - related - - release_date - - title - description: |- - Ordering + enum: + - -artist_credit__artist__modification_date + - -creation_date + - -random + - -related + - -release_date + - -title + - artist_credit__artist__modification_date + - creation_date + - random + - related + - release_date + - title + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `release_date` - Release date - * `-release_date` - Release date (descending) - * `title` - Title - * `-title` - Title (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `release_date` - Release date + * `-release_date` - Release date (descending) + * `title` - Title + * `-title` - Title (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - albums + - albums security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10272,14 +10263,14 @@ paths: post: operationId: create_album_mutation_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - albums + - albums requestBody: content: application/json: @@ -10296,8 +10287,8 @@ paths: $ref: '#/components/schemas/AlbumRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10309,128 +10300,128 @@ paths: get: operationId: get_artists_2 parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10442,17 +10433,17 @@ paths: get: operationId: get_artist_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10464,134 +10455,134 @@ paths: get: operationId: get_artist_fetches_2 parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10602,14 +10593,14 @@ paths: post: operationId: create_artist_fetch_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - artists + - artists requestBody: content: application/json: @@ -10626,8 +10617,8 @@ paths: $ref: '#/components/schemas/ArtistWithAlbumsRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10639,134 +10630,134 @@ paths: get: operationId: get_artist_libraries_2 parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10778,134 +10769,134 @@ paths: get: operationId: get_artist_mutations_2 parameters: - - in: query - name: content_category - schema: + - in: query + name: content_category + schema: + type: string + - in: query + name: has_albums + schema: + type: boolean + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: has_albums - schema: - type: boolean - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -id - - -modification_date - - -name - - -random - - -related - - creation_date - - id - - modification_date - - name - - random - - related - description: |- - Ordering + enum: + - -creation_date + - -id + - -modification_date + - -name + - -random + - -related + - creation_date + - id + - modification_date + - name + - random + - related + description: |- + Ordering - * `id` - Id - * `-id` - Id (descending) - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: + * `id` - Id + * `-id` - Id (descending) + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - artists + - artists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10916,14 +10907,14 @@ paths: post: operationId: create_artist_mutation_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - artists + - artists requestBody: content: application/json: @@ -10940,8 +10931,8 @@ paths: $ref: '#/components/schemas/ArtistWithAlbumsRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -10953,7 +10944,7 @@ paths: post: operationId: create_attachment_2 tags: - - attachments + - attachments requestBody: content: application/json: @@ -10970,8 +10961,8 @@ paths: $ref: '#/components/schemas/AttachmentRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -10983,17 +10974,17 @@ paths: get: operationId: get_attachment_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - attachments + - attachments security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11004,17 +10995,17 @@ paths: delete: operationId: delete_attachment_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - attachments + - attachments security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -11022,14 +11013,14 @@ paths: get: operationId: get_attachment_proxy_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - attachments + - attachments responses: '200': content: @@ -11042,7 +11033,7 @@ paths: operationId: change_password_3 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -11059,8 +11050,8 @@ paths: $ref: '#/components/schemas/PasswordChangeRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11073,7 +11064,7 @@ paths: operationId: reset_password_2 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -11090,9 +11081,9 @@ paths: $ref: '#/components/schemas/PasswordResetRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] - - {} + - oauth2: [] + - ApplicationToken: [] + - {} responses: '200': content: @@ -11105,7 +11096,7 @@ paths: operationId: confirm_password_reset_2 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -11122,9 +11113,9 @@ paths: $ref: '#/components/schemas/PasswordResetConfirmRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] - - {} + - oauth2: [] + - ApplicationToken: [] + - {} responses: '200': content: @@ -11137,7 +11128,7 @@ paths: operationId: register_2 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -11154,8 +11145,8 @@ paths: $ref: '#/components/schemas/RegisterRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -11168,7 +11159,7 @@ paths: operationId: change_password_4 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -11185,8 +11176,8 @@ paths: $ref: '#/components/schemas/PasswordChangeRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11199,7 +11190,7 @@ paths: operationId: verify_email_2 description: The type of the None singleton. tags: - - auth + - auth requestBody: content: application/json: @@ -11216,9 +11207,9 @@ paths: $ref: '#/components/schemas/VerifyEmailRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] - - {} + - oauth2: [] + - ApplicationToken: [] + - {} responses: '200': description: No response body @@ -11235,10 +11226,10 @@ paths: Returns UserModel fields. tags: - - auth + - auth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11258,7 +11249,7 @@ paths: Returns UserModel fields. tags: - - auth + - auth requestBody: content: application/json: @@ -11275,8 +11266,8 @@ paths: $ref: '#/components/schemas/UserDetailsRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11296,7 +11287,7 @@ paths: Returns UserModel fields. tags: - - auth + - auth requestBody: content: application/json: @@ -11312,8 +11303,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUserDetailsRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11325,75 +11316,75 @@ paths: get: operationId: get_channels_2 parameters: - - in: query - name: external - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -modification_date - - -random - - creation_date - - modification_date - - random - description: |- - Ordering + - in: query + name: external + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: ordering + schema: + type: array + items: + type: string + enum: + - -creation_date + - -modification_date + - -random + - creation_date + - modification_date + - random + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `random` - Random - * `-random` - Random (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `random` - Random + * `-random` - Random (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: subscribed + schema: + type: boolean + - in: query + name: tag + schema: + type: array + items: type: string - - in: query - name: scope - schema: - type: string - - in: query - name: subscribed - schema: - type: boolean - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form + explode: true + style: form tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11404,7 +11395,7 @@ paths: post: operationId: create_channel_2 tags: - - channels + - channels requestBody: content: application/json: @@ -11421,8 +11412,8 @@ paths: $ref: '#/components/schemas/ChannelCreateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -11434,17 +11425,17 @@ paths: get: operationId: get_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11455,14 +11446,14 @@ paths: put: operationId: update_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -11479,8 +11470,8 @@ paths: $ref: '#/components/schemas/ChannelUpdateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11491,14 +11482,14 @@ paths: patch: operationId: partial_update_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -11514,8 +11505,8 @@ paths: schema: $ref: '#/components/schemas/PatchedChannelUpdateRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11526,17 +11517,17 @@ paths: delete: operationId: delete_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -11544,17 +11535,17 @@ paths: get: operationId: get_channel_rss_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11566,14 +11557,14 @@ paths: post: operationId: subscribe_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -11590,8 +11581,8 @@ paths: $ref: '#/components/schemas/ChannelRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11603,14 +11594,14 @@ paths: post: operationId: unsubscribe_channel_4 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels requestBody: content: application/json: @@ -11627,25 +11618,25 @@ paths: $ref: '#/components/schemas/ChannelRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body delete: operationId: unsubscribe_channel_3 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -11653,10 +11644,10 @@ paths: get: operationId: get_channel_metadata_choices_2 tags: - - channels + - channels security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11668,7 +11659,7 @@ paths: post: operationId: subscribe_channel_rss_2 tags: - - channels + - channels requestBody: content: application/json: @@ -11685,8 +11676,8 @@ paths: $ref: '#/components/schemas/ChannelRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11698,41 +11689,41 @@ paths: get: operationId: get_favorite_tracks_2 parameters: - - in: query - name: hidden - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string + - in: query + name: hidden + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11743,7 +11734,7 @@ paths: post: operationId: favorite_track_2 tags: - - favorites + - favorites requestBody: content: application/json: @@ -11760,8 +11751,8 @@ paths: $ref: '#/components/schemas/UserTrackFavoriteWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -11773,17 +11764,17 @@ paths: delete: operationId: delete_favorite_track_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track favorite. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track favorite. + required: true tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -11795,10 +11786,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display favorites status in the UI tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11810,7 +11801,7 @@ paths: post: operationId: unfavorite_track_4 tags: - - favorites + - favorites requestBody: content: application/json: @@ -11827,8 +11818,8 @@ paths: $ref: '#/components/schemas/UserTrackFavoriteWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11839,10 +11830,10 @@ paths: delete: operationId: unfavorite_track_3 tags: - - favorites + - favorites security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -11850,17 +11841,17 @@ paths: get: operationId: get_federation_actor_2 parameters: - - in: path - name: full_username - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: full_username + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11872,17 +11863,17 @@ paths: get: operationId: get_federation_actor_library_2 parameters: - - in: path - name: full_username - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: full_username + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11894,29 +11885,29 @@ paths: get: operationId: get_federation_domains_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11928,17 +11919,17 @@ paths: get: operationId: get_federation_domain_2 parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -11950,7 +11941,7 @@ paths: post: operationId: create_federation_fetch_2 tags: - - federation + - federation requestBody: content: application/json: @@ -11967,8 +11958,8 @@ paths: $ref: '#/components/schemas/FetchRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -11980,17 +11971,17 @@ paths: get: operationId: get_federation_fetch_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this fetch. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this fetch. + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12002,33 +11993,33 @@ paths: get: operationId: get_federation_library_follows_2 parameters: - - in: query - name: approved - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - in: query + name: approved + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12039,7 +12030,7 @@ paths: post: operationId: create_federation_library_follow_2 tags: - - federation + - federation requestBody: content: application/json: @@ -12056,8 +12047,8 @@ paths: $ref: '#/components/schemas/LibraryFollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -12069,17 +12060,17 @@ paths: get: operationId: get_federation_library_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12090,17 +12081,17 @@ paths: delete: operationId: delete_federation_library_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -12108,14 +12099,14 @@ paths: post: operationId: accept_federation_library_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12132,8 +12123,8 @@ paths: $ref: '#/components/schemas/LibraryFollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '404': description: No response body @@ -12143,14 +12134,14 @@ paths: post: operationId: reject_federation_library_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12167,8 +12158,8 @@ paths: $ref: '#/components/schemas/LibraryFollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12184,10 +12175,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display subscription status in the UI tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12199,29 +12190,29 @@ paths: get: operationId: get_federation_received_follows_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12232,7 +12223,7 @@ paths: post: operationId: create_federation_user_follow_2 tags: - - federation + - federation requestBody: content: application/json: @@ -12249,8 +12240,8 @@ paths: $ref: '#/components/schemas/FollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -12262,17 +12253,17 @@ paths: get: operationId: get_federation_user_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12283,17 +12274,17 @@ paths: delete: operationId: delete_federation_user_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -12301,14 +12292,14 @@ paths: post: operationId: accept_federation_user_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12325,8 +12316,8 @@ paths: $ref: '#/components/schemas/FollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '404': description: No response body @@ -12336,14 +12327,14 @@ paths: post: operationId: reject_federation_user_follow_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12360,8 +12351,8 @@ paths: $ref: '#/components/schemas/FollowRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12377,10 +12368,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display subscription status in the UI tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12392,45 +12383,45 @@ paths: get: operationId: get_federation_inboxes_2 parameters: - - in: query - name: activity__actor - schema: - type: integer - - in: query - name: activity__type - schema: - type: string - - in: query - name: before - schema: - type: number - - in: query - name: is_read - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - in: query + name: activity__actor + schema: + type: integer + - in: query + name: activity__type + schema: + type: string + - in: query + name: before + schema: + type: number + - in: query + name: is_read + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12442,17 +12433,17 @@ paths: get: operationId: get_federation_inbox_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this inbox item. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inbox item. + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12463,14 +12454,14 @@ paths: put: operationId: update_federation_inbox_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this inbox item. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inbox item. + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12487,8 +12478,8 @@ paths: $ref: '#/components/schemas/InboxItemRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12499,14 +12490,14 @@ paths: patch: operationId: partial_update_federation_inbox_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this inbox item. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this inbox item. + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12522,8 +12513,8 @@ paths: schema: $ref: '#/components/schemas/PatchedInboxItemRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12546,7 +12537,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - federation + - federation requestBody: content: application/json: @@ -12563,8 +12554,8 @@ paths: $ref: '#/components/schemas/InboxItemRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12576,17 +12567,17 @@ paths: get: operationId: get_federation_library_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12598,14 +12589,14 @@ paths: post: operationId: create_federation_library_scan_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - federation + - federation requestBody: content: application/json: @@ -12622,8 +12613,8 @@ paths: $ref: '#/components/schemas/LibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12635,7 +12626,7 @@ paths: post: operationId: create_federation_library_fetch_2 tags: - - federation + - federation requestBody: content: application/json: @@ -12652,8 +12643,8 @@ paths: $ref: '#/components/schemas/LibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12665,45 +12656,45 @@ paths: get: operationId: get_history_listenings_2 parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: hidden - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: scope - schema: - type: string - - in: query - name: username - schema: - type: string + - in: query + name: domain + schema: + type: string + - in: query + name: hidden + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: scope + schema: + type: string + - in: query + name: username + schema: + type: string tags: - - history + - history security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12714,7 +12705,7 @@ paths: post: operationId: create_history_listening_2 tags: - - history + - history requestBody: content: application/json: @@ -12731,8 +12722,8 @@ paths: $ref: '#/components/schemas/ListeningWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -12744,17 +12735,17 @@ paths: get: operationId: get_history_listening_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this listening. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this listening. + required: true tags: - - history + - history security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12771,17 +12762,17 @@ paths: - batch update preferences - update a single preference parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string tags: - - instance + - instance security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12800,17 +12791,17 @@ paths: - batch update preferences - update a single preference parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this Global preference. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Global preference. + required: true tags: - - instance + - instance security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12826,14 +12817,14 @@ paths: - batch update preferences - update a single preference parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this Global preference. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Global preference. + required: true tags: - - instance + - instance requestBody: content: application/json: @@ -12850,8 +12841,8 @@ paths: $ref: '#/components/schemas/GlobalPreferenceRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12867,14 +12858,14 @@ paths: - batch update preferences - update a single preference parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this Global preference. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this Global preference. + required: true tags: - - instance + - instance requestBody: content: application/json: @@ -12890,8 +12881,8 @@ paths: schema: $ref: '#/components/schemas/PatchedGlobalPreferenceRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12908,7 +12899,7 @@ paths: this is a long method because we ensure everything is valid before actually persisting the changes tags: - - instance + - instance requestBody: content: application/json: @@ -12925,8 +12916,8 @@ paths: $ref: '#/components/schemas/GlobalPreferenceRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -12936,21 +12927,21 @@ paths: description: '' /api/v2/instance/nodeinfo/2.1/: get: - operationId: getNodeInfo21 + operationId: getNodeInfo20_2 tags: - - instance + - instance responses: '200': content: application/json: schema: - $ref: '#/components/schemas/NodeInfo21' + $ref: '#/components/schemas/NodeInfo20' description: '' /api/v2/instance/settings/: get: operationId: get_instance_settings_2 tags: - - instance + - instance responses: '200': content: @@ -12962,7 +12953,7 @@ paths: get: operationId: get_spa_manifest_2 tags: - - instance + - instance responses: '200': content: @@ -12974,49 +12965,49 @@ paths: get: operationId: get_libraries_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: privacy_level - schema: - type: string - enum: - - everyone - - instance - - me - description: |- - * `me` - Only me - * `instance` - Everyone on my instance, and my followers - * `everyone` - Everyone, including people on other instances - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: privacy_level + schema: + type: string + enum: + - everyone + - instance + - me + description: |- + * `me` - Only me + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13028,17 +13019,17 @@ paths: get: operationId: get_library_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13050,17 +13041,17 @@ paths: get: operationId: get_library_fs_import_2 tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body post: operationId: create_library_fs_import_2 tags: - - libraries + - libraries requestBody: content: application/json: @@ -13077,18 +13068,18 @@ paths: $ref: '#/components/schemas/LibraryForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body delete: operationId: delete_library_fs_import_2 tags: - - libraries + - libraries security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -13096,29 +13087,29 @@ paths: get: operationId: get_licenses_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - licenses + - licenses security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13130,17 +13121,17 @@ paths: get: operationId: get_license_2 parameters: - - in: path - name: code - schema: - type: string - description: A unique value identifying this license. - required: true + - in: path + name: code + schema: + type: string + description: A unique value identifying this license. + required: true tags: - - licenses + - licenses security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13152,17 +13143,17 @@ paths: get: operationId: get_listen_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - listen + - listen security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13175,63 +13166,63 @@ paths: get: operationId: admin_get_accounts_2 parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: local - schema: - type: boolean - - in: query - name: manually_approves_followers - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: type - schema: - type: string - enum: - - Application - - Group - - Organization - - Person - - Service - - Tombstone - description: |- - * `Person` - Person - * `Tombstone` - Tombstone - * `Application` - Application - * `Group` - Group - * `Organization` - Organization - * `Service` - Service + - in: query + name: domain + schema: + type: string + - in: query + name: local + schema: + type: boolean + - in: query + name: manually_approves_followers + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: type + schema: + type: string + enum: + - Application + - Group + - Organization + - Person + - Service + - Tombstone + description: |- + * `Person` - Person + * `Tombstone` - Tombstone + * `Application` - Application + * `Group` - Group + * `Organization` - Organization + * `Service` - Service tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13243,17 +13234,17 @@ paths: get: operationId: admin_get_account_2 parameters: - - in: path - name: id - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: id + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13265,17 +13256,17 @@ paths: get: operationId: admin_get_account_stats_2 parameters: - - in: path - name: id - schema: - type: string - pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ - required: true + - in: path + name: id + schema: + type: string + pattern: ^([a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+)$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13298,7 +13289,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -13315,8 +13306,8 @@ paths: $ref: '#/components/schemas/ManageActorRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13328,33 +13319,33 @@ paths: get: operationId: admin_get_channels_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13366,17 +13357,17 @@ paths: get: operationId: admin_get_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13387,17 +13378,17 @@ paths: delete: operationId: admin_delete_channel_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -13405,17 +13396,17 @@ paths: get: operationId: admin_get_channel_stats_2 parameters: - - in: path - name: composite - schema: - type: string - pattern: ^[^/]+$ - required: true + - in: path + name: composite + schema: + type: string + pattern: ^[^/]+$ + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13427,41 +13418,41 @@ paths: get: operationId: admin_get_federation_domains_2 parameters: - - in: query - name: allowed - schema: - type: boolean - - in: query - name: name - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - in: query + name: allowed + schema: + type: boolean + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13472,7 +13463,7 @@ paths: post: operationId: admin_create_federation_domain_2 tags: - - manage + - manage requestBody: content: application/json: @@ -13489,8 +13480,8 @@ paths: $ref: '#/components/schemas/ManageDomainRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -13502,17 +13493,17 @@ paths: get: operationId: admin_get_federation_domain_2 parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13523,14 +13514,14 @@ paths: put: operationId: admin_update_federation_domain_2 parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -13546,8 +13537,8 @@ paths: schema: $ref: '#/components/schemas/ManageDomainUpdateRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13558,14 +13549,14 @@ paths: patch: operationId: admin_partial_update_federation_domain_2 parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -13581,8 +13572,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageDomainUpdateRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13594,17 +13585,17 @@ paths: get: operationId: admin_get_federation_domain_nodeinfo_2 parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13616,17 +13607,17 @@ paths: get: operationId: admin_get_federation_domain_stats_2 parameters: - - in: path - name: name - schema: - type: string - description: A unique value identifying this domain. - required: true + - in: path + name: name + schema: + type: string + description: A unique value identifying this domain. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13649,7 +13640,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -13666,8 +13657,8 @@ paths: $ref: '#/components/schemas/ManageDomainRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13679,54 +13670,54 @@ paths: get: operationId: admin_get_albums_2 parameters: - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: fid - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: + - in: query + name: artist_credit + schema: + type: array + items: type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: title - schema: - type: string + explode: true + style: form + - in: query + name: fid + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: title + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13738,17 +13729,17 @@ paths: get: operationId: admin_get_album_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13759,17 +13750,17 @@ paths: delete: operationId: admin_delete_album_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -13777,17 +13768,17 @@ paths: get: operationId: admin_get_library_album_stats_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this album. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this album. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13810,7 +13801,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -13827,8 +13818,8 @@ paths: $ref: '#/components/schemas/ManageAlbumRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13840,58 +13831,58 @@ paths: get: operationId: admin_get_artists_2 parameters: - - in: query - name: content_category - schema: - type: string - enum: - - music - - other - - podcast - description: |- - * `music` - music - * `podcast` - podcast - * `other` - other - - in: query - name: fid - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: name - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - in: query + name: content_category + schema: + type: string + enum: + - music + - other + - podcast + description: |- + * `music` - music + * `podcast` - podcast + * `other` - other + - in: query + name: fid + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: name + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13903,17 +13894,17 @@ paths: get: operationId: admin_get_artist_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13924,17 +13915,17 @@ paths: delete: operationId: admin_delete_artist_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -13942,17 +13933,17 @@ paths: get: operationId: admin_get_library_artist_stats_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this artist. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this artist. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -13975,7 +13966,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -13992,8 +13983,8 @@ paths: $ref: '#/components/schemas/ManageArtistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14005,75 +13996,75 @@ paths: get: operationId: admin_get_libraries_2 parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: fid - schema: - type: string - - in: query - name: name - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -followers_count - - -uploads_count - - creation_date - - followers_count - - uploads_count - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `uploads_count` - Uploads count - * `-uploads_count` - Uploads count (descending) - * `followers_count` - Followers count - * `-followers_count` - Followers count (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: privacy_level - schema: + - in: query + name: domain + schema: + type: string + - in: query + name: fid + schema: + type: string + - in: query + name: name + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string enum: - - everyone - - instance - - me - description: |- - * `me` - Only me - * `instance` - Everyone on my instance, and my followers - * `everyone` - Everyone, including people on other instances - - in: query - name: q - schema: - type: string + - -creation_date + - -followers_count + - -uploads_count + - creation_date + - followers_count + - uploads_count + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `uploads_count` - Uploads count + * `-uploads_count` - Uploads count (descending) + * `followers_count` - Followers count + * `-followers_count` - Followers count (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: privacy_level + schema: + type: string + enum: + - everyone + - instance + - me + description: |- + * `me` - Only me + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14085,17 +14076,17 @@ paths: get: operationId: admin_get_library_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14106,14 +14097,14 @@ paths: put: operationId: admin_update_library_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -14130,8 +14121,8 @@ paths: $ref: '#/components/schemas/ManageLibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14142,14 +14133,14 @@ paths: patch: operationId: admin_partial_update_library_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -14165,8 +14156,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageLibraryRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14177,17 +14168,17 @@ paths: delete: operationId: admin_delete_library_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -14195,17 +14186,17 @@ paths: get: operationId: admin_get_library_stats_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14228,7 +14219,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -14245,8 +14236,8 @@ paths: $ref: '#/components/schemas/ManageLibraryRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14258,62 +14249,62 @@ paths: get: operationId: admin_get_tracks_2 parameters: - - in: query - name: album - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist_credit + schema: + type: array + items: type: integer - - in: query - name: artist_credit - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: fid - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: title - schema: - type: string + explode: true + style: form + - in: query + name: fid + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: title + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14325,17 +14316,17 @@ paths: get: operationId: admin_get_track_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14346,17 +14337,17 @@ paths: delete: operationId: admin_delete_track_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -14364,17 +14355,17 @@ paths: get: operationId: admin_get_track_stats_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14397,7 +14388,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -14414,8 +14405,8 @@ paths: $ref: '#/components/schemas/ManageTrackRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14427,99 +14418,99 @@ paths: get: operationId: admin_get_uploads_2 parameters: - - in: query - name: domain - schema: - type: string - - in: query - name: fid - schema: - type: string - - in: query - name: import_reference - schema: - type: string - - in: query - name: import_status - schema: + - in: query + name: domain + schema: + type: string + - in: query + name: fid + schema: + type: string + - in: query + name: import_reference + schema: + type: string + - in: query + name: import_status + schema: + type: string + enum: + - draft + - errored + - finished + - pending + - skipped + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped + - in: query + name: mimetype + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string enum: - - draft - - errored - - finished - - pending - - skipped - description: |- - * `draft` - Draft - * `pending` - Pending - * `finished` - Finished - * `errored` - Errored - * `skipped` - Skipped - - in: query - name: mimetype - schema: - type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -accessed_date - - -bitrate - - -creation_date - - -duration - - -modification_date - - -size - - accessed_date - - bitrate - - creation_date - - duration - - modification_date - - size - description: |- - Ordering + - -accessed_date + - -bitrate + - -creation_date + - -duration + - -modification_date + - -size + - accessed_date + - bitrate + - creation_date + - duration + - modification_date + - size + description: |- + Ordering - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `modification_date` - Modification date - * `-modification_date` - Modification date (descending) - * `accessed_date` - Accessed date - * `-accessed_date` - Accessed date (descending) - * `size` - Size - * `-size` - Size (descending) - * `bitrate` - Bitrate - * `-bitrate` - Bitrate (descending) - * `duration` - Duration - * `-duration` - Duration (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: privacy_level - schema: - type: string - - in: query - name: q - schema: - type: string + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `modification_date` - Modification date + * `-modification_date` - Modification date (descending) + * `accessed_date` - Accessed date + * `-accessed_date` - Accessed date (descending) + * `size` - Size + * `-size` - Size (descending) + * `bitrate` - Bitrate + * `-bitrate` - Bitrate (descending) + * `duration` - Duration + * `-duration` - Duration (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: privacy_level + schema: + type: string + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14531,17 +14522,17 @@ paths: get: operationId: admin_get_upload_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14552,17 +14543,17 @@ paths: delete: operationId: admin_delete_upload_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -14581,7 +14572,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -14598,8 +14589,8 @@ paths: $ref: '#/components/schemas/ManageUploadRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14611,61 +14602,61 @@ paths: get: operationId: moderation_get_instance_policies_2 parameters: - - in: query - name: block_all - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: reject_media - schema: - type: boolean - - in: query - name: silence_activity - schema: - type: boolean - - in: query - name: silence_notifications - schema: - type: boolean - - in: query - name: target_account_domain - schema: - type: string - - in: query - name: target_account_username - schema: - type: string - - in: query - name: target_domain - schema: - type: string + - in: query + name: block_all + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: reject_media + schema: + type: boolean + - in: query + name: silence_activity + schema: + type: boolean + - in: query + name: silence_notifications + schema: + type: boolean + - in: query + name: target_account_domain + schema: + type: string + - in: query + name: target_account_username + schema: + type: string + - in: query + name: target_domain + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14676,7 +14667,7 @@ paths: post: operationId: moderation_create_instance_policy_2 tags: - - manage + - manage requestBody: content: application/json: @@ -14693,8 +14684,8 @@ paths: $ref: '#/components/schemas/ManageInstancePolicyRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -14706,17 +14697,17 @@ paths: get: operationId: moderation_get_instance_policy_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14727,14 +14718,14 @@ paths: put: operationId: moderation_update_instance_policy_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -14751,8 +14742,8 @@ paths: $ref: '#/components/schemas/ManageInstancePolicyRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14763,14 +14754,14 @@ paths: patch: operationId: moderation_partial_update_instance_policy_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -14786,8 +14777,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageInstancePolicyRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14798,17 +14789,17 @@ paths: delete: operationId: moderation_delete_instance_policy_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this instance policy. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this instance policy. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -14816,33 +14807,33 @@ paths: get: operationId: moderation_get_notes_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14853,7 +14844,7 @@ paths: post: operationId: moderation_create_note_2 tags: - - manage + - manage requestBody: content: application/json: @@ -14870,8 +14861,8 @@ paths: $ref: '#/components/schemas/ManageNoteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -14883,17 +14874,17 @@ paths: get: operationId: moderation_get_note_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14904,17 +14895,17 @@ paths: delete: operationId: moderation_delete_note_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -14922,57 +14913,57 @@ paths: get: operationId: moderation_get_reports_2 parameters: - - in: query - name: is_handled - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: submitter_email - schema: - type: string - - in: query - name: type - schema: - type: string - enum: - - illegal_content - - invalid_metadata - - offensive_content - - other - - takedown_request - description: |- - * `takedown_request` - Takedown request - * `invalid_metadata` - Invalid metadata - * `illegal_content` - Illegal content - * `offensive_content` - Offensive content - * `other` - Other + - in: query + name: is_handled + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: submitter_email + schema: + type: string + - in: query + name: type + schema: + type: string + enum: + - illegal_content + - invalid_metadata + - offensive_content + - other + - takedown_request + description: |- + * `takedown_request` - Takedown request + * `invalid_metadata` - Invalid metadata + * `illegal_content` - Illegal content + * `offensive_content` - Offensive content + * `other` - Other tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -14984,17 +14975,17 @@ paths: get: operationId: moderation_get_report_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15005,14 +14996,14 @@ paths: put: operationId: moderation_update_report_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15029,8 +15020,8 @@ paths: $ref: '#/components/schemas/ManageReportRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15041,14 +15032,14 @@ paths: patch: operationId: moderation_partial_update_report_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15064,8 +15055,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageReportRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15077,52 +15068,52 @@ paths: get: operationId: moderation_get_requests_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: status - schema: - type: string - enum: - - approved - - pending - - refused - description: |- - * `pending` - Pending - * `refused` - Refused - * `approved` - Approved - - in: query - name: type - schema: - type: string - enum: - - signup - description: '* `signup` - Sign-up' + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: status + schema: + type: string + enum: + - approved + - pending + - refused + description: |- + * `pending` - Pending + * `refused` - Refused + * `approved` - Approved + - in: query + name: type + schema: + type: string + enum: + - signup + description: '* `signup` - Sign-up' tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15134,17 +15125,17 @@ paths: get: operationId: moderation_get_request_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15155,14 +15146,14 @@ paths: put: operationId: moderation_update_request_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15179,8 +15170,8 @@ paths: $ref: '#/components/schemas/ManageUserRequestRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15191,14 +15182,14 @@ paths: patch: operationId: moderation_partial_update_request_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15214,8 +15205,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageUserRequestRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15227,33 +15218,33 @@ paths: get: operationId: admin_get_tags_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15264,7 +15255,7 @@ paths: post: operationId: admin_create_tag_2 tags: - - manage + - manage requestBody: content: application/json: @@ -15281,8 +15272,8 @@ paths: $ref: '#/components/schemas/ManageTagRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -15294,16 +15285,16 @@ paths: get: operationId: admin_get_tag_2 parameters: - - in: path - name: name - schema: - type: string - required: true + - in: path + name: name + schema: + type: string + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15314,16 +15305,16 @@ paths: delete: operationId: admin_delete_tag_2 parameters: - - in: path - name: name - schema: - type: string - required: true + - in: path + name: name + schema: + type: string + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -15342,7 +15333,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -15359,8 +15350,8 @@ paths: $ref: '#/components/schemas/ManageTagRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15372,37 +15363,37 @@ paths: get: operationId: admin_get_invitations_2 parameters: - - in: query - name: is_open - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + - in: query + name: is_open + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15413,7 +15404,7 @@ paths: post: operationId: admin_create_invitation_2 tags: - - manage + - manage requestBody: content: application/json: @@ -15429,8 +15420,8 @@ paths: schema: $ref: '#/components/schemas/ManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -15442,17 +15433,17 @@ paths: get: operationId: admin_get_invitation_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15463,14 +15454,14 @@ paths: put: operationId: admin_update_invitation_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15486,8 +15477,8 @@ paths: schema: $ref: '#/components/schemas/ManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15498,14 +15489,14 @@ paths: patch: operationId: admin_partial_update_invitation_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this invitation. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this invitation. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15521,8 +15512,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15545,7 +15536,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - manage + - manage requestBody: content: application/json: @@ -15561,8 +15552,8 @@ paths: schema: $ref: '#/components/schemas/ManageInvitationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15574,71 +15565,71 @@ paths: get: operationId: admin_get_users_2 parameters: - - in: query - name: is_active - schema: - type: boolean - - in: query - name: is_staff - schema: - type: boolean - - in: query - name: is_superuser - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: permission_library - schema: - type: boolean - - in: query - name: permission_moderation - schema: - type: boolean - - in: query - name: permission_settings - schema: - type: boolean - - in: query - name: privacy_level - schema: - type: string - enum: - - everyone - - followers - - instance - - me - description: |- - * `me` - Only me - * `followers` - Me and my followers - * `instance` - Everyone on my instance, and my followers - * `everyone` - Everyone, including people on other instances - - in: query - name: q - schema: - type: string + - in: query + name: is_active + schema: + type: boolean + - in: query + name: is_staff + schema: + type: boolean + - in: query + name: is_superuser + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: permission_library + schema: + type: boolean + - in: query + name: permission_moderation + schema: + type: boolean + - in: query + name: permission_settings + schema: + type: boolean + - in: query + name: privacy_level + schema: + type: string + enum: + - everyone + - followers + - instance + - me + description: |- + * `me` - Only me + * `followers` - Me and my followers + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances + - in: query + name: q + schema: + type: string tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15650,17 +15641,17 @@ paths: get: operationId: admin_get_user_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this user. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true tags: - - manage + - manage security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15671,14 +15662,14 @@ paths: put: operationId: admin_update_user_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this user. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15694,8 +15685,8 @@ paths: schema: $ref: '#/components/schemas/ManageUserRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15706,14 +15697,14 @@ paths: patch: operationId: admin_partial_update_user_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this user. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this user. + required: true tags: - - manage + - manage requestBody: content: application/json: @@ -15729,8 +15720,8 @@ paths: schema: $ref: '#/components/schemas/PatchedManageUserRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15742,29 +15733,29 @@ paths: get: operationId: get_moderation_content_filters_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - moderation + - moderation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15775,7 +15766,7 @@ paths: post: operationId: create_moderation_content_filter_2 tags: - - moderation + - moderation requestBody: content: application/json: @@ -15792,8 +15783,8 @@ paths: $ref: '#/components/schemas/UserFilterRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -15805,17 +15796,17 @@ paths: get: operationId: get_moderation_content_filter_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - moderation + - moderation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15826,17 +15817,17 @@ paths: delete: operationId: delete_moderation_content_filter_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - moderation + - moderation security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -15844,7 +15835,7 @@ paths: post: operationId: create_moderation_report_2 tags: - - moderation + - moderation requestBody: content: application/json: @@ -15861,8 +15852,8 @@ paths: $ref: '#/components/schemas/ReportRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -15874,45 +15865,45 @@ paths: get: operationId: get_mutations_2 parameters: - - in: query - name: is_applied - schema: - type: boolean - - in: query - name: is_approved - schema: - type: boolean - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: type - schema: - type: string + - in: query + name: is_applied + schema: + type: boolean + - in: query + name: is_approved + schema: + type: boolean + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: type + schema: + type: string tags: - - mutations + - mutations security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15924,17 +15915,17 @@ paths: get: operationId: get_mutation_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -15945,17 +15936,17 @@ paths: delete: operationId: delete_mutation_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -15963,14 +15954,14 @@ paths: post: operationId: approve_mutation_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations requestBody: content: application/json: @@ -15987,8 +15978,8 @@ paths: $ref: '#/components/schemas/APIMutationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16000,14 +15991,14 @@ paths: post: operationId: reject_mutation_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - mutations + - mutations requestBody: content: application/json: @@ -16024,8 +16015,8 @@ paths: $ref: '#/components/schemas/APIMutationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16037,29 +16028,29 @@ paths: get: operationId: get_oauth_apps_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16070,7 +16061,7 @@ paths: post: operationId: create_oauth_app_2 tags: - - oauth + - oauth requestBody: content: application/json: @@ -16087,8 +16078,8 @@ paths: $ref: '#/components/schemas/CreateApplicationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -16100,16 +16091,16 @@ paths: get: operationId: get_oauth_app_2 parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16120,13 +16111,13 @@ paths: put: operationId: update_oauth_app_2 parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth requestBody: content: application/json: @@ -16143,8 +16134,8 @@ paths: $ref: '#/components/schemas/ApplicationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16155,13 +16146,13 @@ paths: patch: operationId: partial_update_oauth_app_2 parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth requestBody: content: application/json: @@ -16177,8 +16168,8 @@ paths: schema: $ref: '#/components/schemas/PatchedApplicationRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16189,16 +16180,16 @@ paths: delete: operationId: delete_oauth_app_2 parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -16206,13 +16197,13 @@ paths: post: operationId: refresh_oauth_token_2 parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth requestBody: content: application/json: @@ -16229,8 +16220,8 @@ paths: $ref: '#/components/schemas/CreateApplicationRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16243,10 +16234,10 @@ paths: operationId: get_oauth_authorize description: 'Handle GET requests: instantiate a blank version of the form.' tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -16256,20 +16247,20 @@ paths: Handle POST requests: instantiate a form instance with the passed POST variables and then check if it's valid. tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body put: operationId: update_oauth_authorize tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -16280,17 +16271,17 @@ paths: This is a viewset that list applications that have access to the request user account, to allow revoking tokens easily. parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16307,16 +16298,16 @@ paths: This is a viewset that list applications that have access to the request user account, to allow revoking tokens easily. parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16330,16 +16321,16 @@ paths: This is a viewset that list applications that have access to the request user account, to allow revoking tokens easily. parameters: - - in: path - name: client_id - schema: - type: string - required: true + - in: path + name: client_id + schema: + type: string + required: true tags: - - oauth + - oauth security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -16347,10 +16338,10 @@ paths: get: operationId: get_oembed_2 tags: - - oembed + - oembed security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16362,68 +16353,68 @@ paths: get: operationId: get_playlists_2 parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: - type: integer - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: track - schema: - type: integer + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: integer + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: track + schema: + type: integer tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16437,15 +16428,15 @@ paths: post: operationId: create_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf + - in: query + name: format + schema: + type: string + enum: + - json + - xspf tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -16462,8 +16453,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -16478,24 +16469,24 @@ paths: get: operationId: get_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16509,21 +16500,21 @@ paths: put: operationId: update_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -16540,8 +16531,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16555,21 +16546,21 @@ paths: patch: operationId: partial_update_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -16585,8 +16576,8 @@ paths: schema: $ref: '#/components/schemas/PatchedPlaylistRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16600,24 +16591,24 @@ paths: delete: operationId: delete_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -16625,21 +16616,21 @@ paths: post: operationId: add_to_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -16656,8 +16647,8 @@ paths: $ref: '#/components/schemas/PlaylistAddManyRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16672,24 +16663,24 @@ paths: get: operationId: get_playlist_albums_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16704,24 +16695,24 @@ paths: get: operationId: get_playlist_artits_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16736,24 +16727,24 @@ paths: delete: operationId: clear_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -16761,21 +16752,21 @@ paths: post: operationId: reorder_track_in_playlist_2 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -16792,8 +16783,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16808,21 +16799,21 @@ paths: post: operationId: remove_from_playlist_4 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists requestBody: content: application/octet-stream: @@ -16839,8 +16830,8 @@ paths: $ref: '#/components/schemas/PlaylistRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16854,24 +16845,24 @@ paths: delete: operationId: remove_from_playlist_3 parameters: - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -16879,74 +16870,74 @@ paths: get: operationId: get_playlist_tracks_2 parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: - type: integer - - in: query - name: format - schema: - type: string - enum: - - json - - xspf - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this playlist. - required: true - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: track - schema: - type: integer + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: integer + - in: query + name: format + schema: + type: string + enum: + - json + - xspf + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this playlist. + required: true + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: track + schema: + type: integer tags: - - playlists + - playlists security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -16961,39 +16952,39 @@ paths: get: operationId: get_plugins_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body post: operationId: create_plugin_2 tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': description: No response body @@ -17001,17 +16992,17 @@ paths: get: operationId: get_plugin_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17019,17 +17010,17 @@ paths: post: operationId: disable_plugin_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17037,17 +17028,17 @@ paths: post: operationId: enable_plugin_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17055,17 +17046,17 @@ paths: post: operationId: create_plugin_scan_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this plugin configuration. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this plugin configuration. + required: true tags: - - plugins + - plugins security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17073,17 +17064,17 @@ paths: get: operationId: get_provider_musicbrainz_artist parameters: - - in: path - name: uuid - schema: - type: string - pattern: ^[0-9a-z-]+$ - required: true + - in: path + name: uuid + schema: + type: string + pattern: ^[0-9a-z-]+$ + required: true tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17091,17 +17082,17 @@ paths: get: operationId: get_provider_musicbrainz_release_group_browse parameters: - - in: path - name: artist_uuid - schema: - type: string - pattern: ^[0-9a-z-]+$ - required: true + - in: path + name: artist_uuid + schema: + type: string + pattern: ^[0-9a-z-]+$ + required: true tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17109,17 +17100,17 @@ paths: get: operationId: get_provider_musicbrainz_release parameters: - - in: path - name: uuid - schema: - type: string - pattern: ^[0-9a-z-]+$ - required: true + - in: path + name: uuid + schema: + type: string + pattern: ^[0-9a-z-]+$ + required: true tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17127,17 +17118,17 @@ paths: get: operationId: get_provider_musicbrainz_release_browse parameters: - - in: path - name: release_group_uuid - schema: - type: string - pattern: ^[0-9a-z-]+$ - required: true + - in: path + name: release_group_uuid + schema: + type: string + pattern: ^[0-9a-z-]+$ + required: true tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17145,10 +17136,10 @@ paths: get: operationId: get_provider_musicbrainz_search_artist tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17156,10 +17147,10 @@ paths: get: operationId: get_provider_musicbrainz_search_recording tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17167,10 +17158,10 @@ paths: get: operationId: get_provider_musicbrainz_search_release tags: - - providers + - providers security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -17178,53 +17169,53 @@ paths: get: operationId: get_radios_2 parameters: - - in: query - name: name - schema: - type: string - - in: query - name: name__icontains - schema: - type: string - - in: query - name: name__iexact - schema: - type: string - - in: query - name: name__startswith - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string + - in: query + name: name + schema: + type: string + - in: query + name: name__icontains + schema: + type: string + - in: query + name: name__iexact + schema: + type: string + - in: query + name: name__startswith + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17235,7 +17226,7 @@ paths: post: operationId: create_radio_2 tags: - - radios + - radios requestBody: content: application/json: @@ -17252,8 +17243,8 @@ paths: $ref: '#/components/schemas/RadioRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -17265,17 +17256,17 @@ paths: get: operationId: get_radio_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17286,14 +17277,14 @@ paths: put: operationId: update_radio_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios requestBody: content: application/json: @@ -17310,8 +17301,8 @@ paths: $ref: '#/components/schemas/RadioRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17322,14 +17313,14 @@ paths: patch: operationId: partial_update_radio_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios requestBody: content: application/json: @@ -17345,8 +17336,8 @@ paths: schema: $ref: '#/components/schemas/PatchedRadioRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17357,17 +17348,17 @@ paths: delete: operationId: delete_radio_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -17375,17 +17366,17 @@ paths: get: operationId: get_radio_track_2 parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17397,10 +17388,10 @@ paths: get: operationId: get_radio_filter_2 tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17412,7 +17403,7 @@ paths: post: operationId: validate_radio_2 tags: - - radios + - radios requestBody: content: application/json: @@ -17429,8 +17420,8 @@ paths: $ref: '#/components/schemas/RadioRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17443,7 +17434,7 @@ paths: operationId: create_radio_session_2 description: Returns a list of RadioSessions tags: - - radios + - radios requestBody: content: application/json: @@ -17460,8 +17451,8 @@ paths: $ref: '#/components/schemas/RadioSessionRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -17474,17 +17465,17 @@ paths: operationId: get_radio_session_2 description: Returns a list of RadioSessions parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio session. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio session. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17497,17 +17488,17 @@ paths: operationId: get_radio_session_track description: Returns a list of RadioSessions parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this radio session. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this radio session. + required: true tags: - - radios + - radios security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17519,7 +17510,7 @@ paths: post: operationId: get_next_radio_track_2 tags: - - radios + - radios requestBody: content: application/json: @@ -17536,8 +17527,8 @@ paths: $ref: '#/components/schemas/RadioSessionTrackSerializerCreateRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -17549,10 +17540,10 @@ paths: get: operationId: get_rate_limit_2 tags: - - rate-limit + - rate-limit security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17564,10 +17555,10 @@ paths: get: operationId: get_search_results_2 tags: - - search + - search security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17579,17 +17570,17 @@ paths: get: operationId: get_track_stream_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - stream + - stream security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17602,29 +17593,29 @@ paths: get: operationId: get_subscriptions_2 parameters: - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer tags: - - subscriptions + - subscriptions security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17636,17 +17627,17 @@ paths: get: operationId: get_subscription_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - subscriptions + - subscriptions security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17662,10 +17653,10 @@ paths: to have a performant endpoint and avoid lots of queries just to display subscription status in the UI tags: - - subscriptions + - subscriptions security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17677,55 +17668,55 @@ paths: get: operationId: get_tags_2 parameters: - - in: query - name: name - schema: + - in: query + name: name + schema: + type: string + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -creation_date - - -length - - -name - - creation_date - - length - - name - description: |- - Ordering + enum: + - -creation_date + - -length + - -name + - creation_date + - length + - name + description: |- + Ordering - * `name` - Name - * `-name` - Name (descending) - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `length` - Length - * `-length` - Length (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: q - schema: - type: string + * `name` - Name + * `-name` - Name (descending) + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `length` - Length + * `-length` - Length (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: q + schema: + type: string tags: - - tags + - tags security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17737,16 +17728,16 @@ paths: get: operationId: get_tag_2 parameters: - - in: path - name: name - schema: - type: string - required: true + - in: path + name: name + schema: + type: string + required: true tags: - - tags + - tags security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17758,7 +17749,7 @@ paths: post: operationId: preview_text_2 tags: - - text-preview + - text-preview requestBody: content: application/json: @@ -17775,8 +17766,8 @@ paths: $ref: '#/components/schemas/TextPreviewRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17795,182 +17786,182 @@ paths: operationId: get_tracks_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: query + name: id + schema: + type: array + items: type: integer - - in: query - name: artist - schema: + explode: true + style: form + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: query - name: id - schema: - type: array - items: - type: integer - explode: true - style: form - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -17983,17 +17974,17 @@ paths: operationId: get_track_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18005,17 +17996,17 @@ paths: operationId: delete_track_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -18024,180 +18015,180 @@ paths: operationId: get_track_fetches_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18209,14 +18200,14 @@ paths: operationId: create_track_fetch_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks requestBody: content: application/json: @@ -18233,8 +18224,8 @@ paths: $ref: '#/components/schemas/TrackRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18247,180 +18238,180 @@ paths: operationId: get_track_libraries_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18433,180 +18424,180 @@ paths: operationId: get_track_mutations_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: query - name: album - schema: - type: integer - - in: query - name: artist - schema: + - in: query + name: album + schema: + type: integer + - in: query + name: artist + schema: + type: string + - in: query + name: channel + schema: + type: string + - in: query + name: format + schema: + type: string + - in: query + name: has_mbid + schema: + type: boolean + - in: query + name: hidden + schema: + type: boolean + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + - in: query + name: license + schema: + type: string + - in: query + name: mbid + schema: + type: string + format: uuid + - in: query + name: ordering + schema: + type: array + items: type: string - - in: query - name: channel - schema: - type: string - - in: query - name: format - schema: - type: string - - in: query - name: has_mbid - schema: - type: boolean - - in: query - name: hidden - schema: - type: boolean - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - - in: query - name: license - schema: - type: string - - in: query - name: mbid - schema: - type: string - format: uuid - - in: query - name: ordering - schema: - type: array - items: - type: string - enum: - - -album__release_date - - -album__title - - -artist_credit__artist__modification_date - - -artist_credit__artist__name - - -creation_date - - -disc_number - - -position - - -random - - -related - - -size - - -title - - album__release_date - - album__title - - artist_credit__artist__modification_date - - artist_credit__artist__name - - creation_date - - disc_number - - position - - random - - related - - size - - title - description: |- - Ordering - - * `creation_date` - Creation date - * `-creation_date` - Creation date (descending) - * `title` - Title - * `-title` - Title (descending) - * `album__title` - Album title - * `-album__title` - Album title (descending) - * `album__release_date` - Album release date - * `-album__release_date` - Album release date (descending) - * `size` - Size - * `-size` - Size (descending) - * `position` - Position - * `-position` - Position (descending) - * `disc_number` - Disc number - * `-disc_number` - Disc number (descending) - * `artist_credit__artist__name` - Artist credit artist name - * `-artist_credit__artist__name` - Artist credit artist name (descending) - * `artist_credit__artist__modification_date` - Artist credit artist modification date - * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) - * `random` - Random - * `-random` - Random (descending) - * `related` - Related - * `-related` - Related (descending) - explode: false - style: form - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: quality - schema: - type: integer enum: - - 0 - - 1 - - 2 - - 3 - description: |- - * `0` - low - * `1` - medium - * `2` - high - * `3` - very_high - - in: query - name: related - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: tag - schema: - type: array - items: - type: string - explode: true - style: form - - in: query - name: title - schema: - type: string - - in: query - name: title__icontains - schema: - type: string - - in: query - name: title__iexact - schema: - type: string - - in: query - name: title__startswith - schema: + - -album__release_date + - -album__title + - -artist_credit__artist__modification_date + - -artist_credit__artist__name + - -creation_date + - -disc_number + - -position + - -random + - -related + - -size + - -title + - album__release_date + - album__title + - artist_credit__artist__modification_date + - artist_credit__artist__name + - creation_date + - disc_number + - position + - random + - related + - size + - title + description: |- + Ordering + + * `creation_date` - Creation date + * `-creation_date` - Creation date (descending) + * `title` - Title + * `-title` - Title (descending) + * `album__title` - Album title + * `-album__title` - Album title (descending) + * `album__release_date` - Album release date + * `-album__release_date` - Album release date (descending) + * `size` - Size + * `-size` - Size (descending) + * `position` - Position + * `-position` - Position (descending) + * `disc_number` - Disc number + * `-disc_number` - Disc number (descending) + * `artist_credit__artist__name` - Artist credit artist name + * `-artist_credit__artist__name` - Artist credit artist name (descending) + * `artist_credit__artist__modification_date` - Artist credit artist modification date + * `-artist_credit__artist__modification_date` - Artist credit artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) + explode: false + style: form + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: quality + schema: + type: integer + enum: + - 0 + - 1 + - 2 + - 3 + description: |- + * `0` - low + * `1` - medium + * `2` - high + * `3` - very_high + - in: query + name: related + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: tag + schema: + type: array + items: type: string + explode: true + style: form + - in: query + name: title + schema: + type: string + - in: query + name: title__icontains + schema: + type: string + - in: query + name: title__iexact + schema: + type: string + - in: query + name: title__startswith + schema: + type: string tags: - - tracks + - tracks security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18618,14 +18609,14 @@ paths: operationId: create_track_mutation_2 description: A simple ViewSet for viewing and editing accounts. parameters: - - in: path - name: id - schema: - type: integer - description: A unique integer value identifying this track. - required: true + - in: path + name: id + schema: + type: integer + description: A unique integer value identifying this track. + required: true tags: - - tracks + - tracks requestBody: content: application/json: @@ -18642,8 +18633,8 @@ paths: $ref: '#/components/schemas/TrackRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18655,97 +18646,97 @@ paths: get: operationId: get_uploads_2 parameters: - - in: query - name: album_artist - schema: + - in: query + name: album_artist + schema: + type: string + format: uuid + - in: query + name: channel + schema: + type: string + - in: query + name: import_reference + schema: + type: string + - in: query + name: import_status + schema: + type: array + items: type: string - format: uuid - - in: query - name: channel - schema: - type: string - - in: query - name: import_reference - schema: - type: string - - in: query - name: import_status - schema: - type: array - items: - type: string - enum: - - draft - - errored - - finished - - pending - - skipped - description: |- - * `draft` - Draft - * `pending` - Pending - * `finished` - Finished - * `errored` - Errored - * `skipped` - Skipped - explode: true - style: form - - in: query - name: include_channels - schema: - type: boolean - - in: query - name: library - schema: - type: string - format: uuid - - in: query - name: mimetype - schema: - type: string - - name: ordering - required: false - in: query - description: Which field to use when ordering the results. - schema: - type: string - - name: page - required: false - in: query - description: A page number within the paginated result set. - schema: - type: integer - - name: page_size - required: false - in: query - description: Number of results to return per page. - schema: - type: integer - - in: query - name: playable - schema: - type: boolean - - in: query - name: q - schema: - type: string - - in: query - name: scope - schema: - type: string - - in: query - name: track - schema: - type: string - format: uuid - - in: query - name: track_artist - schema: - type: string - format: uuid + enum: + - draft + - errored + - finished + - pending + - skipped + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped + explode: true + style: form + - in: query + name: include_channels + schema: + type: boolean + - in: query + name: library + schema: + type: string + format: uuid + - in: query + name: mimetype + schema: + type: string + - name: ordering + required: false + in: query + description: Which field to use when ordering the results. + schema: + type: string + - name: page + required: false + in: query + description: A page number within the paginated result set. + schema: + type: integer + - name: page_size + required: false + in: query + description: Number of results to return per page. + schema: + type: integer + - in: query + name: playable + schema: + type: boolean + - in: query + name: q + schema: + type: string + - in: query + name: scope + schema: + type: string + - in: query + name: track + schema: + type: string + format: uuid + - in: query + name: track_artist + schema: + type: string + format: uuid tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18756,7 +18747,7 @@ paths: post: operationId: create_upload_2 tags: - - uploads + - uploads requestBody: content: application/json: @@ -18773,8 +18764,8 @@ paths: $ref: '#/components/schemas/UploadForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '201': content: @@ -18786,17 +18777,17 @@ paths: get: operationId: get_upload_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18807,14 +18798,14 @@ paths: put: operationId: update_upload_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads requestBody: content: application/json: @@ -18831,8 +18822,8 @@ paths: $ref: '#/components/schemas/UploadForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18843,14 +18834,14 @@ paths: patch: operationId: partial_update_upload_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads requestBody: content: application/json: @@ -18866,8 +18857,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUploadForOwnerRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18878,17 +18869,17 @@ paths: delete: operationId: delete_upload_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -18896,17 +18887,17 @@ paths: get: operationId: get_upload_metadata_2 parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + required: true tags: - - uploads + - uploads security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18929,7 +18920,7 @@ paths: encoding defaults to 'utf-8'. errors defaults to 'strict'. tags: - - uploads + - uploads requestBody: content: application/json: @@ -18946,8 +18937,8 @@ paths: $ref: '#/components/schemas/UploadForOwnerRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18961,33 +18952,24 @@ paths: description: Used to move an upload from one library to another. Receive a upload uuid and a privacy_level tags: - - uploads + - uploads requestBody: content: application/json: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' application/x-www-form-urlencoded: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' multipart/form-data: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' application/activity+json: schema: - type: array - items: - $ref: '#/components/schemas/UploadBulkUpdateRequest' - required: true + $ref: '#/components/schemas/PatchedUploadForOwnerRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -18999,14 +18981,14 @@ paths: put: operationId: update_user_3 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -19023,8 +19005,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19035,14 +19017,14 @@ paths: patch: operationId: partial_update_user_3 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -19058,8 +19040,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUserWriteRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19071,17 +19053,17 @@ paths: get: operationId: get_user_subsonic_token_3 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19092,14 +19074,14 @@ paths: post: operationId: create_user_subsonic_token_3 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -19116,8 +19098,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19128,17 +19110,17 @@ paths: delete: operationId: delete_user_subsonic_token_3 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -19146,7 +19128,7 @@ paths: post: operationId: change_email_2 tags: - - users + - users requestBody: content: application/json: @@ -19163,8 +19145,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -19175,10 +19157,10 @@ paths: operationId: get_authenticated_user_2 description: Return information about the current user or delete it tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19190,10 +19172,10 @@ paths: operationId: delete_authenticated_user_2 description: Return information about the current user or delete it tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -19202,7 +19184,7 @@ paths: operationId: update_settings_2 description: Return information about the current user or delete it tags: - - users + - users requestBody: content: application/json: @@ -19219,8 +19201,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19232,14 +19214,14 @@ paths: put: operationId: update_user_2 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -19256,8 +19238,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19268,14 +19250,14 @@ paths: patch: operationId: partial_update_user_2 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -19291,8 +19273,8 @@ paths: schema: $ref: '#/components/schemas/PatchedUserWriteRequest' security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19304,17 +19286,17 @@ paths: get: operationId: get_user_subsonic_token_2 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19325,14 +19307,14 @@ paths: post: operationId: create_user_subsonic_token_2 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users requestBody: content: application/json: @@ -19349,8 +19331,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19361,17 +19343,17 @@ paths: delete: operationId: delete_user_subsonic_token_2 parameters: - - in: path - name: username - schema: - type: string - pattern: ^[a-zA-Z0-9-_.]+$ - required: true + - in: path + name: username + schema: + type: string + pattern: ^[a-zA-Z0-9-_.]+$ + required: true tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -19379,7 +19361,7 @@ paths: post: operationId: change_email_3 tags: - - users + - users requestBody: content: application/json: @@ -19396,8 +19378,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': description: No response body @@ -19408,10 +19390,10 @@ paths: operationId: get_authenticated_user_3 description: Return information about the current user or delete it tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19423,10 +19405,10 @@ paths: operationId: delete_authenticated_user_3 description: Return information about the current user or delete it tags: - - users + - users security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '204': description: No response body @@ -19435,7 +19417,7 @@ paths: operationId: update_settings_3 description: Return information about the current user or delete it tags: - - users + - users requestBody: content: application/json: @@ -19452,8 +19434,8 @@ paths: $ref: '#/components/schemas/UserWriteRequest' required: true security: - - oauth2: [] - - ApplicationToken: [] + - oauth2: [] + - ApplicationToken: [] responses: '200': content: @@ -19507,11 +19489,11 @@ components: type: boolean readOnly: true required: - - domain - - fid - - full_username - - is_local - - preferred_username + - domain + - fid + - full_username + - is_local + - preferred_username APIActorRequest: type: object properties: @@ -19552,9 +19534,9 @@ components: type: boolean nullable: true required: - - domain - - fid - - preferred_username + - domain + - fid + - preferred_username APIMutation: type: object properties: @@ -19586,7 +19568,7 @@ components: nullable: true created_by: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true approved_by: type: integer @@ -19605,16 +19587,16 @@ components: additionalProperties: {} readOnly: true required: - - approved_by - - created_by - - creation_date - - fid - - is_applied - - payload - - previous_state - - target - - type - - uuid + - approved_by + - created_by + - creation_date + - fid + - is_applied + - payload + - previous_state + - target + - type + - uuid APIMutationRequest: type: object properties: @@ -19635,8 +19617,8 @@ components: maxLength: 2000 payload: {} required: - - payload - - type + - payload + - type Activity: type: object properties: @@ -19673,10 +19655,10 @@ components: nullable: true maxLength: 100 required: - - actor - - object - - related_object - - target + - actor + - object + - related_object + - target ActivityRequest: type: object properties: @@ -19700,7 +19682,7 @@ components: minLength: 1 maxLength: 100 required: - - actor + - actor Album: type: object properties: @@ -19710,7 +19692,7 @@ components: $ref: '#/components/schemas/ArtistCredit' cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true is_playable: type: boolean @@ -19753,24 +19735,24 @@ components: nullable: true description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true required: - - artist_credit - - attributed_to - - cover - - creation_date - - duration - - fid - - id - - is_local - - is_playable - - mbid - - release_date - - tags - - title - - tracks - - tracks_count + - artist_credit + - attributed_to + - cover + - creation_date + - duration + - fid + - id + - is_local + - is_playable + - mbid + - release_date + - tags + - title + - tracks + - tracks_count AlbumCreate: type: object properties: @@ -19788,15 +19770,15 @@ components: minItems: 0 description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true artist_credit: type: array items: type: string required: - - artist_credit - - title + - artist_credit + - title AlbumCreateRequest: type: object properties: @@ -19820,15 +19802,15 @@ components: minItems: 0 description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true artist_credit: type: array items: type: string required: - - artist_credit - - title + - artist_credit + - title AlbumRequest: type: object properties: @@ -19838,7 +19820,7 @@ components: $ref: '#/components/schemas/ArtistCreditRequest' cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true attributed_to: $ref: '#/components/schemas/APIActorRequest' @@ -19869,20 +19851,20 @@ components: nullable: true description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true required: - - artist_credit - - attributed_to - - cover - - creation_date - - fid - - id - - is_local - - mbid - - release_date - - title - - tracks + - artist_credit + - attributed_to + - cover + - creation_date + - fid + - id + - is_local + - mbid + - release_date + - title + - tracks AllFavorite: type: object properties: @@ -19894,8 +19876,8 @@ components: type: integer readOnly: true required: - - count - - results + - count + - results AllSubscriptions: type: object properties: @@ -19907,8 +19889,8 @@ components: type: integer readOnly: true required: - - count - - results + - count + - results AllowListStat: type: object properties: @@ -19919,8 +19901,8 @@ components: items: type: string required: - - domains - - enabled + - domains + - enabled Application: type: object properties: @@ -19941,9 +19923,9 @@ components: format: date-time readOnly: true required: - - created - - scopes - - updated + - created + - scopes + - updated ApplicationRequest: type: object properties: @@ -19958,7 +19940,7 @@ components: type: string minLength: 1 required: - - scopes + - scopes Artist: type: object properties: @@ -19989,11 +19971,11 @@ components: $ref: '#/components/schemas/ContentCategoryEnum' description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true channel: type: string @@ -20008,10 +19990,10 @@ components: type: string readOnly: true required: - - id - - is_local - - name - - tags + - id + - is_local + - name + - tags ArtistCredit: type: object properties: @@ -20031,7 +20013,7 @@ components: minimum: -2147483648 nullable: true required: - - artist + - artist ArtistCreditRequest: type: object properties: @@ -20051,7 +20033,7 @@ components: minimum: -2147483648 nullable: true required: - - artist + - artist ArtistRequest: type: object properties: @@ -20078,11 +20060,11 @@ components: $ref: '#/components/schemas/ContentCategoryEnum' description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true channel: type: string @@ -20092,7 +20074,7 @@ components: type: integer nullable: true required: - - name + - name ArtistWithAlbums: type: object properties: @@ -20106,11 +20088,11 @@ components: readOnly: true attributed_to: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' nullable: true channel: allOf: - - $ref: '#/components/schemas/ArtistWithAlbumsInlineChannel' + - $ref: '#/components/schemas/ArtistWithAlbumsInlineChannel' nullable: true tracks_count: type: integer @@ -20134,22 +20116,22 @@ components: type: boolean cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true required: - - albums - - attributed_to - - channel - - content_category - - cover - - creation_date - - fid - - id - - is_local - - mbid - - name - - tags - - tracks_count + - albums + - attributed_to + - channel + - content_category + - cover + - creation_date + - fid + - id + - is_local + - mbid + - name + - tags + - tracks_count ArtistWithAlbumsInlineChannel: type: object properties: @@ -20158,8 +20140,8 @@ components: actor: $ref: '#/components/schemas/InlineActor' required: - - actor - - uuid + - actor + - uuid ArtistWithAlbumsInlineChannelRequest: type: object properties: @@ -20169,18 +20151,18 @@ components: actor: $ref: '#/components/schemas/InlineActorRequest' required: - - actor - - uuid + - actor + - uuid ArtistWithAlbumsRequest: type: object properties: attributed_to: allOf: - - $ref: '#/components/schemas/APIActorRequest' + - $ref: '#/components/schemas/APIActorRequest' nullable: true channel: allOf: - - $ref: '#/components/schemas/ArtistWithAlbumsInlineChannelRequest' + - $ref: '#/components/schemas/ArtistWithAlbumsInlineChannelRequest' nullable: true id: type: integer @@ -20204,19 +20186,19 @@ components: type: boolean cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true required: - - attributed_to - - channel - - content_category - - cover - - creation_date - - fid - - id - - is_local - - mbid - - name + - attributed_to + - channel + - content_category + - cover + - creation_date + - fid + - id + - is_local + - mbid + - name Attachment: type: object properties: @@ -20247,11 +20229,11 @@ components: type: string readOnly: true required: - - creation_date - - mimetype - - size - - urls - - uuid + - creation_date + - mimetype + - size + - urls + - uuid AttachmentRequest: type: object properties: @@ -20260,7 +20242,7 @@ components: format: binary writeOnly: true required: - - file + - file Channel: type: object properties: @@ -20273,7 +20255,7 @@ components: $ref: '#/components/schemas/APIActor' actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true creation_date: type: string @@ -20288,17 +20270,13 @@ components: downloads_count: type: integer readOnly: true - subscriptions_count: - type: integer - readOnly: true required: - - actor - - artist - - attributed_to - - downloads_count - - rss_url - - subscriptions_count - - url + - actor + - artist + - attributed_to + - downloads_count + - rss_url + - url ChannelCreate: type: object properties: @@ -20311,7 +20289,7 @@ components: maxLength: 200 description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true tags: type: array @@ -20324,11 +20302,11 @@ components: type: object additionalProperties: {} required: - - content_category - - description - - name - - tags - - username + - content_category + - description + - name + - tags + - username ChannelCreateRequest: type: object properties: @@ -20347,7 +20325,7 @@ components: maxLength: 200 description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true tags: type: array @@ -20361,11 +20339,11 @@ components: type: object additionalProperties: {} required: - - content_category - - description - - name - - tags - - username + - content_category + - description + - name + - tags + - username ChannelRequest: type: object properties: @@ -20384,9 +20362,9 @@ components: type: string minLength: 1 required: - - artist - - attributed_to - - rss_url + - artist + - attributed_to + - rss_url ChannelUpdate: type: object properties: @@ -20395,7 +20373,7 @@ components: maxLength: 200 description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true tags: type: array @@ -20408,10 +20386,10 @@ components: type: object additionalProperties: {} required: - - content_category - - description - - name - - tags + - content_category + - description + - name + - tags ChannelUpdateRequest: type: object properties: @@ -20425,7 +20403,7 @@ components: maxLength: 200 description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true tags: type: array @@ -20439,10 +20417,10 @@ components: type: object additionalProperties: {} required: - - content_category - - description - - name - - tags + - content_category + - description + - name + - tags Content: type: object properties: @@ -20456,14 +20434,14 @@ components: type: string readOnly: true required: - - content_type - - html - - text + - content_type + - html + - text ContentCategoryEnum: enum: - - music - - podcast - - other + - music + - podcast + - other type: string description: |- * `music` - music @@ -20480,13 +20458,13 @@ components: content_type: $ref: '#/components/schemas/ContentTypeEnum' required: - - content_type - - text + - content_type + - text ContentTypeEnum: enum: - - text/html - - text/markdown - - text/plain + - text/html + - text/markdown + - text/plain type: string description: |- * `text/html` - text/html @@ -20522,11 +20500,11 @@ components: type: string readOnly: true required: - - creation_date - - mimetype - - size - - urls - - uuid + - creation_date + - mimetype + - size + - urls + - uuid CoverFieldRequest: type: object properties: @@ -20535,7 +20513,7 @@ components: format: binary writeOnly: true required: - - file + - file CreateApplication: type: object properties: @@ -20564,10 +20542,10 @@ components: type: string description: Allowed URIs list, space separated required: - - client_id - - created - - name - - updated + - client_id + - created + - name + - updated CreateApplicationRequest: type: object properties: @@ -20587,14 +20565,14 @@ components: type: string description: Allowed URIs list, space separated required: - - name + - name Domain: type: object properties: name: type: string required: - - name + - name Endpoints: type: object properties: @@ -20613,15 +20591,15 @@ components: detail: type: string required: - - detail + - detail FederationChoiceEnum: enum: - - Person - - Tombstone - - Application - - Group - - Organization - - Service + - Person + - Tombstone + - Application + - Group + - Organization + - Service type: string description: |- * `Person` - Person @@ -20642,11 +20620,11 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true status: allOf: - - $ref: '#/components/schemas/FetchStatusEnum' + - $ref: '#/components/schemas/FetchStatusEnum' readOnly: true detail: readOnly: true @@ -20660,13 +20638,13 @@ components: readOnly: true nullable: true required: - - actor - - creation_date - - detail - - fetch_date - - id - - status - - url + - actor + - creation_date + - detail + - fetch_date + - id + - status + - url FetchRequest: type: object properties: @@ -20679,13 +20657,13 @@ components: writeOnly: true default: false required: - - object + - object FetchStatusEnum: enum: - - pending - - errored - - finished - - skipped + - pending + - errored + - finished + - skipped type: string description: |- * `pending` - Pending @@ -20705,10 +20683,10 @@ components: type: string readOnly: true required: - - fields - - help_text - - label - - type + - fields + - help_text + - label + - type Follow: type: object properties: @@ -20718,7 +20696,7 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true uuid: type: string @@ -20731,21 +20709,21 @@ components: readOnly: true nullable: true required: - - actor - - approved - - creation_date - - target - - uuid + - actor + - approved + - creation_date + - target + - uuid FollowRequest: type: object properties: target: type: string required: - - target + - target FormatEnum: enum: - - json + - json type: string description: '* `json` - json' FullActor: @@ -20787,21 +20765,21 @@ components: icon: $ref: '#/components/schemas/Attachment' required: - - creation_date - - domain - - fid - - full_username - - icon - - is_channel - - is_local - - last_fetch_date - - manually_approves_followers - - name - - preferred_username - - summary - - type - - url - - user + - creation_date + - domain + - fid + - full_username + - icon + - is_channel + - is_local + - last_fetch_date + - manually_approves_followers + - name + - preferred_username + - summary + - type + - url + - user GlobalPreference: type: object properties: @@ -20832,22 +20810,22 @@ components: type: string readOnly: true required: - - additional_data - - default - - field - - help_text - - identifier - - name - - section - - value - - verbose_name + - additional_data + - default + - field + - help_text + - identifier + - name + - section + - value + - verbose_name GlobalPreferenceRequest: type: object properties: value: type: string required: - - value + - value Ident: type: object properties: @@ -20856,15 +20834,15 @@ components: id: type: string required: - - id - - type + - id + - type ImportStatusEnum: enum: - - draft - - pending - - finished - - errored - - skipped + - draft + - pending + - finished + - errored + - skipped type: string description: |- * `draft` - Draft @@ -20880,16 +20858,16 @@ components: readOnly: true type: allOf: - - $ref: '#/components/schemas/InboxItemTypeEnum' + - $ref: '#/components/schemas/InboxItemTypeEnum' readOnly: true activity: $ref: '#/components/schemas/Activity' is_read: type: boolean required: - - activity - - id - - type + - activity + - id + - type InboxItemRequest: type: object properties: @@ -20898,11 +20876,11 @@ components: is_read: type: boolean required: - - activity + - activity InboxItemTypeEnum: enum: - - to - - cc + - to + - cc type: string description: |- * `to` - to @@ -20917,9 +20895,9 @@ components: domain: type: string required: - - domain - - full_username - - preferred_username + - domain + - full_username + - preferred_username InlineActorRequest: type: object properties: @@ -20933,9 +20911,9 @@ components: type: string minLength: 1 required: - - domain - - full_username - - preferred_username + - domain + - full_username + - preferred_username InlineSubscription: type: object properties: @@ -20946,8 +20924,8 @@ components: type: string format: uuid required: - - channel - - uuid + - channel + - uuid Library: type: object properties: @@ -20973,17 +20951,17 @@ components: $ref: '#/components/schemas/LibraryPrivacyLevelEnum' follow: allOf: - - $ref: '#/components/schemas/NestedLibraryFollow' + - $ref: '#/components/schemas/NestedLibraryFollow' nullable: true latest_scan: allOf: - - $ref: '#/components/schemas/LibraryScan' + - $ref: '#/components/schemas/LibraryScan' nullable: true required: - - actor - - fid - - name - - uploads_count + - actor + - fid + - name + - uploads_count LibraryFollow: type: object properties: @@ -20993,7 +20971,7 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true uuid: type: string @@ -21006,18 +20984,18 @@ components: readOnly: true nullable: true required: - - actor - - approved - - creation_date - - target - - uuid + - actor + - approved + - creation_date + - target + - uuid LibraryFollowRequest: type: object properties: target: type: string required: - - target + - target LibraryForOwner: type: object properties: @@ -21046,16 +21024,16 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true required: - - actor - - creation_date - - fid - - name - - size - - uploads_count - - uuid + - actor + - creation_date + - fid + - name + - size + - uploads_count + - uuid LibraryForOwnerRequest: type: object properties: @@ -21066,12 +21044,12 @@ components: privacy_level: $ref: '#/components/schemas/LibraryPrivacyLevelEnum' required: - - name + - name LibraryPrivacyLevelEnum: enum: - - me - - instance - - everyone + - me + - instance + - everyone type: string description: |- * `me` - Only me @@ -21101,16 +21079,16 @@ components: $ref: '#/components/schemas/LibraryPrivacyLevelEnum' follow: allOf: - - $ref: '#/components/schemas/NestedLibraryFollowRequest' + - $ref: '#/components/schemas/NestedLibraryFollowRequest' nullable: true latest_scan: allOf: - - $ref: '#/components/schemas/LibraryScanRequest' + - $ref: '#/components/schemas/LibraryScanRequest' nullable: true required: - - actor - - fid - - name + - actor + - fid + - name LibraryScan: type: object properties: @@ -21186,15 +21164,15 @@ components: copyleft: type: boolean required: - - attribution - - code - - commercial - - copyleft - - derivative - - id - - name - - redistribute - - url + - attribution + - code + - commercial + - copyleft + - derivative + - id + - name + - redistribute + - url Listening: type: object properties: @@ -21203,20 +21181,20 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true track: allOf: - - $ref: '#/components/schemas/Track' + - $ref: '#/components/schemas/Track' readOnly: true creation_date: type: string format: date-time nullable: true required: - - actor - - id - - track + - actor + - id + - track ListeningWrite: type: object properties: @@ -21225,7 +21203,7 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true track: type: integer @@ -21234,9 +21212,9 @@ components: format: date-time nullable: true required: - - actor - - id - - track + - actor + - id + - track ListeningWriteRequest: type: object properties: @@ -21247,7 +21225,7 @@ components: format: date-time nullable: true required: - - track + - track ManageActor: type: object properties: @@ -21315,22 +21293,22 @@ components: readOnly: true user: allOf: - - $ref: '#/components/schemas/ManageUser' + - $ref: '#/components/schemas/ManageUser' nullable: true instance_policy: type: integer readOnly: true required: - - creation_date - - domain - - fid - - full_username - - id - - instance_policy - - is_local - - preferred_username - - uploads_count - - user + - creation_date + - domain + - fid + - full_username + - id + - instance_policy + - is_local + - preferred_username + - uploads_count + - user ManageActorRequest: type: object properties: @@ -21384,13 +21362,13 @@ components: nullable: true user: allOf: - - $ref: '#/components/schemas/ManageUserRequest' + - $ref: '#/components/schemas/ManageUserRequest' nullable: true required: - - domain - - fid - - preferred_username - - user + - domain + - fid + - preferred_username + - user ManageAlbum: type: object properties: @@ -21437,15 +21415,15 @@ components: type: string readOnly: true required: - - artist_credit - - attributed_to - - cover - - domain - - id - - is_local - - tags - - title - - tracks_count + - artist_credit + - attributed_to + - cover + - domain + - id + - is_local + - tags + - title + - tracks_count ManageAlbumRequest: type: object properties: @@ -21481,11 +21459,11 @@ components: attributed_to: $ref: '#/components/schemas/ManageBaseActorRequest' required: - - artist_credit - - attributed_to - - cover - - domain - - title + - artist_credit + - attributed_to + - cover + - domain + - title ManageArtist: type: object properties: @@ -21526,7 +21504,7 @@ components: readOnly: true cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true channel: type: string @@ -21534,16 +21512,16 @@ components: content_category: $ref: '#/components/schemas/ContentCategoryEnum' required: - - albums_count - - attributed_to - - channel - - cover - - domain - - id - - is_local - - name - - tags - - tracks_count + - albums_count + - attributed_to + - channel + - cover + - domain + - id + - is_local + - name + - tags + - tracks_count ManageArtistRequest: type: object properties: @@ -21570,15 +21548,15 @@ components: $ref: '#/components/schemas/ManageBaseActorRequest' cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true content_category: $ref: '#/components/schemas/ContentCategoryEnum' required: - - attributed_to - - cover - - domain - - name + - attributed_to + - cover + - domain + - name ManageBaseActor: type: object properties: @@ -21642,13 +21620,13 @@ components: type: boolean readOnly: true required: - - creation_date - - domain - - fid - - full_username - - id - - is_local - - preferred_username + - creation_date + - domain + - fid + - full_username + - id + - is_local + - preferred_username ManageBaseActorRequest: type: object properties: @@ -21701,9 +21679,9 @@ components: type: boolean nullable: true required: - - domain - - fid - - preferred_username + - domain + - fid + - preferred_username ManageBaseNote: type: object properties: @@ -21723,14 +21701,14 @@ components: maxLength: 50000 author: allOf: - - $ref: '#/components/schemas/ManageBaseActor' + - $ref: '#/components/schemas/ManageBaseActor' readOnly: true required: - - author - - creation_date - - id - - summary - - uuid + - author + - creation_date + - id + - summary + - uuid ManageBaseNoteRequest: type: object properties: @@ -21739,7 +21717,7 @@ components: minLength: 1 maxLength: 50000 required: - - summary + - summary ManageChannel: type: object properties: @@ -21768,14 +21746,14 @@ components: metadata: readOnly: true required: - - actor - - artist - - attributed_to - - creation_date - - id - - metadata - - rss_url - - uuid + - actor + - artist + - attributed_to + - creation_date + - id + - metadata + - rss_url + - uuid ManageDomain: type: object properties: @@ -21807,13 +21785,13 @@ components: type: boolean nullable: true required: - - actors_count - - creation_date - - instance_policy - - name - - nodeinfo - - nodeinfo_fetch_date - - outbox_activities_count + - actors_count + - creation_date + - instance_policy + - name + - nodeinfo + - nodeinfo_fetch_date + - outbox_activities_count ManageDomainRequest: type: object properties: @@ -21826,7 +21804,7 @@ components: type: boolean nullable: true required: - - name + - name ManageDomainUpdate: type: object properties: @@ -21857,13 +21835,13 @@ components: type: boolean nullable: true required: - - actors_count - - creation_date - - instance_policy - - name - - nodeinfo - - nodeinfo_fetch_date - - outbox_activities_count + - actors_count + - creation_date + - instance_policy + - name + - nodeinfo + - nodeinfo_fetch_date + - outbox_activities_count ManageDomainUpdateRequest: type: object properties: @@ -21905,11 +21883,11 @@ components: reject_media: type: boolean required: - - actor - - creation_date - - id - - target - - uuid + - actor + - creation_date + - id + - target + - uuid ManageInstancePolicyRequest: type: object properties: @@ -21930,7 +21908,7 @@ components: reject_media: type: boolean required: - - target + - target ManageInvitation: type: object properties: @@ -21957,9 +21935,9 @@ components: items: $ref: '#/components/schemas/ManageUserSimple' required: - - creation_date - - expiration_date - - id + - creation_date + - expiration_date + - id ManageInvitationRequest: type: object properties: @@ -22014,16 +21992,16 @@ components: actor: $ref: '#/components/schemas/ManageBaseActor' required: - - actor - - creation_date - - domain - - fid - - id - - is_local - - name - - uploads_count - - url - - uuid + - actor + - creation_date + - domain + - fid + - id + - is_local + - name + - uploads_count + - url + - uuid ManageLibraryRequest: type: object properties: @@ -22039,9 +22017,9 @@ components: actor: $ref: '#/components/schemas/ManageBaseActorRequest' required: - - actor - - domain - - name + - actor + - domain + - name ManageNestedArtist: type: object properties: @@ -22068,24 +22046,24 @@ components: type: boolean readOnly: true required: - - domain - - id - - is_local - - name + - domain + - id + - is_local + - name ManageNestedArtistCredit: type: object properties: artist: $ref: '#/components/schemas/ManageNestedArtist' required: - - artist + - artist ManageNestedArtistCreditRequest: type: object properties: artist: $ref: '#/components/schemas/ManageNestedArtistRequest' required: - - artist + - artist ManageNestedArtistRequest: type: object properties: @@ -22109,8 +22087,8 @@ components: type: string minLength: 1 required: - - domain - - name + - domain + - name ManageNestedLibrary: type: object properties: @@ -22145,12 +22123,12 @@ components: actor: $ref: '#/components/schemas/ManageBaseActor' required: - - actor - - domain - - fid - - id - - is_local - - name + - actor + - domain + - fid + - id + - is_local + - name ManageNestedLibraryRequest: type: object properties: @@ -22182,10 +22160,10 @@ components: actor: $ref: '#/components/schemas/ManageBaseActorRequest' required: - - actor - - domain - - fid - - name + - actor + - domain + - fid + - name ManageNestedTrack: type: object properties: @@ -22228,10 +22206,10 @@ components: type: string nullable: true required: - - domain - - id - - is_local - - title + - domain + - id + - is_local + - title ManageNestedTrackRequest: type: object properties: @@ -22272,8 +22250,8 @@ components: minLength: 1 nullable: true required: - - domain - - title + - domain + - title ManageNote: type: object properties: @@ -22293,16 +22271,16 @@ components: maxLength: 50000 author: allOf: - - $ref: '#/components/schemas/ManageBaseActor' + - $ref: '#/components/schemas/ManageBaseActor' readOnly: true target: {} required: - - author - - creation_date - - id - - summary - - target - - uuid + - author + - creation_date + - id + - summary + - target + - uuid ManageNoteRequest: type: object properties: @@ -22312,8 +22290,8 @@ components: maxLength: 50000 target: {} required: - - summary - - target + - summary + - target ManageReport: type: object properties: @@ -22351,7 +22329,7 @@ components: type: boolean assigned_to: allOf: - - $ref: '#/components/schemas/ManageBaseActor' + - $ref: '#/components/schemas/ManageBaseActor' nullable: true target_owner: $ref: '#/components/schemas/ManageBaseActor' @@ -22369,16 +22347,16 @@ components: nullable: true default: [] required: - - creation_date - - fid - - handled_date - - id - - submitter_email - - summary - - target - - target_state - - type - - uuid + - creation_date + - fid + - handled_date + - id + - submitter_email + - summary + - target + - target_state + - type + - uuid ManageReportRequest: type: object properties: @@ -22389,7 +22367,7 @@ components: type: boolean assigned_to: allOf: - - $ref: '#/components/schemas/ManageBaseActorRequest' + - $ref: '#/components/schemas/ManageBaseActorRequest' nullable: true target_owner: $ref: '#/components/schemas/ManageBaseActorRequest' @@ -22402,8 +22380,8 @@ components: nullable: true default: [] required: - - target - - type + - target + - type ManageTag: type: object properties: @@ -22426,11 +22404,11 @@ components: type: integer readOnly: true required: - - albums_count - - artists_count - - id - - name - - tracks_count + - albums_count + - artists_count + - id + - name + - tracks_count ManageTagRequest: type: object properties: @@ -22442,7 +22420,7 @@ components: type: string format: date-time required: - - name + - name ManageTarget: type: object properties: @@ -22451,8 +22429,8 @@ components: id: type: string required: - - id - - type + - id + - type ManageTargetRequest: type: object properties: @@ -22462,12 +22440,12 @@ components: type: string minLength: 1 required: - - id - - type + - id + - type ManageTargetTypeEnum: enum: - - domain - - actor + - domain + - actor type: string description: |- * `domain` - domain @@ -22519,11 +22497,11 @@ components: $ref: '#/components/schemas/ManageNestedArtistCredit' album: allOf: - - $ref: '#/components/schemas/ManageTrackAlbum' + - $ref: '#/components/schemas/ManageTrackAlbum' nullable: true attributed_to: allOf: - - $ref: '#/components/schemas/ManageBaseActor' + - $ref: '#/components/schemas/ManageBaseActor' nullable: true uploads_count: type: integer @@ -22536,16 +22514,16 @@ components: cover: $ref: '#/components/schemas/CoverField' required: - - album - - artist_credit - - attributed_to - - cover - - domain - - id - - is_local - - tags - - title - - uploads_count + - album + - artist_credit + - attributed_to + - cover + - domain + - id + - is_local + - tags + - title + - uploads_count ManageTrackAlbum: type: object properties: @@ -22585,13 +22563,13 @@ components: items: $ref: '#/components/schemas/ManageNestedArtistCredit' required: - - artist_credit - - cover - - domain - - id - - is_local - - title - - tracks_count + - artist_credit + - cover + - domain + - id + - is_local + - title + - tracks_count ManageTrackAlbumRequest: type: object properties: @@ -22625,10 +22603,10 @@ components: items: $ref: '#/components/schemas/ManageNestedArtistCreditRequest' required: - - artist_credit - - cover - - domain - - title + - artist_credit + - cover + - domain + - title ManageTrackRequest: type: object properties: @@ -22674,21 +22652,21 @@ components: $ref: '#/components/schemas/ManageNestedArtistCreditRequest' album: allOf: - - $ref: '#/components/schemas/ManageTrackAlbumRequest' + - $ref: '#/components/schemas/ManageTrackAlbumRequest' nullable: true attributed_to: allOf: - - $ref: '#/components/schemas/ManageBaseActorRequest' + - $ref: '#/components/schemas/ManageBaseActorRequest' nullable: true cover: $ref: '#/components/schemas/CoverFieldRequest' required: - - album - - artist_credit - - attributed_to - - cover - - domain - - title + - album + - artist_credit + - attributed_to + - cover + - domain + - title ManageUpload: type: object properties: @@ -22768,14 +22746,14 @@ components: library: $ref: '#/components/schemas/ManageNestedLibrary' required: - - audio_file - - domain - - filename - - id - - is_local - - library - - listen_url - - track + - audio_file + - domain + - filename + - id + - is_local + - library + - listen_url + - track ManageUploadRequest: type: object properties: @@ -22845,10 +22823,10 @@ components: library: $ref: '#/components/schemas/ManageNestedLibraryRequest' required: - - audio_file - - domain - - library - - track + - audio_file + - domain + - library + - track ManageUser: type: object properties: @@ -22901,20 +22879,20 @@ components: nullable: true privacy_level: allOf: - - $ref: '#/components/schemas/PrivacyLevelEnum' + - $ref: '#/components/schemas/PrivacyLevelEnum' readOnly: true full_username: type: string readOnly: true required: - - actor - - date_joined - - email - - full_username - - id - - last_activity - - privacy_level - - username + - actor + - date_joined + - email + - full_username + - id + - last_activity + - privacy_level + - username ManageUserRequest: type: object properties: @@ -22951,14 +22929,14 @@ components: submitter: $ref: '#/components/schemas/ManageBaseActorRequest' required: - - assigned_to - - submitter - - type + - assigned_to + - submitter + - type ManageUserRequestStatusEnum: enum: - - pending - - refused - - approved + - pending + - refused + - approved type: string description: |- * `pending` - Pending @@ -22966,7 +22944,7 @@ components: * `approved` - Approved ManageUserRequestTypeEnum: enum: - - signup + - signup type: string description: '* `signup` - Sign-up' ManageUserSimple: @@ -23019,8 +22997,8 @@ components: minimum: 0 nullable: true required: - - id - - username + - id + - username ManageUserSimpleRequest: type: object properties: @@ -23069,7 +23047,7 @@ components: minimum: 0 nullable: true required: - - username + - username Metadata20: type: object properties: @@ -23102,7 +23080,7 @@ components: type: string allowList: allOf: - - $ref: '#/components/schemas/AllowListStat' + - $ref: '#/components/schemas/AllowListStat' readOnly: true funkwhaleSupportMessageEnabled: type: boolean @@ -23114,7 +23092,7 @@ components: $ref: '#/components/schemas/MetadataUsage' library: allOf: - - $ref: '#/components/schemas/NodeInfoLibrary' + - $ref: '#/components/schemas/NodeInfoLibrary' readOnly: true reportTypes: type: array @@ -23129,141 +23107,23 @@ components: type: string readOnly: true required: - - actorId - - allowList - - banner - - contactEmail - - defaultUploadQuota - - endpoints - - funkwhaleSupportMessageEnabled - - instanceSupportMessage - - library - - longDescription - - nodeName - - private - - reportTypes - - rules - - shortDescription - - supportedUploadExtensions - - terms - Metadata21: - type: object - properties: - actorId: - type: string - private: - type: boolean - readOnly: true - shortDescription: - type: string - readOnly: true - longDescription: - type: string - readOnly: true - contactEmail: - type: string - readOnly: true - nodeName: - type: string - readOnly: true - banner: - type: string - readOnly: true - defaultUploadQuota: - type: integer - readOnly: true - supportedUploadExtensions: - type: array - items: - type: string - allowList: - allOf: - - $ref: '#/components/schemas/AllowListStat' - readOnly: true - funkwhaleSupportMessageEnabled: - type: boolean - readOnly: true - instanceSupportMessage: - type: string - readOnly: true - usage: - $ref: '#/components/schemas/MetadataUsage' - languages: - type: array - items: - type: string - location: - type: string - content: - $ref: '#/components/schemas/MetadataContent' - features: - type: array - items: - type: string - codeOfConduct: - type: string - readOnly: true - required: - - actorId - - allowList - - banner - - codeOfConduct - - contactEmail - - content - - defaultUploadQuota - - features - - funkwhaleSupportMessageEnabled - - instanceSupportMessage - - languages - - location - - longDescription - - nodeName - - private - - shortDescription - - supportedUploadExtensions - MetadataContent: - type: object - properties: - local: - $ref: '#/components/schemas/MetadataContentLocal' - topMusicCategories: - type: array - items: - $ref: '#/components/schemas/MetadataContentCategory' - topPodcastCategories: - type: array - items: - $ref: '#/components/schemas/MetadataContentCategory' - required: - - local - - topMusicCategories - - topPodcastCategories - MetadataContentCategory: - type: object - properties: - name: - type: string - count: - type: integer - required: - - count - - name - MetadataContentLocal: - type: object - properties: - artists: - type: integer - releases: - type: integer - recordings: - type: integer - hoursOfContent: - type: integer - required: - - artists - - hoursOfContent - - recordings - - releases + - actorId + - allowList + - banner + - contactEmail + - defaultUploadQuota + - endpoints + - funkwhaleSupportMessageEnabled + - instanceSupportMessage + - library + - longDescription + - nodeName + - private + - reportTypes + - rules + - shortDescription + - supportedUploadExtensions + - terms MetadataUsage: type: object properties: @@ -23274,18 +23134,18 @@ components: downloads: $ref: '#/components/schemas/TotalCount' required: - - downloads - - favorites - - listenings + - downloads + - favorites + - listenings MetadataUsageFavorite: type: object properties: tracks: allOf: - - $ref: '#/components/schemas/TotalCount' + - $ref: '#/components/schemas/TotalCount' readOnly: true required: - - tracks + - tracks ModerationTarget: type: object properties: @@ -23294,8 +23154,8 @@ components: id: type: string required: - - id - - type + - id + - type ModerationTargetRequest: type: object properties: @@ -23305,11 +23165,11 @@ components: type: string minLength: 1 required: - - id - - type + - id + - type ModerationTargetTypeEnum: enum: - - artist + - artist type: string description: '* `artist` - artist' NestedLibraryFollow: @@ -23334,7 +23194,7 @@ components: format: date-time readOnly: true required: - - modification_date + - modification_date NestedLibraryFollowRequest: type: object properties: @@ -23366,7 +23226,7 @@ components: readOnly: true services: allOf: - - $ref: '#/components/schemas/Services' + - $ref: '#/components/schemas/Services' default: inbound: [] outbound: [] @@ -23375,55 +23235,19 @@ components: readOnly: true usage: allOf: - - $ref: '#/components/schemas/Usage' + - $ref: '#/components/schemas/Usage' readOnly: true metadata: allOf: - - $ref: '#/components/schemas/Metadata20' + - $ref: '#/components/schemas/Metadata20' readOnly: true required: - - metadata - - openRegistrations - - protocols - - software - - usage - - version - NodeInfo21: - type: object - properties: - version: - type: string - readOnly: true - software: - $ref: '#/components/schemas/SoftwareSerializer_v2' - protocols: - type: array - items: {} - readOnly: true - services: - allOf: - - $ref: '#/components/schemas/Services' - default: - inbound: [] - outbound: [] - openRegistrations: - type: boolean - readOnly: true - usage: - allOf: - - $ref: '#/components/schemas/Usage' - readOnly: true - metadata: - allOf: - - $ref: '#/components/schemas/Metadata21' - readOnly: true - required: - - metadata - - openRegistrations - - protocols - - software - - usage - - version + - metadata + - openRegistrations + - protocols + - software + - usage + - version NodeInfoLibrary: type: object properties: @@ -23433,27 +23257,27 @@ components: type: boolean tracks: allOf: - - $ref: '#/components/schemas/TotalCount' + - $ref: '#/components/schemas/TotalCount' default: total: 0 artists: allOf: - - $ref: '#/components/schemas/TotalCount' + - $ref: '#/components/schemas/TotalCount' default: total: 0 albums: allOf: - - $ref: '#/components/schemas/TotalCount' + - $ref: '#/components/schemas/TotalCount' default: total: 0 music: allOf: - - $ref: '#/components/schemas/TotalHours' + - $ref: '#/components/schemas/TotalHours' default: hours: 0 required: - - anonymousCanListen - - federationEnabled + - anonymousCanListen + - federationEnabled Oembed: type: object properties: @@ -23467,13 +23291,13 @@ components: maxwidth: type: integer required: - - format - - url + - format + - url PaginatedAPIMutationList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23495,8 +23319,8 @@ components: PaginatedAlbumList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23518,8 +23342,8 @@ components: PaginatedApplicationList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23541,8 +23365,8 @@ components: PaginatedArtistWithAlbumsList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23564,8 +23388,8 @@ components: PaginatedChannelList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23587,8 +23411,8 @@ components: PaginatedDomainList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23610,8 +23434,8 @@ components: PaginatedFetchList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23633,8 +23457,8 @@ components: PaginatedFollowList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23656,8 +23480,8 @@ components: PaginatedInboxItemList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23679,8 +23503,8 @@ components: PaginatedLibraryFollowList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23702,8 +23526,8 @@ components: PaginatedLibraryForOwnerList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23725,8 +23549,8 @@ components: PaginatedLibraryList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23748,8 +23572,8 @@ components: PaginatedLicenseList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23771,8 +23595,8 @@ components: PaginatedListeningList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23794,8 +23618,8 @@ components: PaginatedManageActorList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23817,8 +23641,8 @@ components: PaginatedManageAlbumList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23840,8 +23664,8 @@ components: PaginatedManageArtistList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23863,8 +23687,8 @@ components: PaginatedManageChannelList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23886,8 +23710,8 @@ components: PaginatedManageDomainList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23909,8 +23733,8 @@ components: PaginatedManageInstancePolicyList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23932,8 +23756,8 @@ components: PaginatedManageInvitationList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23955,8 +23779,8 @@ components: PaginatedManageLibraryList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -23978,8 +23802,8 @@ components: PaginatedManageNoteList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24001,8 +23825,8 @@ components: PaginatedManageReportList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24024,8 +23848,8 @@ components: PaginatedManageTagList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24047,8 +23871,8 @@ components: PaginatedManageTrackList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24070,8 +23894,8 @@ components: PaginatedManageUploadList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24093,8 +23917,8 @@ components: PaginatedManageUserList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24116,8 +23940,8 @@ components: PaginatedManageUserRequestList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24139,8 +23963,8 @@ components: PaginatedPlaylistList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24162,8 +23986,8 @@ components: PaginatedPlaylistTrackList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24185,8 +24009,8 @@ components: PaginatedRadioList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24208,8 +24032,8 @@ components: PaginatedSubscriptionList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24231,8 +24055,8 @@ components: PaginatedTagList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24254,8 +24078,8 @@ components: PaginatedTrackList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24277,8 +24101,8 @@ components: PaginatedUploadForOwnerList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24300,8 +24124,8 @@ components: PaginatedUserFilterList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24323,8 +24147,8 @@ components: PaginatedUserTrackFavoriteList: type: object required: - - count - - results + - count + - results properties: count: type: integer @@ -24353,8 +24177,8 @@ components: type: string maxLength: 128 required: - - new_password1 - - new_password2 + - new_password1 + - new_password2 PasswordChangeRequest: type: object properties: @@ -24367,8 +24191,8 @@ components: minLength: 1 maxLength: 128 required: - - new_password1 - - new_password2 + - new_password1 + - new_password2 PasswordReset: type: object description: Serializer for requesting a password reset e-mail. @@ -24377,7 +24201,7 @@ components: type: string format: email required: - - email + - email PasswordResetConfirm: type: object description: Serializer for confirming a password reset attempt. @@ -24393,10 +24217,10 @@ components: token: type: string required: - - new_password1 - - new_password2 - - token - - uid + - new_password1 + - new_password2 + - token + - uid PasswordResetConfirmRequest: type: object description: Serializer for confirming a password reset attempt. @@ -24416,10 +24240,10 @@ components: type: string minLength: 1 required: - - new_password1 - - new_password2 - - token - - uid + - new_password1 + - new_password2 + - token + - uid PasswordResetRequest: type: object description: Serializer for requesting a password reset e-mail. @@ -24429,7 +24253,7 @@ components: format: email minLength: 1 required: - - email + - email PatchedApplicationRequest: type: object properties: @@ -24456,7 +24280,7 @@ components: maxLength: 200 description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true tags: type: array @@ -24545,7 +24369,7 @@ components: type: boolean assigned_to: allOf: - - $ref: '#/components/schemas/ManageBaseActorRequest' + - $ref: '#/components/schemas/ManageBaseActorRequest' nullable: true target_owner: $ref: '#/components/schemas/ManageBaseActorRequest' @@ -24621,7 +24445,7 @@ components: minLength: 1 track: allOf: - - $ref: '#/components/schemas/TrackRequest' + - $ref: '#/components/schemas/TrackRequest' nullable: true library: type: string @@ -24629,10 +24453,8 @@ components: type: string import_status: allOf: - - $ref: '#/components/schemas/ImportStatusEnum' + - $ref: '#/components/schemas/ImportStatusEnum' default: pending - privacy_level: - $ref: '#/components/schemas/LibraryPrivacyLevelEnum' import_metadata: {} import_reference: type: string @@ -24685,7 +24507,7 @@ components: nullable: true summary: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true Playlist: type: object @@ -24698,7 +24520,7 @@ components: maxLength: 100 actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true modification_date: type: string @@ -24725,15 +24547,15 @@ components: type: boolean readOnly: true required: - - actor - - album_covers - - creation_date - - duration - - id - - is_playable - - modification_date - - name - - tracks_count + - actor + - album_covers + - creation_date + - duration + - id + - is_playable + - modification_date + - name + - tracks_count PlaylistAddManyRequest: type: object properties: @@ -24744,7 +24566,7 @@ components: allow_duplicates: type: boolean required: - - tracks + - tracks PlaylistRequest: type: object properties: @@ -24755,7 +24577,7 @@ components: privacy_level: $ref: '#/components/schemas/PrivacyLevelEnum' required: - - name + - name PlaylistTrack: type: object properties: @@ -24771,13 +24593,13 @@ components: type: string format: date-time required: - - track + - track PrivacyLevelEnum: enum: - - me - - followers - - instance - - everyone + - me + - followers + - instance + - everyone type: string description: |- * `me` - Only me @@ -24801,17 +24623,17 @@ components: readOnly: true user: allOf: - - $ref: '#/components/schemas/UserBasic' + - $ref: '#/components/schemas/UserBasic' readOnly: true config: {} description: type: string required: - - config - - creation_date - - id - - name - - user + - config + - creation_date + - id + - name + - user RadioRequest: type: object properties: @@ -24825,8 +24647,8 @@ components: description: type: string required: - - config - - name + - config + - name RadioSession: type: object properties: @@ -24851,8 +24673,8 @@ components: config: nullable: true required: - - id - - radio_type + - id + - radio_type RadioSessionRequest: type: object properties: @@ -24876,7 +24698,7 @@ components: config: nullable: true required: - - radio_type + - radio_type RadioSessionTrackSerializerCreate: type: object properties: @@ -24886,7 +24708,7 @@ components: type: integer nullable: true required: - - session + - session RadioSessionTrackSerializerCreateRequest: type: object properties: @@ -24896,7 +24718,7 @@ components: type: integer nullable: true required: - - session + - session RateLimit: type: object properties: @@ -24909,9 +24731,9 @@ components: items: $ref: '#/components/schemas/Scopes' required: - - enabled - - ident - - scopes + - enabled + - ident + - scopes Register: type: object properties: @@ -24926,8 +24748,8 @@ components: type: string nullable: true required: - - email - - username + - email + - username RegisterRequest: type: object properties: @@ -24951,10 +24773,10 @@ components: type: string nullable: true required: - - email - - password1 - - password2 - - username + - email + - password1 + - password2 + - username Report: type: object properties: @@ -24987,12 +24809,12 @@ components: type: $ref: '#/components/schemas/ReportTypeEnum' required: - - creation_date - - handled_date - - is_handled - - target - - type - - uuid + - creation_date + - handled_date + - is_handled + - target + - type + - uuid ReportRequest: type: object properties: @@ -25010,8 +24832,8 @@ components: type: $ref: '#/components/schemas/ReportTypeEnum' required: - - target - - type + - target + - type ReportType: type: object properties: @@ -25022,16 +24844,16 @@ components: anonymous: type: boolean required: - - anonymous - - label - - type + - anonymous + - label + - type ReportTypeEnum: enum: - - takedown_request - - invalid_metadata - - illegal_content - - offensive_content - - other + - takedown_request + - invalid_metadata + - illegal_content + - offensive_content + - other type: string description: |- * `takedown_request` - Takedown request @@ -25063,16 +24885,16 @@ components: reset_seconds: type: integer required: - - available - - available_seconds - - description - - duration - - id - - limit - - rate - - remaining - - reset - - reset_seconds + - available + - available_seconds + - description + - duration + - id + - limit + - rate + - remaining + - reset + - reset_seconds SearchResult: type: object properties: @@ -25093,10 +24915,10 @@ components: items: $ref: '#/components/schemas/Tag' required: - - albums - - artists - - tags - - tracks + - albums + - artists + - tags + - tracks Services: type: object properties: @@ -25134,11 +24956,11 @@ components: type: string description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true channel: type: string @@ -25152,15 +24974,15 @@ components: items: type: string required: - - content_category - - creation_date - - fid - - id - - is_local - - mbid - - modification_date - - name - - tracks_count + - content_category + - creation_date + - fid + - id + - is_local + - mbid + - modification_date + - name + - tracks_count SimpleChannelArtistRequest: type: object properties: @@ -25189,11 +25011,11 @@ components: minLength: 1 description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true channel: type: string @@ -25205,14 +25027,14 @@ components: type: string minLength: 1 required: - - content_category - - creation_date - - fid - - id - - is_local - - mbid - - modification_date - - name + - content_category + - creation_date + - fid + - id + - is_local + - mbid + - modification_date + - name SimpleFavorite: type: object properties: @@ -25221,8 +25043,8 @@ components: track: type: integer required: - - id - - track + - id + - track Software: type: object properties: @@ -25232,27 +25054,8 @@ components: version: type: string required: - - name - - version - SoftwareSerializer_v2: - type: object - properties: - name: - type: string - readOnly: true - version: - type: string - repository: - type: string - readOnly: true - homepage: - type: string - readOnly: true - required: - - homepage - - name - - repository - - version + - name + - version SpaManifest: type: object properties: @@ -25300,9 +25103,9 @@ components: type: type: string required: - - sizes - - src - - type + - sizes + - src + - type SpaManifestRelatedApplications: type: object properties: @@ -25314,9 +25117,9 @@ components: id: type: string required: - - id - - platform - - url + - id + - platform + - url SpaManifestShortcut: type: object properties: @@ -25329,8 +25132,8 @@ components: items: $ref: '#/components/schemas/SpaManifestIcon' required: - - name - - url + - name + - url Subscription: type: object properties: @@ -25350,10 +25153,10 @@ components: format: date-time readOnly: true required: - - approved - - creation_date - - fid - - uuid + - approved + - creation_date + - fid + - uuid Tag: type: object properties: @@ -25364,7 +25167,7 @@ components: type: string format: date-time required: - - name + - name TextPreview: type: object properties: @@ -25372,7 +25175,7 @@ components: type: string readOnly: true required: - - rendered + - rendered TextPreviewRequest: type: object properties: @@ -25381,7 +25184,7 @@ components: writeOnly: true minLength: 1 required: - - text + - text TotalCount: type: object properties: @@ -25389,7 +25192,7 @@ components: type: integer readOnly: true required: - - total + - total TotalHours: type: object properties: @@ -25397,7 +25200,7 @@ components: type: integer readOnly: true required: - - hours + - hours Track: type: object properties: @@ -25407,7 +25210,7 @@ components: $ref: '#/components/schemas/ArtistCredit' album: allOf: - - $ref: '#/components/schemas/TrackAlbum' + - $ref: '#/components/schemas/TrackAlbum' readOnly: true uploads: type: array @@ -25425,11 +25228,11 @@ components: readOnly: true attributed_to: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' nullable: true description: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true id: type: integer @@ -25459,31 +25262,31 @@ components: readOnly: true cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true is_playable: type: boolean readOnly: true required: - - album - - artist_credit - - attributed_to - - copyright - - cover - - creation_date - - disc_number - - downloads_count - - fid - - id - - is_local - - is_playable - - license - - listen_url - - mbid - - position - - tags - - title - - uploads + - album + - artist_credit + - attributed_to + - copyright + - cover + - creation_date + - disc_number + - downloads_count + - fid + - id + - is_local + - is_playable + - license + - listen_url + - mbid + - position + - tags + - title + - uploads TrackAlbum: type: object properties: @@ -25511,7 +25314,7 @@ components: nullable: true cover: allOf: - - $ref: '#/components/schemas/CoverField' + - $ref: '#/components/schemas/CoverField' nullable: true creation_date: type: string @@ -25523,12 +25326,12 @@ components: type: integer readOnly: true required: - - artist_credit - - cover - - id - - is_local - - title - - tracks_count + - artist_credit + - cover + - id + - is_local + - title + - tracks_count TrackAlbumRequest: type: object properties: @@ -25555,15 +25358,15 @@ components: nullable: true cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true creation_date: type: string format: date-time required: - - artist_credit - - cover - - title + - artist_credit + - cover + - title TrackMetadata: type: object properties: @@ -25599,8 +25402,8 @@ components: cover_data: type: string required: - - album - - artist_credit + - album + - artist_credit TrackRequest: type: object properties: @@ -25610,11 +25413,11 @@ components: $ref: '#/components/schemas/ArtistCreditRequest' attributed_to: allOf: - - $ref: '#/components/schemas/APIActorRequest' + - $ref: '#/components/schemas/APIActorRequest' nullable: true description: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true id: type: integer @@ -25644,22 +25447,22 @@ components: minLength: 1 cover: allOf: - - $ref: '#/components/schemas/CoverFieldRequest' + - $ref: '#/components/schemas/CoverFieldRequest' nullable: true required: - - artist_credit - - attributed_to - - copyright - - cover - - creation_date - - disc_number - - downloads_count - - fid - - id - - is_local - - mbid - - position - - title + - artist_credit + - attributed_to + - copyright + - cover + - creation_date + - disc_number + - downloads_count + - fid + - id + - is_local + - mbid + - position + - title TrackUpload: type: object properties: @@ -25683,25 +25486,14 @@ components: type: boolean readOnly: true required: - - bitrate - - duration - - extension - - is_local - - listen_url - - mimetype - - size - - uuid - UploadBulkUpdateRequest: - type: object - properties: - uuid: - type: string - format: uuid - privacy_level: - $ref: '#/components/schemas/LibraryPrivacyLevelEnum' - required: - - privacy_level - - uuid + - bitrate + - duration + - extension + - is_local + - listen_url + - mimetype + - size + - uuid UploadForOwner: type: object properties: @@ -25721,7 +25513,7 @@ components: nullable: true track: allOf: - - $ref: '#/components/schemas/Track' + - $ref: '#/components/schemas/Track' nullable: true library: type: string @@ -25746,10 +25538,8 @@ components: nullable: true import_status: allOf: - - $ref: '#/components/schemas/ImportStatusEnum' + - $ref: '#/components/schemas/ImportStatusEnum' default: pending - privacy_level: - $ref: '#/components/schemas/LibraryPrivacyLevelEnum' import_details: readOnly: true import_metadata: {} @@ -25763,15 +25553,15 @@ components: nullable: true maxLength: 500 required: - - bitrate - - creation_date - - duration - - import_date - - import_details - - metadata - - mimetype - - size - - uuid + - bitrate + - creation_date + - duration + - import_date + - import_details + - metadata + - mimetype + - size + - uuid UploadForOwnerRequest: type: object properties: @@ -25780,7 +25570,7 @@ components: minLength: 1 track: allOf: - - $ref: '#/components/schemas/TrackRequest' + - $ref: '#/components/schemas/TrackRequest' nullable: true library: type: string @@ -25788,10 +25578,8 @@ components: type: string import_status: allOf: - - $ref: '#/components/schemas/ImportStatusEnum' + - $ref: '#/components/schemas/ImportStatusEnum' default: pending - privacy_level: - $ref: '#/components/schemas/LibraryPrivacyLevelEnum' import_metadata: {} import_reference: type: string @@ -25806,7 +25594,7 @@ components: format: binary writeOnly: true required: - - audio_file + - audio_file Usage: type: object properties: @@ -25817,7 +25605,7 @@ components: localComments: type: integer required: - - users + - users UserBasic: type: object properties: @@ -25839,12 +25627,12 @@ components: format: date-time avatar: allOf: - - $ref: '#/components/schemas/Attachment' + - $ref: '#/components/schemas/Attachment' nullable: true required: - - avatar - - id - - username + - avatar + - id + - username UserBasicRequest: type: object properties: @@ -25864,11 +25652,11 @@ components: format: date-time avatar: allOf: - - $ref: '#/components/schemas/AttachmentRequest' + - $ref: '#/components/schemas/AttachmentRequest' nullable: true required: - - avatar - - username + - avatar + - username UserDetails: type: object description: User model w/o password @@ -25895,9 +25683,9 @@ components: type: string maxLength: 150 required: - - email - - pk - - username + - email + - pk + - username UserDetailsRequest: type: object description: User model w/o password @@ -25916,7 +25704,7 @@ components: type: string maxLength: 150 required: - - username + - username UserFilter: type: object properties: @@ -25931,16 +25719,16 @@ components: format: date-time readOnly: true required: - - creation_date - - target - - uuid + - creation_date + - target + - uuid UserFilterRequest: type: object properties: target: $ref: '#/components/schemas/ModerationTargetRequest' required: - - target + - target UserTrackFavorite: type: object properties: @@ -25949,19 +25737,19 @@ components: readOnly: true actor: allOf: - - $ref: '#/components/schemas/APIActor' + - $ref: '#/components/schemas/APIActor' readOnly: true track: allOf: - - $ref: '#/components/schemas/Track' + - $ref: '#/components/schemas/Track' readOnly: true creation_date: type: string format: date-time required: - - actor - - id - - track + - actor + - id + - track UserTrackFavoriteWrite: type: object properties: @@ -25974,8 +25762,8 @@ components: type: string format: date-time required: - - id - - track + - id + - track UserTrackFavoriteWriteRequest: type: object properties: @@ -25985,7 +25773,7 @@ components: type: string format: date-time required: - - track + - track UserWrite: type: object properties: @@ -26005,7 +25793,7 @@ components: nullable: true summary: allOf: - - $ref: '#/components/schemas/Content' + - $ref: '#/components/schemas/Content' nullable: true UserWriteRequest: type: object @@ -26029,10 +25817,10 @@ components: nullable: true summary: allOf: - - $ref: '#/components/schemas/ContentRequest' + - $ref: '#/components/schemas/ContentRequest' nullable: true required: - - avatar + - avatar UsersUsage: type: object properties: @@ -26045,9 +25833,9 @@ components: type: integer readOnly: true required: - - activeHalfyear - - activeMonth - - total + - activeHalfyear + - activeMonth + - total VerifyEmailRequest: type: object properties: @@ -26056,7 +25844,7 @@ components: writeOnly: true minLength: 1 required: - - key + - key securitySchemes: ApplicationToken: type: http @@ -26119,18 +25907,18 @@ components: write:instance:requests: '' write:instance:notes: '' servers: - - url: https://demo.funkwhale.audio - description: Demo Server - - url: https://funkwhale.audio - description: Read server with real content - - url: '{protocol}://{domain}' - description: Custom server - variables: - domain: - default: yourdomain - description: Your Funkwhale Domain - protocol: - enum: - - http - - https - default: https +- url: https://demo.funkwhale.audio + description: Demo Server +- url: https://funkwhale.audio + description: Read server with real content +- url: '{protocol}://{domain}' + description: Custom server + variables: + domain: + default: yourdomain + description: Your Funkwhale Domain + protocol: + enum: + - http + - https + default: https diff --git a/docs/developer/api/schema.md b/docs/developer/api/schema.md new file mode 100644 index 000000000..af26fae59 --- /dev/null +++ b/docs/developer/api/schema.md @@ -0,0 +1,7 @@ +# OpenApi schema + +The frontend need up to date schemas ! If you change the api you need to upgrade the schema by running : `docker compose run --rm api funkwhale-manage spectacular > ./api/funkwhale_api/common/schema.yml`. + +Then you need to upgrade the frontend schema has well by running `yarn generate-types-from-local-schema`. + +Be aware that `get_signup_form_additional_fields_serializer` can tweak the schema generation. diff --git a/front/src/locales/ca.json b/front/src/locales/ca.json index dff22c8ba..cbed8df9e 100644 --- a/front/src/locales/ca.json +++ b/front/src/locales/ca.json @@ -2802,7 +2802,11 @@ "libraryAcceptFollow": "{ username } ha acceptat el seguiment de la biblioteca \"{ library }\"", "libraryFollow": "{ username } ha seguit la teva biblioteca \"{ library }\"", "libraryPendingFollow": "{ username } vol seguir la teva biblioteca \"{ library }\"", - "libraryReject": "Has rebutjat la petició de {username} per seguir \"{library}\"" + "libraryReject": "Has rebutjat la petició de {username} per seguir \"{library}\"", + "userAcceptFollow": "{username} ha acceptat que el seguiu", + "userFollow": "{username} et segueix", + "userPendingFollow": "{username} vol seguir-vos", + "userReject": "Heu rebutjat la sol·licitud de {username} per seguir-vos" } } }, @@ -2865,6 +2869,19 @@ "name": "La meva impressionant llista de reproducció" } }, + "PlaylistDropdown": { + "button": { + "export": { + "description": "Això proporcionarà un fitxer xspf amb les dades de la llista de reproducció", + "header": "Descàrrega la llista de reproducció" + }, + "import": { + "description": "Això actualitzarà la llista de reproducció amb el contingut del fitxer xspf. Se suprimiran les pistes existents a la llista de reproducció", + "header": "Reconstrueix la llista de reproducció" + } + }, + "more": "Més" + }, "PlaylistModal": { "button": { "addDuplicate": "Afegeix de totes maneres", @@ -3395,6 +3412,7 @@ "moderation": "Moderació", "music": "Música", "playlists": "Llistes de reproducció", + "qualityFilters": "Explora els filtres de qualitat de la pàgina", "sections": "Seccions", "security": "Seguretat", "settings": "Paràmetres de la instància", @@ -4412,7 +4430,7 @@ }, "meta": { "failedTracks": "Pistes fallides: {tracks}", - "lastUpdate": "Última actualització: · ", + "lastUpdate": "Última actualització:", "tracks": "{ n } pista | { n } pistes" }, "modal": { diff --git a/front/src/locales/es.json b/front/src/locales/es.json index 93075ed6f..7f8f11153 100644 --- a/front/src/locales/es.json +++ b/front/src/locales/es.json @@ -395,7 +395,8 @@ "help": { "discography": "Publica la música que haces como una bonita discografía de álbumes y sencillos.", "podcast": "Aloja tus episodios y mantén a tu comunidad actualizada.", - "podcastFields": "Usado para el campo itunes:email y itunes:name requerido por ciertas plataformas como Spotify o iTunes" + "podcastFields": "Usado para el campo itunes:email y itunes:name requerido por ciertas plataformas como Spotify o iTunes", + "username": "Usado en URL y para seguir este canal en el Fediverso. No puede ser cambiado luego." }, "label": { "category": "Categoría", @@ -407,8 +408,13 @@ "name": "Nombre", "owner": "Propietario", "podcast": "Podcasts", + "subcategory": "Subcategoría", + "tags": "Etiquetas", "username": "Manejo de Fediverse" }, + "legend": { + "purpose": "¿Para qué será usado este canal?" + }, "loader": { "loading": "Subiendo" }, @@ -454,6 +460,9 @@ }, "message": { "copy": "¡Texto copiado al portapapeles!" + }, + "warning": { + "anonymous": "Compartir no funcionará porque esta manada no permite a los usuarios anónimos acceder al contenido." } }, "LibraryFollowButton": { @@ -477,6 +486,7 @@ "playPlaylist": "Vaciar lista de reproducción", "playTrack": "Reproducir canción", "playTracks": "Reproducir canción", + "report": "Reportar…", "startRadio": "Reproducir canciones similares", "trackDetails": "Detalles" }, @@ -506,7 +516,17 @@ "unmute": "Activar sonido" }, "meta": { - "position": "{ index } de { length }" + "position": "{ index } de { length }", + "unknownAlbum": "Álbum desconocido", + "unknownArtist": "Artista desconocido" + } + }, + "PlayerControls": { + "labels": { + "next": "Pista siguiente", + "pause": "Pausa", + "play": "Reproducir", + "previous": "Pista anterior" } }, "Search": { @@ -524,6 +544,9 @@ } }, "SearchBar": { + "empty": { + "noResults": "Perdón, no hay resultados para esta búsqueda" + }, "header": { "noResults": "No se han encontrado coincidencias" }, @@ -535,11 +558,13 @@ "podcasts": "Podcasts" }, "search": "Buscar música", + "tag": "Etiqueta", "track": "Canción" }, "link": { "fediverse": "Buscar en Wikipedia", - "more": "Más resultados 🡒" + "more": "Más resultados 🡒", + "rss": "Suscribirse a este podcast vía RSS" }, "placeholder": { "search": "Buscar artistas, álbumes, canciones…" @@ -652,6 +677,7 @@ }, "header": { "appDetails": "Detalles de la aplicación", + "appSecretWarning": "Mantener una copia de este token en un lugar seguro.", "editApp": "Error al aplicar la acción" }, "help": { @@ -665,6 +691,9 @@ "link": { "settings": "Volver a los ajustes" }, + "message": { + "appSecretWarning": "No serás capaz de verlo de nuevo una vez que dejes esta pantalla." + }, "title": "Error al aplicar la acción" }, "ApplicationForm": { @@ -675,14 +704,22 @@ "header": { "failure": "No podemos crear tu cuenta" }, + "help": { + "redirectUri": "Usa \"urn:ietf:wg:oauth:2.0:oob\" como URI de redirección si tu aplicación no está alojada en la web." + }, "label": { "name": "Nombre", "redirectUri": "Redireccionar URI", "scopes": { "description": "La comprobación de los ámbitos padre \"Lectura\" o \"Escritura\" implica el acceso a todos los ámbitos hijos correspondientes.", + "label": "Alcances", "read": { "description": "Acceso de sólo lectura a los datos del usuario", "label": "Leer" + }, + "write": { + "description": "Acceso de solo lectura a datos de usuario", + "label": "Escritura" } } } @@ -703,10 +740,16 @@ "authorize": "Autorizar la aplicación de terceros", "authorizeFailure": "Error al aplicar la acción", "fetchFailure": "Error al crear la invitación", - "readOnly": "Sólo lectura" + "readOnly": "Sólo lectura", + "writeOnly": "Solo escritura" }, "help": { - "pasteCode": "Copie y pegue el siguiente código en la aplicación:" + "copyCode": "Se te mostrará un código para copiar y pegar en la aplicación", + "pasteCode": "Copie y pegue el siguiente código en la aplicación:", + "redirect": "Serás redireccionado a { 0 }" + }, + "message": { + "unknownPermissions": "La aplicación también está solicitando los siguientes permisos desconocidos:" }, "title": "Autorizar la aplicación" }, @@ -729,6 +772,9 @@ "createAccount": "Crear una cuenta", "resetPassword": "Restablecer tu contraseña" }, + "message": { + "redirect": "Serás redireccionado a {domain} para autenticar" + }, "placeholder": { "username": "Introduce tu nombre de usuario o correo electrónico" } @@ -779,22 +825,29 @@ "refresh": "Recargar", "remove": "Quitar", "removeApp": "Borrar lista de reproducción", + "revoke": "Revocar", + "revokeAccess": "Revocar acceso", "update": "Actualizar", "updateSettings": "Actualizar ajustes" }, "description": { + "authorizedApps": "Esta es la lista de aplicaciones que tienen acceso a tus datos de la cuenta.", "changeEmail": "Cambie la dirección de correo electrónico asociada a su cuenta. Le enviaremos una confirmación a la nueva dirección.", "changePassword": { "paragraph1": "Cambiar tu contraseña también cambiará la contraseña de la API de Subsonic, si pediste una.", "paragraph2": "Tendrás que actualizar tu contraseña en los clientes que usan esta contraseña." }, - "contentFilters": "Los filtros de contenido te ayudan a ocultar los contenidos que no quieres ver en el servicio." + "contentFilters": "Los filtros de contenido te ayudan a ocultar los contenidos que no quieres ver en el servicio.", + "deleteAccount": "Puedes eliminar permanentemente e irreversiblemente tu cuenta y todos los datos asociados usando el siguiente formulario. Se te pedirá confirmación.", + "plugins": "Usa plugins para extender Funkwhale y obtener características adicionales.", + "yourApps": "Esta es la lista de aplicaciones que tienes registradas." }, "header": { "accountFailure": "No se puede iniciar la sesión", "accountSettings": "Configuración de cuenta", "authorizedApps": "Aplicaciones autorizadas", "avatar": "Avatar", + "avatarFailure": "Tu avatar no puede ser guardado", "changeEmail": "Confirma tu dirección de correo", "changePassword": "Cambiar mi contraseña", "contentFilters": "Filtros de contenido", @@ -803,6 +856,7 @@ "hiddenArtists": "Explorando artistas", "noApps": "No tienes ninguna regla para esta cuenta.", "noPersonalApps": "No tienes ninguna regla para esta cuenta.", + "passwordFailure": "Tu contraseña no puede ser cambiada", "plugins": "Plugins", "settingsUpdated": "Ajustes actualizados", "updateFailure": "Ajustes actualizados", @@ -825,6 +879,7 @@ "newApp": "Crear una nueva lista de reproducción" }, "message": { + "confirmDelete": "Tu solicitud de eliminación fue enviada, tu cuenta y contenido serán borrados en breve", "currentEmail": "Tienes iniciada actualmente sesión como { email }." }, "modal": { @@ -837,12 +892,22 @@ "header": "¿Cambiar tu contraseña?" }, "deleteAccount": { + "content": { + "warning": "Esto es irreversible y borrará permanentemente tus datos de nuestros servidores. Se cerrará inmediatamente la sesión." + }, "header": "¿Quieres restaurar tu cola de reproducción anterior?" }, "deleteApp": { "content": { "warning": "Esto borrará por completo esta lista de reproducción y no se podrá deshacer." - } + }, + "header": "¿Borrar aplicación {app}?" + }, + "revokeApp": { + "content": { + "warning": "Esto prevendrá que esta aplicación acceda al servicio en tu nombre." + }, + "header": "¿Revocar el acceso para la aplicación {app}?" } }, "table": { @@ -861,11 +926,15 @@ "yourApps": { "header": { "application": "Aplicación", - "creationDate": "Fecha de creación" + "creationDate": "Fecha de creación", + "scopes": "Alcances" } } }, - "title": "Configuración de Cuenta" + "title": "Configuración de Cuenta", + "warning": { + "deleteAccount": "Tu cuneta será eliminada de nuestros servidores en unos minutos. También notificaremos a otros servidores que podrían copiar algunos de tus datos y así ellos procederán a la eliminación. Por favor tenga en cuenta que algunos de estos servidores podrían estar fuera de línea o no estar dispuestos a cumplir." + } }, "SignupForm": { "button": { @@ -877,10 +946,13 @@ }, "label": { "email": "Dirección de correo electrónico", + "invitation": "Código de invitación", "password": "Contraseña", "username": "Nombre de usuario" }, "message": { + "accountCreated": "Tu cuenta fue creada exitosamente. Por favor verifica tu dirección de correo electrónico antes de tratar de iniciar sesión.", + "awaitingReview": "Tu solicitud de datos fue enviada exitosamente. Se te notificará por correo electrónico cuando nuestro equipo de moderación halla revisado tu solicitud.", "registrationClosed": "La inscripción a esta instancia está cerrada, necesitarás un código de invitación para inscribirte.", "requiresReview": "Las inscripciones en este pod están abiertas, pero son revisadas por los moderadores antes de su aprobación." }, @@ -956,7 +1028,8 @@ }, "AlbumSelect": { "label": { - "album": "Álbum" + "album": "Álbum", + "series": "Series" }, "meta": { "tracks": "{ n } canción | { n } canciones" @@ -981,6 +1054,7 @@ "auth": "Si dejas de seguir esta biblioteca, perderás acceso a su contenido" }, "title": { + "subscribe": "Suscribirse", "unsubscribe": "{ count } favorito" } }, @@ -988,7 +1062,9 @@ "button": { "edit": "Editar", "ignore": "Ignorar", - "remove": "Quitar" + "remove": "Quitar", + "resume": "Resumen", + "retry": "Reintentar" }, "description": { "extensions": "Extensiones soportadas: { extensions }" @@ -1004,12 +1080,16 @@ "openBrowser": "Explorar…" }, "message": { - "dragAndDrop": "Arrastre y suelte sus archivos aquí o abra el navegador para cargar sus archivos" + "dragAndDrop": "Arrastre y suelte sus archivos aquí o abra el navegador para cargar sus archivos", + "pending": "Tienes algunas cargas de borradores pendientes de publicación." }, "status": { "errored": "Error", "pending": "En espera", "uploading": "Subiendo" + }, + "warning": { + "quota": "No tienes espacio disponible para subir tus archivos. Por favor contacta a los moderadores." } }, "UploadMetadataForm": { @@ -1017,6 +1097,7 @@ "description": "Descripción", "image": "Nombre", "position": "Paginación", + "tags": "Etiquetas", "title": "Título" } }, @@ -1037,7 +1118,8 @@ "uploadFiles": "¿Eliminar la biblioteca?" }, "meta": { - "files": "{ n } archivo | { n } archivos" + "files": "{ n } archivo | { n } archivos", + "quota": "Almacenamiento restante: {space}" } } }, @@ -1048,6 +1130,7 @@ "go": "Ir", "launch": "Iniciar", "refresh": "Actualiza el contenido de la tabla", + "select": "Seleccionar", "selectAll": "Seleccionar un filtro", "selectCurrentPage": "Seleccionar solo la página actual", "selectElement": "Seleccionar { n } elemento | Seleccionar los { n } elementos", @@ -1098,13 +1181,17 @@ }, "ContentForm": { "button": { - "preview": "Previsualización" + "preview": "Previsualización", + "write": "Escribir" }, "empty": { "noContent": "Archivos pendientes." }, "help": { "markdown": "La sintaxis Markdown es compatible." + }, + "placeholder": { + "input": "Escribe algunas palabras aquí…" } }, "CopyInput": { @@ -1140,6 +1227,7 @@ }, "ExpandableDiv": { "button": { + "less": "Mostrar menos", "more": "Mostrar 1 álbum adicional" } }, @@ -1155,6 +1243,12 @@ } }, "LoginModal": { + "description": { + "noAccess": "No tienes acceso" + }, + "header": { + "unauthenticated": "No autenticado" + }, "link": { "login": "Iniciar sesión", "signup": "Inscripción" @@ -1164,6 +1258,7 @@ "button": { "cancel": "Cancelar", "edit": "Editar", + "less": "Mostrar menos", "more": "Mostrar 1 álbum adicional", "update": "Mi descripción molona" }, @@ -1174,10 +1269,16 @@ "failure": "Error al aplicar la acción" } }, + "UserLink": { + "link": { + "username": "{'@'}{username}" + } + }, "UserMenu": { "label": { "language": "Cambiar idioma", - "shortcuts": "Atajos de teclado" + "shortcuts": "Atajos de teclado", + "theme": "Cambiar tema" }, "link": { "about": "Acerca de", @@ -1203,11 +1304,13 @@ }, "label": { "language": "Cambiar idioma", - "shortcuts": "Atajos de teclado" + "shortcuts": "Atajos de teclado", + "theme": "Cambiar tema" }, "link": { "about": "Acerca de", "chat": "Sala de chat", + "docs": "Documentación", "forum": "Foro", "git": "Sistema de seguimiento de incidentes", "login": "Iniciar sesión", @@ -1265,6 +1368,8 @@ }, "description": { "failure": "Ocurrió un error al intentar actualizar los datos:", + "pending": "Nuestro servidor no procesó a tiempo la solicitud de actualización. Se procesará más tarde.", + "skipped": "El servidor remoto respondió, pero los datos devueltos no son compatibles con Funkwhale.", "success": "Los datos se han actualizado con éxito desde el servidor remoto." }, "header": { @@ -1276,7 +1381,8 @@ "success": "Actualización exitosa" }, "loader": { - "awaitingResult": "Cargando tus favoritos…" + "awaitingResult": "Cargando tus favoritos…", + "fetchRequest": "Solicitando una búsqueda…" }, "table": { "error": { @@ -1287,7 +1393,11 @@ "value": { "connectionError": "Imposible conectar con el servidor remoto", "httpError": "Ha ocurrido un error HTTP al contactar con el servidor remoto", - "invalidAttributesError": "Los datos devueltos por el servidor remoto tenían atributos inválidos o faltaban" + "httpStatus": "El servidor remoto respondió con HTTP {status}", + "invalidAttributesError": "Los datos devueltos por el servidor remoto tenían atributos inválidos o faltaban", + "invalidJsonError": "El servidor remoto devolvió datos JSON o JSON-LD no válidos", + "timeoutError": "El servidor remoto no respondió a tiempo", + "unknownError": "Error desconocido" } } } @@ -1320,7 +1430,8 @@ "meta": { "episodes": "{ n } episodio | { n } episodios", "tracks": "{ n } canción | { n } canciones" - } + }, + "title": "Álbum" }, "AlbumDetail": { "description": { @@ -1345,6 +1456,7 @@ }, "link": { "discogs": "Buscar música", + "django": "Ver en el administrador de Django", "domain": "Miembro desde { date }", "moderation": "Actualizar regla de moderación", "musicbrainz": "Ver en MusicBrainz" @@ -1365,6 +1477,9 @@ "header": { "edit": "Reproducir canción", "suggest": "No podemos añadir la canción a una lista de reproducción" + }, + "message": { + "remote": "Este objeto es gestionado por otro servidor, no puedes editarlo." } }, "Albums": { @@ -1378,7 +1493,8 @@ "browse": "Explorando álbumes" }, "label": { - "search": "Buscar" + "search": "Buscar", + "tags": "Etiquetas" }, "link": { "addMusic": "Añadir algo de música" @@ -1409,6 +1525,7 @@ }, "link": { "discogs": "Buscar música", + "django": "Ver en el administrador de Django", "domain": "Miembro desde { date }", "moderation": "Actualizar regla de moderación", "musicbrainz": "Ver en MusicBrainz", @@ -1440,12 +1557,18 @@ }, "link": { "filter": "Ver archivos" + }, + "message": { + "filter": "Actualmente estás ocultando contenido relacionado a este artista." } }, "ArtistEdit": { "header": { "edit": "Reproducir canción", "suggest": "No podemos añadir la canción a una lista de reproducción" + }, + "message": { + "remote": "Este objeto está gestionado por otro servidor, no puedes editarlo." } }, "Artists": { @@ -1461,7 +1584,8 @@ }, "label": { "excludeCompilation": "Excluir recopilación de artistas", - "search": "Nombre del artista" + "search": "Nombre del artista", + "tags": "Etiquetas" }, "ordering": { "direction": { @@ -1488,7 +1612,13 @@ "header": { "modification": "Fecha de modificación" }, + "link": { + "track": "Pista #{id} - {name}" + }, "modal": { + "content": { + "warning": "La sugerencia será borrada completamente, esta acción es irreversible." + }, "delete": { "header": "¿Borrar esta sugerencia?" } @@ -1513,13 +1643,29 @@ "EditForm": { "button": { "cancel": "Cancelar", - "clear": "Borrar" + "clear": "Borrar", + "new": "Enviar otra edición", + "reset": "Reiniciar al valor inicial", + "showAll": "Mostrar todas las ediciones", + "showUnreviewed": "Restringir las ediciones sin revición", + "submit": "Enviar y aplicar edición", + "suggest": "Enviar sugerencia" + }, + "empty": { + "suggestEdit": "Sugerir un cambio usando el siguiente formulario" }, "header": { "failure": "Error al guardar los cambios", "recentEdits": "Añadidos recientemente", + "success": "Tu edición fue enviada exitosamente.", "unreviewed": "Ediciones recientes en espera de revisión" }, + "label": { + "summary": "Resumen (opcional)" + }, + "message": { + "noPermission": "No tienes permiso para editar este objeto, pero puedes sugerir cambios. Una vez enviadas, las sugerencias serán revisadas antes de aprobarse." + }, "notApplicable": "N/A", "placeholder": { "summary": "Ha ocurrido un error al guardar los cambios." @@ -1531,15 +1677,21 @@ "retry": "Biblioteca actualizada" }, "description": { - "import": "Reiniciar importación" + "import": "Reiniciar importación", + "previousImport": "Resultados de tu importación previa:" + }, + "empty": { + "noFiles": "0" }, "header": { "failure": "Error al guardar los cambios", + "local": "Subir música de '~/tu almacenamiento local", "server": "Estado de la importación", "status": "Estado de la importación" }, "label": { "extensions": "Extensiones soportadas: { extensions }", + "remainingSpace": "Almacenamiento restante", "uploadWidget": "Haga clic para seleccionar los archivos que desea cargar o arrastre y suelte los archivos o directorios" }, "link": { @@ -1548,7 +1700,9 @@ "uploading": "Subiendo" }, "message": { + "listener": "Esta página está pidiendo que confirmes que quieres irte - los dato que has ingresado podrían no guardarse.", "local": { + "copyright": "No subas contenido con copyright en una biblioteca pública, de otro modo, podrías estar infringiendo la ley", "format": "Las canciones que estás subiendo estén etiquetadas correctamente:", "message": "Estás a punto de subir música a tu biblioteca. Antes de continuar asegúrate que:", "tag": "Las canciones que estás subiendo estén etiquetadas correctamente." @@ -1562,6 +1716,7 @@ "size": "Tamaño", "status": "Estado" }, + "progress": "{percent}%", "status": { "pending": "En espera", "uploaded": "Subido", @@ -1573,6 +1728,7 @@ "denied": "Subida rechazada, asegúrate que el archivo no es demasiado grande y que no has alcanzado tu cuota", "extension": "Tipo de archivo no válido, asegúrese de que está cargando un archivo de audio. Las extensiones de archivo admitidas son { extensions }", "network": "Ha ocurrido un error de red al subir este archivo", + "retry": "Reintentar", "size": "No es posible cargar este archivo, asegúrate que no es demasiado grande", "timeout": "Timeout en la subida, intentalo de nuevo" } @@ -1604,9 +1760,11 @@ "error": { "importFailure": "Ocurrió un error durante el proceso de carga. Encontrará más información abajo.", "invalidMetadata": { - "label": "Metadatos inválidos" + "label": "Metadatos inválidos", + "message": "Los metadatos incluidos en el archivo no son válidos o faltan algunos campos obligatorios." }, "unknownError": { + "label": "Error desconocido", "message": "Ha ocurrido un error desconocido" } },