From ef8679373e3cef80861c5f70da79f1add336b7ae Mon Sep 17 00:00:00 2001 From: Georg Krause Date: Thu, 11 Jan 2024 10:10:21 +0000 Subject: [PATCH] fix: Pass missing FUNKWHALE_URL var to schema generation --- api/Makefile | 1 + api/schema.yml | 946 ++++++++++++++++++++++++++++++++++--------------- 2 files changed, 658 insertions(+), 289 deletions(-) diff --git a/api/Makefile b/api/Makefile index 421cde911..ec0bab973 100644 --- a/api/Makefile +++ b/api/Makefile @@ -7,6 +7,7 @@ install: poetry install --all-extras export DJANGO_SETTINGS_MODULE=config.settings.local +export FUNKWHALE_URL=http://schema.generation lint: poetry run pylint \ diff --git a/api/schema.yml b/api/schema.yml index 73d38569d..f0e63e8c4 100644 --- a/api/schema.yml +++ b/api/schema.yml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Funkwhale API - version: 1.2.9 + version: 1.4.0 description: | # Funkwhale API @@ -37,7 +37,7 @@ info: - How many more requests in the scope can be made within the rate-limit timeframe (`X-RateLimit-Remaining`) - How much time does the client need to wait to send another request (`Retry-After`) - For more information, check our [rate limit documentation](https://docs.funkwhale.audio/admin/configuration.html#api-configuration) + For more information, check our [rate limit documentation](https://docs.funkwhale.audio/developer/api/rate-limit.html) ## Resources @@ -68,7 +68,7 @@ paths: tags: - activity security: - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -124,7 +124,21 @@ paths: - related - release_date - title - description: Ordering + 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__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -168,7 +182,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -198,7 +212,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -221,7 +235,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -243,7 +257,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -305,7 +319,21 @@ paths: - related - release_date - title - description: Ordering + 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__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -347,7 +375,7 @@ paths: tags: - albums security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -382,7 +410,7 @@ paths: $ref: "#/components/schemas/AlbumRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -448,7 +476,21 @@ paths: - related - release_date - title - description: Ordering + 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__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -492,7 +534,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -558,7 +600,21 @@ paths: - related - release_date - title - description: Ordering + 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__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -602,7 +658,7 @@ paths: security: - oauth2: - read:edits - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -639,7 +695,7 @@ paths: security: - oauth2: - write:edits - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -711,7 +767,21 @@ paths: - name - random - related - description: Ordering + 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 @@ -755,7 +825,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -778,7 +848,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -856,7 +926,21 @@ paths: - name - random - related - description: Ordering + 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 @@ -898,7 +982,7 @@ paths: tags: - artists security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -933,7 +1017,7 @@ paths: $ref: "#/components/schemas/ArtistWithAlbumsRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1011,7 +1095,21 @@ paths: - name - random - related - description: Ordering + 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 @@ -1055,7 +1153,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1133,7 +1231,21 @@ paths: - name - random - related - description: Ordering + 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 @@ -1177,7 +1289,7 @@ paths: security: - oauth2: - read:edits - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1214,7 +1326,7 @@ paths: security: - oauth2: - write:edits - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1245,7 +1357,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -1268,7 +1380,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1290,7 +1402,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -1339,7 +1451,7 @@ paths: $ref: "#/components/schemas/PasswordChangeRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1373,7 +1485,7 @@ paths: $ref: "#/components/schemas/PasswordResetRequest" required: true security: - - token: [] + - ApplicationToken: [] - {} responses: "200": @@ -1410,7 +1522,7 @@ paths: $ref: "#/components/schemas/PasswordResetConfirmRequest" required: true security: - - token: [] + - ApplicationToken: [] - {} responses: "200": @@ -1440,7 +1552,7 @@ paths: $ref: "#/components/schemas/RegisterRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -1474,7 +1586,7 @@ paths: $ref: "#/components/schemas/PasswordChangeRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1503,7 +1615,7 @@ paths: $ref: "#/components/schemas/VerifyEmailRequest" required: true security: - - token: [] + - ApplicationToken: [] - {} responses: "200": @@ -1523,7 +1635,7 @@ paths: tags: - auth security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1560,7 +1672,7 @@ paths: $ref: "#/components/schemas/UserDetailsRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1596,7 +1708,7 @@ paths: schema: $ref: "#/components/schemas/PatchedUserDetailsRequest" security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1629,7 +1741,15 @@ paths: - creation_date - modification_date - random - description: Ordering + 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 @@ -1669,7 +1789,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1699,7 +1819,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -1722,7 +1842,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1759,7 +1879,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1795,7 +1915,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1817,7 +1937,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -1836,7 +1956,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1872,7 +1992,7 @@ paths: $ref: "#/components/schemas/ChannelRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1908,7 +2028,7 @@ paths: $ref: "#/components/schemas/ChannelRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -1924,7 +2044,7 @@ paths: tags: - channels security: - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -1934,7 +2054,7 @@ paths: tags: - channels security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -1965,7 +2085,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2012,7 +2132,7 @@ paths: security: - oauth2: - read:favorites - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2042,7 +2162,7 @@ paths: security: - oauth2: - write:favorites - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -2065,7 +2185,7 @@ paths: security: - oauth2: - write:favorites - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -2081,7 +2201,7 @@ paths: security: - oauth2: - read:favorites - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2112,7 +2232,7 @@ paths: security: - oauth2: - write:favorites - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2127,7 +2247,7 @@ paths: security: - oauth2: - write:favorites - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -2144,7 +2264,7 @@ paths: tags: - federation security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2165,7 +2285,7 @@ paths: tags: - federation security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2198,7 +2318,7 @@ paths: tags: - federation security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2219,7 +2339,7 @@ paths: tags: - federation security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2248,7 +2368,7 @@ paths: $ref: "#/components/schemas/FetchRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -2269,7 +2389,7 @@ paths: tags: - federation security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2308,7 +2428,7 @@ paths: security: - oauth2: - read:follows - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2338,7 +2458,7 @@ paths: security: - oauth2: - write:follows - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -2361,7 +2481,7 @@ paths: security: - oauth2: - read:follows - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2383,7 +2503,7 @@ paths: security: - oauth2: - write:follows - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -2417,7 +2537,7 @@ paths: security: - oauth2: - write:follows - - token: [] + - ApplicationToken: [] responses: "404": description: No response body @@ -2453,7 +2573,7 @@ paths: security: - oauth2: - write:follows - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2473,7 +2593,7 @@ paths: security: - oauth2: - read:follows - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2524,7 +2644,7 @@ paths: security: - oauth2: - read:notifications - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2547,7 +2667,7 @@ paths: security: - oauth2: - read:notifications - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2584,7 +2704,7 @@ paths: security: - oauth2: - write:notifications - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2620,7 +2740,7 @@ paths: security: - oauth2: - write:notifications - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2662,7 +2782,7 @@ paths: security: - oauth2: - write:notifications - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2685,7 +2805,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2723,7 +2843,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2754,7 +2874,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2805,7 +2925,7 @@ paths: security: - oauth2: - read:listenings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2835,7 +2955,7 @@ paths: security: - oauth2: - write:listenings - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -2858,7 +2978,7 @@ paths: security: - oauth2: - read:listenings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2886,7 +3006,7 @@ paths: security: - oauth2: - read:instance:settings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2916,7 +3036,7 @@ paths: security: - oauth2: - read:instance:settings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -2958,7 +3078,7 @@ paths: security: - oauth2: - write:instance:settings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3000,7 +3120,7 @@ paths: security: - oauth2: - write:instance:settings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3036,7 +3156,7 @@ paths: security: - oauth2: - write:instance:settings - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3110,6 +3230,10 @@ paths: - 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: @@ -3123,7 +3247,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3153,7 +3277,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -3176,7 +3300,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3213,7 +3337,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3249,7 +3373,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3271,7 +3395,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -3305,6 +3429,10 @@ paths: - 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: @@ -3324,7 +3452,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3340,7 +3468,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -3366,7 +3494,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -3377,7 +3505,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -3408,7 +3536,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3431,7 +3559,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3454,7 +3582,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3512,12 +3640,19 @@ paths: - Person - Service - Tombstone + description: |- + * `Person` - Person + * `Tombstone` - Tombstone + * `Application` - Application + * `Group` - Group + * `Organization` - Organization + * `Service` - Service tags: - manage security: - oauth2: - read:instance:accounts - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3540,7 +3675,7 @@ paths: security: - oauth2: - read:instance:accounts - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3563,7 +3698,7 @@ paths: security: - oauth2: - read:instance:accounts - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3605,7 +3740,7 @@ paths: security: - oauth2: - write:instance:accounts - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3644,7 +3779,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3667,7 +3802,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3689,7 +3824,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -3708,7 +3843,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3755,7 +3890,7 @@ paths: security: - oauth2: - read:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3785,7 +3920,7 @@ paths: security: - oauth2: - write:instance:domains - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -3808,7 +3943,7 @@ paths: security: - oauth2: - read:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3844,7 +3979,7 @@ paths: security: - oauth2: - write:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3880,7 +4015,7 @@ paths: security: - oauth2: - write:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3903,7 +4038,7 @@ paths: security: - oauth2: - read:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3926,7 +4061,7 @@ paths: security: - oauth2: - read:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -3968,7 +4103,7 @@ paths: security: - oauth2: - write:instance:domains - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4024,7 +4159,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4047,7 +4182,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4069,7 +4204,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -4088,7 +4223,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4130,7 +4265,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4150,6 +4285,10 @@ paths: - music - other - podcast + description: |- + * `music` - music + * `podcast` - podcast + * `other` - other - in: query name: fid schema: @@ -4190,7 +4329,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4213,7 +4352,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4235,7 +4374,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -4254,7 +4393,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4296,7 +4435,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4333,7 +4472,15 @@ paths: - creation_date - followers_count - uploads_count - description: Ordering + 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 @@ -4356,6 +4503,10 @@ paths: - 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: @@ -4365,7 +4516,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4388,7 +4539,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4425,7 +4576,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4461,7 +4612,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4483,7 +4634,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -4502,7 +4653,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4544,7 +4695,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4608,7 +4759,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4631,7 +4782,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4653,7 +4804,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -4672,7 +4823,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4714,7 +4865,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4748,6 +4899,12 @@ paths: - finished - pending - skipped + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped - in: query name: mimetype schema: @@ -4771,7 +4928,21 @@ paths: - duration - modification_date - size - description: Ordering + 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 @@ -4799,7 +4970,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4822,7 +4993,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4844,7 +5015,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -4882,7 +5053,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4949,7 +5120,7 @@ paths: security: - oauth2: - read:instance:policies - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -4979,7 +5150,7 @@ paths: security: - oauth2: - write:instance:policies - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -5002,7 +5173,7 @@ paths: security: - oauth2: - read:instance:policies - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5039,7 +5210,7 @@ paths: security: - oauth2: - write:instance:policies - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5075,7 +5246,7 @@ paths: security: - oauth2: - write:instance:policies - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5097,7 +5268,7 @@ paths: security: - oauth2: - write:instance:policies - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -5132,7 +5303,7 @@ paths: security: - oauth2: - read:instance:notes - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5162,7 +5333,7 @@ paths: security: - oauth2: - write:instance:notes - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -5185,7 +5356,7 @@ paths: security: - oauth2: - read:instance:notes - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5207,7 +5378,7 @@ paths: security: - oauth2: - write:instance:notes - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -5255,12 +5426,18 @@ paths: - 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 security: - oauth2: - read:instance:reports - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5283,7 +5460,7 @@ paths: security: - oauth2: - read:instance:reports - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5320,7 +5497,7 @@ paths: security: - oauth2: - write:instance:reports - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5356,7 +5533,7 @@ paths: security: - oauth2: - write:instance:reports - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5398,18 +5575,23 @@ paths: - 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 security: - oauth2: - read:instance:requests - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5432,7 +5614,7 @@ paths: security: - oauth2: - read:instance:requests - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5469,7 +5651,7 @@ paths: security: - oauth2: - write:instance:requests - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5505,7 +5687,7 @@ paths: security: - oauth2: - write:instance:requests - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5544,7 +5726,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5574,7 +5756,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -5596,7 +5778,7 @@ paths: security: - oauth2: - read:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5617,7 +5799,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -5655,7 +5837,7 @@ paths: security: - oauth2: - write:instance:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5698,7 +5880,7 @@ paths: security: - oauth2: - read:instance:invitations - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5727,7 +5909,7 @@ paths: security: - oauth2: - write:instance:invitations - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -5750,7 +5932,7 @@ paths: security: - oauth2: - read:instance:invitations - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5786,7 +5968,7 @@ paths: security: - oauth2: - write:instance:invitations - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5822,7 +6004,7 @@ paths: security: - oauth2: - write:instance:invitations - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5863,7 +6045,7 @@ paths: security: - oauth2: - write:instance:invitations - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5926,6 +6108,11 @@ paths: - 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: @@ -5935,7 +6122,7 @@ paths: security: - oauth2: - read:instance:users - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5958,7 +6145,7 @@ paths: security: - oauth2: - read:instance:users - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -5994,7 +6181,7 @@ paths: security: - oauth2: - write:instance:users - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6030,7 +6217,7 @@ paths: security: - oauth2: - write:instance:users - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6065,7 +6252,7 @@ paths: security: - oauth2: - read:filters - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6095,7 +6282,7 @@ paths: security: - oauth2: - write:filters - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -6118,7 +6305,7 @@ paths: security: - oauth2: - read:filters - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6140,7 +6327,7 @@ paths: security: - oauth2: - write:filters - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -6167,7 +6354,7 @@ paths: security: - oauth2: - write:reports - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -6216,7 +6403,7 @@ paths: tags: - mutations security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6237,7 +6424,7 @@ paths: tags: - mutations security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6257,7 +6444,7 @@ paths: tags: - mutations security: - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -6289,7 +6476,7 @@ paths: $ref: "#/components/schemas/APIMutationRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6325,7 +6512,7 @@ paths: $ref: "#/components/schemas/APIMutationRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6360,7 +6547,7 @@ paths: security: - oauth2: - read:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6390,7 +6577,7 @@ paths: security: - oauth2: - null - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -6412,7 +6599,7 @@ paths: security: - oauth2: - null - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6448,7 +6635,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6483,7 +6670,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6504,7 +6691,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -6537,7 +6724,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6563,7 +6750,7 @@ paths: security: - oauth2: - read:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6590,7 +6777,7 @@ paths: security: - oauth2: - read:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6614,7 +6801,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -6626,7 +6813,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6693,7 +6880,7 @@ paths: security: - oauth2: - read:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6723,7 +6910,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -6746,7 +6933,7 @@ paths: security: - oauth2: - read:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6783,7 +6970,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6819,7 +7006,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6841,7 +7028,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -6875,7 +7062,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6898,7 +7085,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -6932,7 +7119,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6970,7 +7157,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -6992,7 +7179,7 @@ paths: security: - oauth2: - write:playlists - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -7061,7 +7248,7 @@ paths: security: - oauth2: - read:playlists - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7096,7 +7283,7 @@ paths: security: - oauth2: - read:plugins - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -7107,7 +7294,7 @@ paths: security: - oauth2: - write:plugins - - token: [] + - ApplicationToken: [] responses: "201": description: No response body @@ -7126,7 +7313,7 @@ paths: security: - oauth2: - read:plugins - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -7145,7 +7332,7 @@ paths: security: - oauth2: - write:plugins - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -7164,7 +7351,7 @@ paths: security: - oauth2: - write:plugins - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -7183,7 +7370,7 @@ paths: security: - oauth2: - write:plugins - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -7238,7 +7425,7 @@ paths: security: - oauth2: - read:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7268,7 +7455,7 @@ paths: security: - oauth2: - write:radios - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -7291,7 +7478,7 @@ paths: security: - oauth2: - read:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7328,7 +7515,7 @@ paths: security: - oauth2: - write:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7364,7 +7551,7 @@ paths: security: - oauth2: - write:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7386,7 +7573,7 @@ paths: security: - oauth2: - write:radios - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -7405,7 +7592,7 @@ paths: security: - oauth2: - read:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7421,7 +7608,7 @@ paths: security: - oauth2: - read:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7452,7 +7639,7 @@ paths: security: - oauth2: - write:radios - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7481,7 +7668,7 @@ paths: $ref: "#/components/schemas/RadioSessionRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -7502,7 +7689,7 @@ paths: tags: - radios security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7531,7 +7718,7 @@ paths: $ref: "#/components/schemas/RadioSessionTrackSerializerCreateRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -7545,7 +7732,7 @@ paths: tags: - rate-limit security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7561,7 +7748,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7584,7 +7771,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7620,7 +7807,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7643,7 +7830,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7663,7 +7850,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7696,7 +7883,15 @@ paths: - creation_date - length - name - description: Ordering + 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 @@ -7720,7 +7915,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7742,7 +7937,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7771,7 +7966,7 @@ paths: $ref: "#/components/schemas/TextPreviewRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7860,7 +8055,31 @@ paths: - related - size - title - description: Ordering + 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__name` - Artist name + * `-artist__name` - Artist name (descending) + * `artist__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -7920,7 +8139,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7944,7 +8163,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -7967,7 +8186,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -8044,7 +8263,31 @@ paths: - related - size - title - description: Ordering + 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__name` - Artist name + * `-artist__name` - Artist name (descending) + * `artist__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -8102,7 +8345,7 @@ paths: tags: - tracks security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8138,7 +8381,7 @@ paths: $ref: "#/components/schemas/TrackRequest" required: true security: - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8219,7 +8462,31 @@ paths: - related - size - title - description: Ordering + 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__name` - Artist name + * `-artist__name` - Artist name (descending) + * `artist__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -8279,7 +8546,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8360,7 +8627,31 @@ paths: - related - size - title - description: Ordering + 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__name` - Artist name + * `-artist__name` - Artist name (descending) + * `artist__modification_date` - Artist modification date + * `-artist__modification_date` - Artist modification date (descending) + * `random` - Random + * `-random` - Random (descending) + * `related` - Related + * `-related` - Related (descending) explode: false style: form - name: page @@ -8420,7 +8711,7 @@ paths: security: - oauth2: - read:edits - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8458,7 +8749,7 @@ paths: security: - oauth2: - write:edits - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8495,6 +8786,12 @@ paths: - finished - pending - skipped + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped explode: true style: form - in: query @@ -8555,7 +8852,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8585,7 +8882,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "201": content: @@ -8608,7 +8905,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8645,7 +8942,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8681,7 +8978,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8703,7 +9000,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -8722,7 +9019,7 @@ paths: security: - oauth2: - read:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8764,7 +9061,7 @@ paths: security: - oauth2: - write:libraries - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8802,7 +9099,7 @@ paths: security: - oauth2: - write:profile - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8838,7 +9135,7 @@ paths: security: - oauth2: - write:profile - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8861,7 +9158,7 @@ paths: security: - oauth2: - read:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8898,7 +9195,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8920,7 +9217,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -8947,7 +9244,7 @@ paths: security: - oauth2: - write:security - - token: [] + - ApplicationToken: [] responses: "200": description: No response body @@ -8962,7 +9259,7 @@ paths: security: - oauth2: - read:profile - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -8978,7 +9275,7 @@ paths: security: - oauth2: - write:profile - - token: [] + - ApplicationToken: [] responses: "204": description: No response body @@ -9006,7 +9303,7 @@ paths: security: - oauth2: - write:profile - - token: [] + - ApplicationToken: [] responses: "200": content: @@ -9951,6 +10248,10 @@ components: - podcast - other type: string + description: |- + * `music` - music + * `podcast` - podcast + * `other` - other ContentRequest: type: object properties: @@ -9970,6 +10271,10 @@ components: - text/markdown - text/plain type: string + description: |- + * `text/html` - text/html + * `text/markdown` - text/markdown + * `text/plain` - text/plain CoverField: type: object properties: @@ -10093,6 +10398,13 @@ components: - Organization - Service type: string + description: |- + * `Person` - Person + * `Tombstone` - Tombstone + * `Application` - Application + * `Group` - Group + * `Organization` - Organization + * `Service` - Service Fetch: type: object properties: @@ -10152,6 +10464,11 @@ components: - finished - skipped type: string + description: |- + * `pending` - Pending + * `errored` - Errored + * `finished` - Finished + * `skipped` - Skipped Filter: type: object properties: @@ -10173,6 +10490,7 @@ components: enum: - json type: string + description: "* `json` - json" FullActor: type: object properties: @@ -10241,6 +10559,13 @@ components: readOnly: true default: type: string + description: |- + Return the default value to use when validating data if no input + is provided for this field. + + If a default has not been set for this field then this will simply + raise `SkipField`, indicating that no value should be set in the + validated data for this field. readOnly: true value: type: string @@ -10281,7 +10606,7 @@ components: type: type: string id: - type: integer + type: string required: - id - type @@ -10293,6 +10618,12 @@ components: - errored - skipped type: string + description: |- + * `draft` - Draft + * `pending` - Pending + * `finished` - Finished + * `errored` - Errored + * `skipped` - Skipped InboxItem: type: object properties: @@ -10325,6 +10656,9 @@ components: - to - cc type: string + description: |- + * `to` - to + * `cc` - cc InlineActor: type: object properties: @@ -10504,6 +10838,10 @@ components: - instance - everyone type: string + description: |- + * `me` - Only me + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances LibraryRequest: type: object properties: @@ -11946,6 +12284,9 @@ components: - domain - actor type: string + description: |- + * `domain` - domain + * `actor` - actor ManageTrack: type: object properties: @@ -12443,10 +12784,15 @@ components: - refused - approved type: string + description: |- + * `pending` - Pending + * `refused` - Refused + * `approved` - Approved ManageUserRequestTypeEnum: enum: - signup type: string + description: "* `signup` - Sign-up" ManageUserSimple: type: object properties: @@ -12554,7 +12900,7 @@ components: nullable: true required: - username - Metadata: + Metadata20: type: object properties: actorId: @@ -12568,15 +12914,9 @@ components: longDescription: type: string readOnly: true - rules: - type: string - readOnly: true contactEmail: type: string readOnly: true - terms: - type: string - readOnly: true nodeName: type: string readOnly: true @@ -12586,10 +12926,6 @@ components: defaultUploadQuota: type: integer readOnly: true - library: - allOf: - - $ref: "#/components/schemas/NodeInfoLibrary" - readOnly: true supportedUploadExtensions: type: array items: @@ -12598,20 +12934,30 @@ components: allOf: - $ref: "#/components/schemas/AllowListStat" readOnly: true - reportTypes: - type: array - items: - $ref: "#/components/schemas/ReportType" funkwhaleSupportMessageEnabled: type: boolean readOnly: true instanceSupportMessage: type: string readOnly: true - endpoints: - $ref: "#/components/schemas/Endpoints" usage: $ref: "#/components/schemas/MetadataUsage" + library: + allOf: + - $ref: "#/components/schemas/NodeInfoLibrary" + readOnly: true + reportTypes: + type: array + items: + $ref: "#/components/schemas/ReportType" + endpoints: + $ref: "#/components/schemas/Endpoints" + rules: + type: string + readOnly: true + terms: + type: string + readOnly: true required: - actorId - allowList @@ -12677,6 +13023,7 @@ components: enum: - artist type: string + description: "* `artist` - artist" NestedLibraryFollow: type: object properties: @@ -12744,7 +13091,7 @@ components: readOnly: true metadata: allOf: - - $ref: "#/components/schemas/Metadata" + - $ref: "#/components/schemas/Metadata20" readOnly: true required: - metadata @@ -14023,6 +14370,11 @@ components: - instance - everyone type: string + description: |- + * `me` - Only me + * `followers` - Me and my followers + * `instance` - Everyone on my instance, and my followers + * `everyone` - Everyone, including people on other instances Radio: type: object properties: @@ -14129,6 +14481,9 @@ components: properties: session: type: integer + count: + type: integer + nullable: true required: - session RadioSessionTrackSerializerCreateRequest: @@ -14136,6 +14491,9 @@ components: properties: session: type: integer + count: + type: integer + nullable: true required: - session RateLimit: @@ -14278,6 +14636,12 @@ components: - offensive_content - other type: string + description: |- + * `takedown_request` - Takedown request + * `invalid_metadata` - Invalid metadata + * `illegal_content` - Illegal content + * `offensive_content` - Offensive content + * `other` - Other Scopes: type: object properties: @@ -15062,6 +15426,10 @@ components: properties: users: $ref: "#/components/schemas/UsersUsage" + localPosts: + type: integer + localComments: + type: integer required: - users UserBasic: @@ -15314,6 +15682,9 @@ components: required: - key securitySchemes: + ApplicationToken: + type: http + scheme: bearer oauth2: type: oauth2 flows: @@ -15371,9 +15742,6 @@ components: write:instance:reports: "" write:instance:requests: "" write:instance:notes: "" - token: - type: http - scheme: bearer servers: - url: https://demo.funkwhale.audio description: Demo Server