Reference API
Cesty, parametry, datové modely a odpovědi aktuální verze API ConcertAmi. Rozbalte operaci a zobrazte úplnou definici.
Stáhnout OpenAPI JSON ↓214 cest · 249 datových modelů
POST /api/v1/auth/social/register/
Operace: social_register
{
"operationId": "social_register",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocialRegistration"
}
}
}
}
}POST /api/v1/me/social/link/
Operace: social_link
{
"operationId": "social_link",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SocialConfirmation"
}
}
}
}
}POST /api/v1/teams/{team_id}/offline/bundle/
Operace: offline_bundle
{
"operationId": "offline_bundle",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OfflineBundleInput"
}
}
}
}
}GET /api/v1/auth/apple/config/
Operace: apple_config
{
"operationId": "apple_config",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/auth/apple/start/
Operace: apple_start
{
"operationId": "apple_start",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppleStart"
}
}
}
}
}POST /api/v1/auth/apple/finish/
Operace: apple_finish
{
"operationId": "apple_finish",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppleFinish"
}
}
}
}
}POST /api/v1/me/apple/start/
Operace: account_apple_start
{
"operationId": "account_apple_start",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppleStart"
}
}
}
}
}POST /api/v1/me/apple/finish/
Operace: account_apple_finish
{
"operationId": "account_apple_finish",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AppleFinish"
}
}
}
}
}PUT /api/v1/teams/{team_id}/members/{member_id}/squads/{squad_id}/
Operace: set_person_squad
{
"operationId": "set_person_squad",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonSquadInput"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/members/{member_id}/squads/{squad_id}/
Operace: remove_person_squad
{
"operationId": "remove_person_squad",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SquadDelete"
}
}
}
}
}GET /api/v1/me/context/
Operace: context_preferences
{
"operationId": "context_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContextPreferencesOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PATCH /api/v1/me/context/
Operace: save_context_preferences
{
"operationId": "save_context_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContextPreferencesOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContextPreferenceInput"
}
}
}
}
}PUT /api/v1/teams/{team_id}/timezone/
Operace: set_team_timezone
{
"operationId": "set_team_timezone",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamTimezone"
}
}
}
}
}GET /api/v1/teams/{team_id}/event-types/{event_type_id}/invitation-schedule/
Operace: get_event_type_invitation_schedule
{
"operationId": "get_event_type_invitation_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_type_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/event-types/{event_type_id}/invitation-schedule/
Operace: put_event_type_invitation_schedule
{
"operationId": "put_event_type_invitation_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_type_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/invitation-schedule/
Operace: get_event_invitation_schedule
{
"operationId": "get_event_invitation_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/events/{event_id}/invitation-schedule/
Operace: put_event_invitation_schedule
{
"operationId": "put_event_invitation_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/logo/
Operace: organization_logo_get
{
"operationId": "organization_logo_get",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/logo/
Operace: organization_logo_put
{
"operationId": "organization_logo_put",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilePhoto"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/logo/
Operace: organization_logo_delete
{
"operationId": "organization_logo_delete",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/squads/{squad_id}/logo/
Operace: squad_logo_get
{
"operationId": "squad_logo_get",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/squads/{squad_id}/logo/
Operace: squad_logo_put
{
"operationId": "squad_logo_put",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilePhoto"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/squads/{squad_id}/logo/
Operace: squad_logo_delete
{
"operationId": "squad_logo_delete",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/squads/
Operace: squads
{
"operationId": "squads",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/squads/
Operace: create_squad
{
"operationId": "create_squad",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SquadInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/squads/{squad_id}/
Operace: update_squad
{
"operationId": "update_squad",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SquadUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/squads/{squad_id}/
Operace: delete_squad
{
"operationId": "delete_squad",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SquadDelete"
}
}
}
}
}PUT /api/v1/teams/{team_id}/squads/{squad_id}/members/
Operace: update_squad_members
{
"operationId": "update_squad_members",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "squad_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SquadMembersUpdate"
}
}
}
}
}PUT /api/v1/teams/{team_id}/resource-access/{resource_area}/{resource_id}/
Operace: resource_assignment
{
"operationId": "resource_assignment",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "resource_area",
"required": true,
"schema": {
"type": "string",
"enum": [
"plans",
"library",
"templates",
"files"
]
}
},
{
"in": "path",
"name": "resource_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResourceAssignment"
}
}
}
}
}GET /api/v1/auth/google/config/
Operace: google_config
{
"operationId": "google_config",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/auth/google/start/
Operace: google_start
{
"operationId": "google_start",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GoogleStart"
}
}
}
}
}POST /api/v1/me/google/start/
Operace: account_google_start
{
"operationId": "account_google_start",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GoogleStart"
}
}
}
}
}POST /api/v1/auth/google/finish/
Operace: google_finish
{
"operationId": "google_finish",
"security": [],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GoogleFinish"
}
}
}
}
}POST /api/v1/me/google/finish/
Operace: account_google_finish
{
"operationId": "account_google_finish",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GoogleFinish"
}
}
}
}
}GET /api/v1/public/site/
Operace: public_site
{
"operationId": "public_site",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicSiteContent"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/public/site/{language}/
Operace: public_site_language
{
"operationId": "public_site_language",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicSiteContent"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "language",
"required": true,
"schema": {
"type": "string",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
]
}
}
]
}GET /api/v1/teams/{team_id}/overview/
Operace: overview
{
"operationId": "overview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OverviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/me/notifications/
Operace: notification_preferences
{
"operationId": "notification_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preferences"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/me/notifications/
Operace: set_notification_preferences
{
"operationId": "set_notification_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preferences"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Preferences"
}
}
}
}
}GET /api/v1/teams/{team_id}/notifications/preferences/
Operace: context_notification_preferences
{
"operationId": "context_notification_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContextPreferences"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/me/push-devices/
Operace: register_push_device
{
"operationId": "register_push_device",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Device"
}
}
}
}
}DELETE /api/v1/me/push-devices/{device_id}/
Operace: unregister_push_device
{
"operationId": "unregister_push_device",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "device_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/notifications/
Operace: notification_settings
{
"operationId": "notification_settings",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SettingsOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/notifications/
Operace: set_notification_settings
{
"operationId": "set_notification_settings",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SettingsOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamSettings"
}
}
}
}
}POST /api/v1/teams/{team_id}/notification-templates/
Operace: create_notification_template
{
"operationId": "create_notification_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Template"
}
}
}
}
}PUT /api/v1/teams/{team_id}/notification-templates/{template_id}/
Operace: update_notification_template
{
"operationId": "update_notification_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/notification-templates/{template_id}/
Operace: delete_notification_template
{
"operationId": "delete_notification_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/events/{event_id}/notifications/
Operace: event_notification_options
{
"operationId": "event_notification_options",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OptionsOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/notifications/
Operace: send_event_notifications
{
"operationId": "send_event_notifications",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BatchOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Send"
}
}
}
}
}GET /api/v1/teams/{team_id}/messages/
Operace: team_messages
{
"operationId": "team_messages",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/messages/
Operace: send_team_message
{
"operationId": "send_team_message",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageResult"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageSend"
}
}
}
}
}GET /api/v1/teams/{team_id}/messages/inbox/
Operace: team_message_inbox
{
"operationId": "team_message_inbox",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/messages/sent/
Operace: team_message_sent
{
"operationId": "team_message_sent",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/messages/recipients/
Operace: message_recipients
{
"operationId": "message_recipients",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/messages/{message_id}/
Operace: team_message
{
"operationId": "team_message",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}DELETE /api/v1/teams/{team_id}/messages/{message_id}/inbox/
Operace: delete_team_message_inbox
{
"operationId": "delete_team_message_inbox",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}DELETE /api/v1/teams/{team_id}/messages/{message_id}/sent/
Operace: delete_team_message_sent
{
"operationId": "delete_team_message_sent",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "message_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/messages/
Operace: send_event_message
{
"operationId": "send_event_message",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageResult"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MessageSend"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/invitation/
Operace: own_event_invitation
{
"operationId": "own_event_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/invitation/
Operace: respond_own_event_invitation
{
"operationId": "respond_own_event_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventResponse"
}
}
}
}
}PUT /api/v1/me/photo/
Operace: account_photo_put
{
"operationId": "account_photo_put",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProfilePhoto"
}
},
"image/jpeg": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
}
}GET /api/v1/me/photo/
Operace: account_photo_get
{
"operationId": "account_photo_get",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}DELETE /api/v1/me/photo/
Operace: account_photo_delete
{
"operationId": "account_photo_delete",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PATCH /api/v1/me/profile/
Operace: account_profile
{
"operationId": "account_profile",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PersonalProfile"
}
}
}
}
}POST /api/v1/me/password/
Operace: account_password_change
{
"operationId": "account_password_change",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordChange"
}
}
}
}
}POST /api/v1/me/password/setup/
Operace: account_password_setup_request
{
"operationId": "account_password_setup_request",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/me/email/
Operace: account_email_request
{
"operationId": "account_email_request",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailChange"
}
}
}
}
}POST /api/v1/auth/confirm-email-change/
Operace: account_email_confirm
{
"operationId": "account_email_confirm",
"security": [],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyEmail"
}
}
}
}
}POST /api/v1/auth/confirm-team-member-email-change/
Operace: confirm_member_email_change
{
"operationId": "confirm_member_email_change",
"security": [],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyEmail"
}
}
}
}
}POST /api/v1/auth/reset-password/
Operace: account_reset_request
{
"operationId": "account_reset_request",
"security": [],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerificationRequest"
}
}
}
}
}POST /api/v1/auth/confirm-password-reset/
Operace: account_reset_confirm
{
"operationId": "account_reset_confirm",
"security": [],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PasswordReset"
}
}
}
}
}GET /api/v1/me/sessions/
Operace: account_sessions
{
"operationId": "account_sessions",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSessions"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/me/teams/
Operace: account_teams
{
"operationId": "account_teams",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountTeams"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/me/teams/{team_id}/visit/
Operace: account_team_visit
{
"operationId": "account_team_visit",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}DELETE /api/v1/me/
Operace: account_delete
{
"operationId": "account_delete",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountDelete"
}
}
}
}
}GET /api/v1/me/
Operace: me
{
"operationId": "me",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/teams/{team_id}/transfer-ownership/
Operace: account_transfer_ownership
{
"operationId": "account_transfer_ownership",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OwnershipTransfer"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/
Operace: account_delete_team
{
"operationId": "account_delete_team",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamDelete"
}
}
}
}
}GET /api/v1/teams/{team_id}/
Operace: team
{
"operationId": "team",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/me/sessions/revoke-others/
Operace: account_sessions_revoke
{
"operationId": "account_sessions_revoke",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/teams/{team_id}/integrations/planning-center/people/preview/
Operace: pc_roster_preview
{
"operationId": "pc_roster_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RosterResult"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roster"
}
}
}
}
}POST /api/v1/teams/{team_id}/integrations/planning-center/people/import/
Operace: pc_roster_import
{
"operationId": "pc_roster_import",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RosterResult"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Roster"
}
}
}
}
}GET /api/v1/teams/{team_id}/integrations/planning-center/people/
Operace: pc_roster_people
{
"operationId": "pc_roster_people",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RosterList"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/integrations/planning-center/history/
Operace: pc_import_history
{
"operationId": "pc_import_history",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/History"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/imports/planning-center/preview/
Operace: pc_preview
{
"operationId": "pc_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResult"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}POST /api/v1/teams/{team_id}/imports/planning-center/
Operace: pc_import
{
"operationId": "pc_import",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResult"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Bundle"
}
}
}
}
}POST /api/v1/teams/{team_id}/imports/songs/preview/
Operace: song_auto_preview
{
"operationId": "song_auto_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProPresenterPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenSongPreviewInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/imports/opensong/preview/
Operace: opensong_preview
{
"operationId": "opensong_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProPresenterPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenSongPreviewInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/imports/songs/batch/
Operace: song_batch_import
{
"operationId": "song_batch_import",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SongBatchImportOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SongBatchImportInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/imports/propresenter/preview/
Operace: propresenter_preview
{
"operationId": "propresenter_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProPresenterPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProPresenterPreviewInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/imports/propresenter/
Operace: propresenter_import
{
"operationId": "propresenter_import",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProPresenterImportOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProPresenterImportInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/source/
Operace: pc_source
{
"operationId": "pc_source",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/assignment/
Operace: pc_file_assignment
{
"operationId": "pc_file_assignment",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileAssignmentOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileAssignment"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/
Operace: pc_file_delete
{
"operationId": "pc_file_delete",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/chunks/
Operace: pc_file_chunk
{
"operationId": "pc_file_chunk",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Chunk"
}
}
}
}
}POST /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/complete/
Operace: pc_file_complete
{
"operationId": "pc_file_complete",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/reset/
Operace: pc_file_reset
{
"operationId": "pc_file_reset",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/content/
Operace: pc_file_content
{
"operationId": "pc_file_content",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChunkOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/raw/
Operace: pc_file_raw
{
"operationId": "pc_file_raw",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Accept-Ranges": {
"schema": {
"type": "string",
"const": "bytes"
}
},
"ETag": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "header",
"name": "Range",
"required": false,
"schema": {
"type": "string",
"pattern": "^bytes=\\d*-\\d*$"
}
},
{
"in": "header",
"name": "If-None-Match",
"required": false,
"schema": {
"type": "string"
}
}
]
}POST /api/v1/auth/register/
Operace: register
{
"operationId": "register",
"security": [],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Register"
}
}
}
}
}POST /api/v1/auth/verify-email/
Operace: verify_email
{
"operationId": "verify_email",
"security": [],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyEmail"
}
}
}
}
}POST /api/v1/auth/resend-verification/
Operace: resend_verification
{
"operationId": "resend_verification",
"security": [],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerificationRequest"
}
}
}
}
}POST /api/v1/auth/login/
Operace: login
{
"operationId": "login",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Login"
}
}
}
}
}POST /api/v1/auth/refresh/
Operace: refresh_session
{
"operationId": "refresh_session",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TokenOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshSession"
}
}
}
}
}POST /api/v1/auth/browser-login/
Operace: browser_login
{
"operationId": "browser_login",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrowserSessionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Login"
}
}
}
}
}POST /api/v1/auth/logout/
Operace: logout
{
"operationId": "logout",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}PATCH /api/v1/me/appearance/
Operace: update_user_appearance
{
"operationId": "update_user_appearance",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserAppearance"
}
}
}
}
}PATCH /api/v1/me/preferences/
Operace: update_user_preferences
{
"operationId": "update_user_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPreferences"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/preferences/
Operace: update_team_preferences
{
"operationId": "update_team_preferences",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamPreferences"
}
}
}
}
}GET /api/v1/teams/
Operace: teams
{
"operationId": "teams",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/
Operace: create_team
{
"operationId": "create_team",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewTeam"
}
}
}
}
}GET /api/v1/teams/{team_id}/members/
Operace: members
{
"operationId": "members",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MemberOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/members/{member_id}/photo/
Operace: member_photo
{
"operationId": "member_photo",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"image/png": {
"schema": {
"type": "string",
"format": "binary"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /api/v1/teams/{team_id}/members/{member_id}/
Operace: change_member
{
"operationId": "change_member",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberChange"
}
}
}
}
}GET /api/v1/teams/{team_id}/members/{member_id}/profile/
Operace: member_profile
{
"operationId": "member_profile",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberProfileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/members/{member_id}/profile/
Operace: update_member_profile
{
"operationId": "update_member_profile",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberProfileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberProfileInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/members/{member_id}/account/
Operace: member_account
{
"operationId": "member_account",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberAccountOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /api/v1/teams/{team_id}/members/{member_id}/account/
Operace: update_member_account
{
"operationId": "update_member_account",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberAccountOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberAccountUpdate"
}
}
}
}
}POST /api/v1/teams/{team_id}/members/{member_id}/password/
Operace: change_member_password
{
"operationId": "change_member_password",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberPasswordUpdate"
}
}
}
}
}POST /api/v1/teams/{team_id}/members/{member_id}/email/
Operace: change_member_email_request
{
"operationId": "change_member_email_request",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"202": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberEmailChange"
}
}
}
}
}GET /api/v1/teams/{team_id}/members/{member_id}/sessions/
Operace: member_account_sessions
{
"operationId": "member_account_sessions",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSessions"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/members/{member_id}/revoke-sessions/
Operace: member_account_sessions_revoke
{
"operationId": "member_account_sessions_revoke",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "member_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}GET /api/v1/teams/{team_id}/sections/
Operace: sections
{
"operationId": "sections",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SectionOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/sections/
Operace: create_section
{
"operationId": "create_section",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/sections/{section_id}/
Operace: rename_section
{
"operationId": "rename_section",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionInput"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/sections/{section_id}/
Operace: delete_section
{
"operationId": "delete_section",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/sections/{section_id}/positions/
Operace: section_positions
{
"operationId": "section_positions",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SectionPositionOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/sections/{section_id}/positions/
Operace: create_section_position
{
"operationId": "create_section_position",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionPositionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamedInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/sections/{section_id}/positions/{position_id}/
Operace: rename_section_position
{
"operationId": "rename_section_position",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionPositionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "position_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamedInput"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/sections/{section_id}/positions/{position_id}/
Operace: delete_section_position
{
"operationId": "delete_section_position",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "position_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/sections/{section_id}/roster/
Operace: section_roster
{
"operationId": "section_roster",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SectionRosterOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/sections/{section_id}/assignments/move/
Operace: move_section_assignment
{
"operationId": "move_section_assignment",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionMoveInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/sections/{section_id}/assignments/bulk/
Operace: set_section_assignments
{
"operationId": "set_section_assignments",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPeopleInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/sections/{section_id}/assignments/
Operace: add_section_assignments
{
"operationId": "add_section_assignments",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionAssignmentInput"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/sections/{section_id}/assignments/
Operace: remove_section_assignments
{
"operationId": "remove_section_assignments",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "section_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SectionAssignmentInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/roles/
Operace: team_roles
{
"operationId": "team_roles",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRolesOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/roles/
Operace: create_team_role
{
"operationId": "create_team_role",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRoleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRoleInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/roles/{role_id}/
Operace: update_team_role
{
"operationId": "update_team_role",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRoleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "role_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRoleUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/roles/{role_id}/
Operace: delete_team_role
{
"operationId": "delete_team_role",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "role_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRoleDelete"
}
}
}
}
}GET /api/v1/teams/{team_id}/invitations/
Operace: invitations
{
"operationId": "invitations",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SentInvitationOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/invitations/
Operace: invite
{
"operationId": "invite",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invite"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/invitations/{invitation_id}/
Operace: revoke_invitation
{
"operationId": "revoke_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "invitation_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}DELETE /api/v1/teams/{team_id}/invitations/{invitation_id}/record/
Operace: delete_invitation
{
"operationId": "delete_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "invitation_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/me/invitations/
Operace: received_invitations
{
"operationId": "received_invitations",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReceivedInvitationOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/me/invitations/{invitation_id}/accept/
Operace: accept_received_invitation
{
"operationId": "accept_received_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "invitation_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/me/invitations/{invitation_id}/decline/
Operace: decline_received_invitation
{
"operationId": "decline_received_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "invitation_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/invitations/accept/
Operace: accept
{
"operationId": "accept",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accept"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/
Operace: materials
{
"operationId": "materials",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/materials/
Operace: create_material
{
"operationId": "create_material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/picker/
Operace: material_picker
{
"operationId": "material_picker",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaterialPickerOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/materials/delete/
Operace: delete_materials
{
"operationId": "delete_materials",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialsDelete"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/
Operace: material
{
"operationId": "material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}DELETE /api/v1/teams/{team_id}/materials/{material_id}/
Operace: delete_material
{
"operationId": "delete_material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialDelete"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/materials/{material_id}/
Operace: update_material
{
"operationId": "update_material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialUpdate"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/preview/
Operace: material_preview
{
"operationId": "material_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/preview/
Operace: material_variant_preview
{
"operationId": "material_variant_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/preview-preference/
Operace: material_preview_preference
{
"operationId": "material_preview_preference",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialPreviewPreferenceOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/materials/{material_id}/preview-preference/
Operace: save_material_preview_preference
{
"operationId": "save_material_preview_preference",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialPreviewPreferenceOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanPreviewPreferenceInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/materials/{material_id}/pdf-layout/
Operace: update_material_pdf_layout
{
"operationId": "update_material_pdf_layout",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfLayout"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/schedule/
Operace: material_schedule
{
"operationId": "material_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaterialScheduleOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/materials/{material_id}/archive/
Operace: archive_material
{
"operationId": "archive_material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/teams/{team_id}/materials/{material_id}/restore/
Operace: restore_material
{
"operationId": "restore_material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/planned/
Operace: planned_material
{
"operationId": "planned_material",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlannedUsageOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/variants/
Operace: variants
{
"operationId": "variants",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/materials/{material_id}/variants/
Operace: create_variant
{
"operationId": "create_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantCreateInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/
Operace: variant
{
"operationId": "variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}DELETE /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/
Operace: delete_variant
{
"operationId": "delete_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantDelete"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/
Operace: update_variant
{
"operationId": "update_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantUpdate"
}
}
}
}
}POST /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/archive/
Operace: archive_variant
{
"operationId": "archive_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/restore/
Operace: restore_variant
{
"operationId": "restore_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}POST /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/default/
Operace: set_default_variant
{
"operationId": "set_default_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VariantDefaultInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/variants/{variant_id}/planned/
Operace: planned_variant
{
"operationId": "planned_variant",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlannedUsageOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "variant_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/events/
Operace: events
{
"operationId": "events",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/events/
Operace: create_event
{
"operationId": "create_event",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/history/
Operace: event_history
{
"operationId": "event_history",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/event-types/
Operace: event_types
{
"operationId": "event_types",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventTypeOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/event-types/
Operace: create_event_type
{
"operationId": "create_event_type",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/event-types/{event_type_id}/
Operace: rename_event_type
{
"operationId": "rename_event_type",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_type_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventTypeInput"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/event-types/{event_type_id}/
Operace: archive_event_type
{
"operationId": "archive_event_type",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_type_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/templates/{template_id}/invitation-schedule/
Operace: get_event_template_invitation_schedule
{
"operationId": "get_event_template_invitation_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/templates/{template_id}/invitation-schedule/
Operace: put_event_template_invitation_schedule
{
"operationId": "put_event_template_invitation_schedule",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/template-choices/
Operace: template_choices
{
"operationId": "template_choices",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/templates/
Operace: templates
{
"operationId": "templates",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/templates/
Operace: create_blank_template
{
"operationId": "create_blank_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/templates/{template_id}/
Operace: template
{
"operationId": "template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /api/v1/teams/{team_id}/templates/{template_id}/
Operace: update_template
{
"operationId": "update_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateInput"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/templates/{template_id}/
Operace: archive_template
{
"operationId": "archive_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/templates/{template_id}/people/
Operace: template_people
{
"operationId": "template_people",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TemplatePersonOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/templates/{template_id}/people/
Operace: add_template_person
{
"operationId": "add_template_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePersonOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/templates/{template_id}/people/bulk/
Operace: add_template_people
{
"operationId": "add_template_people",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPeopleInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/templates/{template_id}/people/{person_id}/
Operace: change_template_person
{
"operationId": "change_template_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplatePersonOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "person_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/templates/{template_id}/people/{person_id}/
Operace: remove_template_person
{
"operationId": "remove_template_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "person_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/templates/{template_id}/items/
Operace: template_items
{
"operationId": "template_items",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/templates/{template_id}/items/
Operace: add_template_item
{
"operationId": "add_template_item",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanItemInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/templates/{template_id}/items/bulk/
Operace: add_template_songs_bulk
{
"operationId": "add_template_songs_bulk",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkSongsOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkSongsInput"
}
}
}
}
}PUT /api/v1/teams/{team_id}/templates/{template_id}/items/order/
Operace: reorder_template_items
{
"operationId": "reorder_template_items",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOrder"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/templates/{template_id}/items/{item_id}/
Operace: remove_template_item
{
"operationId": "remove_template_item",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /api/v1/teams/{team_id}/templates/{template_id}/items/{item_id}/
Operace: update_template_item
{
"operationId": "update_template_item",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanItemUpdate"
}
}
}
}
}POST /api/v1/teams/{team_id}/events/delete/
Operace: delete_events
{
"operationId": "delete_events",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventsDelete"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/events/{event_id}/
Operace: delete_event
{
"operationId": "delete_event",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventDelete"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/
Operace: event
{
"operationId": "event",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /api/v1/teams/{team_id}/events/{event_id}/
Operace: update_event
{
"operationId": "update_event",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventUpdate"
}
}
}
}
}POST /api/v1/teams/{team_id}/events/{event_id}/recurrence/
Operace: start_event_recurrence
{
"operationId": "start_event_recurrence",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventRecurrenceInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/people/
Operace: event_people
{
"operationId": "event_people",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventPersonOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/people/
Operace: invite_event_person
{
"operationId": "invite_event_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/events/{event_id}/people/bulk/
Operace: invite_event_people
{
"operationId": "invite_event_people",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPeopleInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/events/{event_id}/people/{person_id}/
Operace: change_event_person
{
"operationId": "change_event_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "person_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/events/{event_id}/people/{person_id}/
Operace: remove_event_person
{
"operationId": "remove_event_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "person_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/people/{person_id}/response/
Operace: respond_event_person
{
"operationId": "respond_event_person",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPersonOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "person_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventResponse"
}
}
}
}
}POST /api/v1/teams/{team_id}/events/{event_id}/template/
Operace: create_template
{
"operationId": "create_template",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TemplateInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/events/{event_id}/publish/
Operace: publish
{
"operationId": "publish",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"deprecated": true,
"description": "Compatibility only; events are immediately available according to access rules. Does not send invitations.",
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/items/
Operace: items
{
"operationId": "items",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/items/
Operace: add_item
{
"operationId": "add_item",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanItemInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/preview/
Operace: plan_item_preview
{
"operationId": "plan_item_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/annotations/
Operace: plan_item_annotations
{
"operationId": "plan_item_annotations",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AnnotationOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/annotations/
Operace: add_plan_item_annotation
{
"operationId": "add_plan_item_annotation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/annotations/{annotation_id}/
Operace: set_plan_item_annotation_visibility
{
"operationId": "set_plan_item_annotation_visibility",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "annotation_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AnnotationVisibility"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/annotations/{annotation_id}/
Operace: delete_plan_item_annotation
{
"operationId": "delete_plan_item_annotation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "annotation_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/preview/preference/
Operace: save_plan_item_preview_preference
{
"operationId": "save_plan_item_preview_preference",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanPreviewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanPreviewPreferenceInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/preview/files/{file_id}/content/
Operace: plan_item_preview_file_content
{
"operationId": "plan_item_preview_file_content",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChunkOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/preview/files/{file_id}/raw/
Operace: plan_item_preview_file_raw
{
"operationId": "plan_item_preview_file_raw",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Accept-Ranges": {
"schema": {
"type": "string",
"const": "bytes"
}
},
"ETag": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "header",
"name": "Range",
"required": false,
"schema": {
"type": "string",
"pattern": "^bytes=\\d*-\\d*$"
}
},
{
"in": "header",
"name": "If-None-Match",
"required": false,
"schema": {
"type": "string"
}
}
]
}POST /api/v1/teams/{team_id}/events/{event_id}/items/bulk/
Operace: add_songs_bulk
{
"operationId": "add_songs_bulk",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkSongsOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BulkSongsInput"
}
}
}
}
}PUT /api/v1/teams/{team_id}/events/{event_id}/items/order/
Operace: reorder_items
{
"operationId": "reorder_items",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOrder"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/duration/
Operace: update_item_duration
{
"operationId": "update_item_duration",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemDurationInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/templates/{template_id}/items/{item_id}/duration/
Operace: update_template_item_duration
{
"operationId": "update_template_item_duration",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemDurationInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/
Operace: update_item
{
"operationId": "update_item",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanItemUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/
Operace: remove_item
{
"operationId": "remove_item",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/note/view/
Operace: get_event_note_view
{
"operationId": "get_event_note_view",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteViewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/note/view/
Operace: save_event_note_view
{
"operationId": "save_event_note_view",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteViewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteViewInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/templates/{template_id}/items/{item_id}/note/view/
Operace: get_template_note_view
{
"operationId": "get_template_note_view",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteViewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/templates/{template_id}/items/{item_id}/note/view/
Operace: save_template_note_view
{
"operationId": "save_template_note_view",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteViewOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteViewInput"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/events/{event_id}/items/{item_id}/note/
Operace: update_note
{
"operationId": "update_note",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteUpdate"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/templates/{template_id}/items/{item_id}/note/
Operace: update_template_note
{
"operationId": "update_template_note",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "template_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "item_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NoteUpdate"
}
}
}
}
}GET /api/v1/teams/{team_id}/subscription/
Operace: subscription
{
"operationId": "subscription",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/subscription/checkout/
Operace: subscription_checkout
{
"operationId": "subscription_checkout",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckoutSessionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckoutInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/subscription/change/
Operace: subscription_change
{
"operationId": "subscription_change",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanChangeOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanChangeInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/subscription/change/preview/
Operace: subscription_change_preview
{
"operationId": "subscription_change_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanChangePreview"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanTargetInput"
}
}
}
}
}POST /api/v1/teams/{team_id}/subscription/portal/
Operace: subscription_portal
{
"operationId": "subscription_portal",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CheckoutSessionOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Empty"
}
}
}
}
}GET /api/v1/catalog/
Operace: catalog
{
"operationId": "catalog",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ProductOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/imports/file-song/preview/
Operace: preview_file_song
{
"operationId": "preview_file_song",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileSongDraft"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileSongPreview"
}
}
}
}
}GET /api/v1/teams/{team_id}/files/
Operace: global_files
{
"operationId": "global_files",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalFileOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/files/
Operace: create_global_file
{
"operationId": "create_global_file",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileCreate"
}
}
}
}
}PATCH /api/v1/teams/{team_id}/files/{file_id}/
Operace: update_global_file
{
"operationId": "update_global_file",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/files/{file_id}/
Operace: delete_global_file
{
"operationId": "delete_global_file",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/files/{file_id}/chunks/
Operace: global_file_chunk
{
"operationId": "global_file_chunk",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileChunk"
}
}
}
}
}POST /api/v1/teams/{team_id}/files/{file_id}/complete/
Operace: complete_global_file
{
"operationId": "complete_global_file",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileComplete"
}
}
}
}
}POST /api/v1/teams/{team_id}/files/{file_id}/thumbnail/
Operace: regenerate_global_file_thumbnail
{
"operationId": "regenerate_global_file_thumbnail",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFileThumbnail"
}
}
}
}
}GET /api/v1/teams/{team_id}/files/{file_id}/content/
Operace: global_file_content
{
"operationId": "global_file_content",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChunkOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/files/{file_id}/raw/
Operace: global_file_raw
{
"operationId": "global_file_raw",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Accept-Ranges": {
"schema": {
"type": "string",
"const": "bytes"
}
},
"ETag": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "header",
"name": "Range",
"required": false,
"schema": {
"type": "string",
"pattern": "^bytes=\\d*-\\d*$"
}
},
{
"in": "header",
"name": "If-None-Match",
"required": false,
"schema": {
"type": "string"
}
}
]
}GET /api/v1/teams/{team_id}/files/{file_id}/thumbnail/content/
Operace: global_file_thumbnail_content
{
"operationId": "global_file_thumbnail_content",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Accept-Ranges": {
"schema": {
"type": "string",
"const": "bytes"
}
},
"ETag": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "header",
"name": "Range",
"required": false,
"schema": {
"type": "string",
"pattern": "^bytes=\\d*-\\d*$"
}
},
{
"in": "header",
"name": "If-None-Match",
"required": false,
"schema": {
"type": "string"
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/media/
Operace: material_media
{
"operationId": "material_media",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MaterialMediaOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}POST /api/v1/teams/{team_id}/materials/{material_id}/media/
Operace: save_material_media
{
"operationId": "save_material_media",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialMediaOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialMediaInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/media/{link_id}/preview/
Operace: material_media_preview
{
"operationId": "material_media_preview",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PdfExcerptOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/media/{link_id}/preview/content/
Operace: material_media_preview_content
{
"operationId": "material_media_preview_content",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChunkOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/materials/{material_id}/media/{link_id}/preview/raw/
Operace: material_media_preview_raw
{
"operationId": "material_media_preview_raw",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"headers": {
"Accept-Ranges": {
"schema": {
"type": "string",
"const": "bytes"
}
},
"ETag": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "header",
"name": "Range",
"required": false,
"schema": {
"type": "string",
"pattern": "^bytes=\\d*-\\d*$"
}
},
{
"in": "header",
"name": "If-None-Match",
"required": false,
"schema": {
"type": "string"
}
}
]
}PATCH /api/v1/teams/{team_id}/materials/{material_id}/media/{link_id}/
Operace: update_material_media
{
"operationId": "update_material_media",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MaterialMediaOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaLinkUpdate"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/materials/{material_id}/media/{link_id}/
Operace: delete_material_media
{
"operationId": "delete_material_media",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PATCH /api/v1/teams/{team_id}/materials/{material_id}/files/{file_id}/details/
Operace: update_attachment_details
{
"operationId": "update_attachment_details",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "file_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentDetails"
}
}
}
}
}GET /api/v1/teams/{team_id}/materials/{material_id}/global-pages/
Operace: global_file_pages
{
"operationId": "global_file_pages",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalFilePageOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}PUT /api/v1/teams/{team_id}/materials/{material_id}/global-pages/
Operace: replace_global_file_pages
{
"operationId": "replace_global_file_pages",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GlobalFilePageOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "material_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GlobalFilePagesInput"
}
}
}
}
}GET /api/v1/teams/{team_id}/licenses/
Operace: licenses
{
"operationId": "licenses",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"count",
"next",
"previous",
"results"
],
"properties": {
"count": {
"type": "integer",
"minimum": 0
},
"next": {
"type": [
"string",
"null"
]
},
"previous": {
"type": [
"string",
"null"
]
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LicenseOutput"
}
}
}
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"minimum": 1,
"maximum": 1000000,
"default": 1
}
}
]
}GET /api/v1/teams/{team_id}/licenses/{license_id}/content/
Operace: licensed_content
{
"operationId": "licensed_content",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicensedContentOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "license_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/invitations/preview/
Operace: preview_invitation
{
"operationId": "preview_invitation",
"security": [],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationPreview"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accept"
}
}
}
}
}POST /api/v1/invitations/register/
Operace: register_invitation
{
"operationId": "register_invitation",
"security": [],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvitationRegistration"
}
}
}
}
}POST /api/v1/invitations/decline/
Operace: decline_invitation
{
"operationId": "decline_invitation",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Accept"
}
}
}
}
}POST /api/v1/teams/{team_id}/playback/titles/read/
Operace: playback_titles
{
"operationId": "playback_titles",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackTitleCacheOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackTitleQuery"
}
}
}
}
}PUT /api/v1/teams/{team_id}/playback/titles/
Operace: cache_playback_titles
{
"operationId": "cache_playback_titles",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackTitleCacheOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackTitleCacheWrite"
}
}
}
}
}GET /api/v1/teams/{team_id}/playback/
Operace: playback_integration
{
"operationId": "playback_integration",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackIntegrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/playback/
Operace: set_playback_config
{
"operationId": "set_playback_config",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackIntegrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackConfig"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/playback/
Operace: delete_playback_integration
{
"operationId": "delete_playback_integration",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}POST /api/v1/teams/{team_id}/playback/pairing/
Operace: report_playback_pairing
{
"operationId": "report_playback_pairing",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackIntegrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackPairing"
}
}
}
}
}POST /api/v1/teams/{team_id}/playback/sessions/
Operace: start_playback_session
{
"operationId": "start_playback_session",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackSessionStartOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackSessionStart"
}
}
}
}
}POST /api/v1/teams/{team_id}/playback/sessions/{session_id}/report/
Operace: report_playback
{
"operationId": "report_playback",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackReportOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "session_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackReport"
}
}
}
}
}POST /api/v1/teams/{team_id}/playback/sessions/{session_id}/end/
Operace: end_playback_session
{
"operationId": "end_playback_session",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackIntegrationOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "session_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackSessionEnd"
}
}
}
}
}GET /api/v1/teams/{team_id}/playback/links/
Operace: playback_links
{
"operationId": "playback_links",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackLinkList"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/playback/links/
Operace: save_playback_link
{
"operationId": "save_playback_link",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackLinkOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackLink"
}
}
}
}
}DELETE /api/v1/teams/{team_id}/playback/links/{link_id}/
Operace: delete_playback_link
{
"operationId": "delete_playback_link",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"204": {
"description": "Success"
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "link_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/events/{event_id}/playback/
Operace: event_playback
{
"operationId": "event_playback",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPlaybackOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}GET /api/v1/teams/{team_id}/events/{event_id}/playback/stream/
Operace: playback_stream
{
"operationId": "playback_stream",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"text/event-stream": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
]
}PUT /api/v1/teams/{team_id}/events/{event_id}/playback/matches/
Operace: set_playback_match
{
"operationId": "set_playback_match",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPlaybackOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackMatch"
}
}
}
}
}POST /api/v1/teams/{team_id}/events/{event_id}/playback/reconcile/
Operace: reconcile_playback
{
"operationId": "reconcile_playback",
"security": [
{
"bearerSession": []
},
{
"browserSession": []
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackReconcileOutput"
}
}
}
},
"400": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"401": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"403": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"404": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"409": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"413": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"415": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"429": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"503": {
"description": "Request rejected",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
},
"parameters": [
{
"in": "path",
"name": "team_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"in": "path",
"name": "event_id",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlaybackReconcile"
}
}
}
}
}Datové modely
Názvy polí a typy odpovídají kódu a souboru OpenAPI. Definice určují povinná pole, povolené hodnoty a formáty.
Error
{
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"detail": {
"title": "Detail",
"type": "string"
}
},
"required": [
"code",
"detail"
],
"title": "Error",
"type": "object"
}SocialRegistration
{
"additionalProperties": false,
"properties": {
"confirmation_token": {
"maxLength": 128,
"minLength": 32,
"title": "Confirmation Token",
"type": "string"
},
"confirmed": {
"const": true,
"title": "Confirmed",
"type": "boolean"
},
"display_name": {
"maxLength": 120,
"minLength": 1,
"title": "Display Name",
"type": "string"
}
},
"required": [
"confirmation_token",
"confirmed",
"display_name"
],
"title": "SocialRegistration",
"type": "object"
}SocialConfirmation
{
"additionalProperties": false,
"properties": {
"confirmation_token": {
"maxLength": 128,
"minLength": 32,
"title": "Confirmation Token",
"type": "string"
},
"confirmed": {
"const": true,
"title": "Confirmed",
"type": "boolean"
}
},
"required": [
"confirmation_token",
"confirmed"
],
"title": "SocialConfirmation",
"type": "object"
}OfflineBundleInput
{
"additionalProperties": false,
"properties": {
"plans": {
"default": true,
"title": "Plans",
"type": "boolean"
},
"people": {
"default": true,
"title": "People",
"type": "boolean"
},
"library": {
"default": true,
"title": "Library",
"type": "boolean"
},
"files": {
"default": false,
"title": "Files",
"type": "boolean"
},
"known": {
"additionalProperties": {
"pattern": "^[0-9a-f]{64}$",
"type": "string"
},
"maxProperties": 4000,
"propertyNames": {
"maxLength": 180
},
"title": "Known",
"type": "object"
}
},
"title": "OfflineBundleInput",
"type": "object"
}AppleStart
{
"additionalProperties": false,
"properties": {
"purpose": {
"default": "login",
"enum": [
"login",
"link",
"delete"
],
"title": "Purpose",
"type": "string"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
}
},
"title": "AppleStart",
"type": "object"
}AppleFinish
{
"additionalProperties": false,
"properties": {
"state": {
"maxLength": 128,
"minLength": 32,
"title": "State",
"type": "string"
},
"identity_token": {
"maxLength": 16384,
"minLength": 32,
"title": "Identity Token",
"type": "string"
},
"authorization_code": {
"maxLength": 2048,
"minLength": 1,
"title": "Authorization Code",
"type": "string"
},
"display_name": {
"default": "",
"maxLength": 120,
"title": "Display Name",
"type": "string"
}
},
"required": [
"state",
"identity_token",
"authorization_code"
],
"title": "AppleFinish",
"type": "object"
}PersonSquadInput
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"title": "Expected Revision",
"type": "integer"
},
"role": {
"enum": [
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
}
},
"required": [
"expected_revision",
"role"
],
"title": "PersonSquadInput",
"type": "object"
}SquadDelete
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "SquadDelete",
"type": "object"
}ContextOption
{
"properties": {
"organization_id": {
"format": "uuid",
"title": "Organization Id",
"type": "string"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"organization_name": {
"title": "Organization Name",
"type": "string"
},
"squad_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Name"
}
},
"required": [
"organization_id",
"organization_name"
],
"title": "ContextOption",
"type": "object"
}UserContext
{
"additionalProperties": false,
"properties": {
"organization_id": {
"format": "uuid",
"title": "Organization Id",
"type": "string"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
}
},
"required": [
"organization_id"
],
"title": "UserContext",
"type": "object"
}ContextPreferencesOutput
{
"properties": {
"default_context": {
"anyOf": [
{
"$ref": "#/components/schemas/UserContext"
},
{
"type": "null"
}
],
"default": null
},
"last_context": {
"anyOf": [
{
"$ref": "#/components/schemas/UserContext"
},
{
"type": "null"
}
],
"default": null
},
"resolved_context": {
"anyOf": [
{
"$ref": "#/components/schemas/UserContext"
},
{
"type": "null"
}
],
"default": null
},
"options": {
"items": {
"$ref": "#/components/schemas/ContextOption"
},
"title": "Options",
"type": "array"
}
},
"required": [
"options"
],
"title": "ContextPreferencesOutput",
"type": "object"
}ContextPreferenceInput
{
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"default",
"last"
],
"title": "Kind",
"type": "string"
},
"context": {
"anyOf": [
{
"$ref": "#/components/schemas/UserContext"
},
{
"type": "null"
}
]
}
},
"required": [
"kind",
"context"
],
"title": "ContextPreferenceInput",
"type": "object"
}TeamOutput
{
"properties": {
"context_role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Context Role"
},
"context_role_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Context Role Name"
},
"has_logo": {
"default": false,
"title": "Has Logo",
"type": "boolean"
},
"logo_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Logo Version"
},
"timezone": {
"default": "UTC",
"title": "Timezone",
"type": "string"
},
"scoped_access": {
"default": false,
"title": "Scoped Access",
"type": "boolean"
},
"resource_creation": {
"additionalProperties": {
"type": "boolean"
},
"default": {},
"title": "Resource Creation",
"type": "object"
},
"date_format": {
"default": "iso",
"enum": [
"iso",
"dmy_dot",
"dmy_slash",
"mdy_slash",
"long",
"language",
"system"
],
"title": "Date Format",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"locale": {
"title": "Locale",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"member_count": {
"title": "Member Count",
"type": "integer"
},
"seat_limit": {
"title": "Seat Limit",
"type": "integer"
},
"plan_code": {
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan Code",
"type": "string"
},
"role": {
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"is_owner": {
"default": false,
"title": "Is Owner",
"type": "boolean"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
},
"role_name": {
"default": "",
"title": "Role Name",
"type": "string"
},
"permissions": {
"additionalProperties": {
"enum": [
"none",
"view",
"edit",
"manage"
],
"type": "string"
},
"default": {},
"title": "Permissions",
"type": "object"
},
"features": {
"additionalProperties": {
"type": "boolean"
},
"default": {},
"title": "Features",
"type": "object"
}
},
"required": [
"id",
"name",
"locale",
"created_at",
"member_count",
"seat_limit",
"plan_code",
"role"
],
"title": "TeamOutput",
"type": "object"
}TeamTimezone
{
"additionalProperties": false,
"properties": {
"timezone": {
"maxLength": 64,
"minLength": 1,
"title": "Timezone",
"type": "string"
}
},
"required": [
"timezone"
],
"title": "TeamTimezone",
"type": "object"
}InvitationRule
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"weekday": {
"default": 1,
"maximum": 6,
"minimum": 0,
"title": "Weekday",
"type": "integer"
},
"days_before": {
"anyOf": [
{
"maximum": 365,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Days Before"
},
"time": {
"pattern": "^([01]\\d|2[0-3]):[0-5]\\d$",
"title": "Time",
"type": "string"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"audience": {
"default": "unanswered",
"enum": [
"unanswered",
"all"
],
"title": "Audience",
"type": "string"
},
"channels": {
"default": [
"email"
],
"items": {
"enum": [
"email",
"push"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Channels",
"type": "array"
},
"template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Template Id"
}
},
"required": [
"id",
"time"
],
"title": "InvitationRule",
"type": "object"
}ScheduleOccurrence
{
"properties": {
"rule_id": {
"format": "uuid",
"title": "Rule Id",
"type": "string"
},
"due_at": {
"format": "date-time",
"title": "Due At",
"type": "string"
}
},
"required": [
"rule_id",
"due_at"
],
"title": "ScheduleOccurrence",
"type": "object"
}TemplateOutput
{
"properties": {
"event_type_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Event Type Id"
},
"duration_minutes": {
"default": 120,
"title": "Duration Minutes",
"type": "integer"
},
"revision": {
"default": 1,
"title": "Revision",
"type": "integer"
},
"is_default": {
"default": false,
"title": "Is Default",
"type": "boolean"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"responsible_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Responsible Member Id"
},
"capabilities": {
"anyOf": [
{
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Capabilities"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
}
},
"required": [
"id",
"name",
"created_at"
],
"title": "TemplateOutput",
"type": "object"
}ScheduleOutput
{
"properties": {
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"inherit": {
"title": "Inherit",
"type": "boolean"
},
"type_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Type Name"
},
"timezone": {
"title": "Timezone",
"type": "string"
},
"rules": {
"items": {
"$ref": "#/components/schemas/InvitationRule"
},
"title": "Rules",
"type": "array"
},
"inherited_rules": {
"items": {
"$ref": "#/components/schemas/InvitationRule"
},
"title": "Inherited Rules",
"type": "array"
},
"templates": {
"items": {
"$ref": "#/components/schemas/TemplateOutput"
},
"title": "Templates",
"type": "array"
},
"occurrences": {
"items": {
"$ref": "#/components/schemas/ScheduleOccurrence"
},
"title": "Occurrences",
"type": "array"
}
},
"required": [
"revision",
"inherit",
"type_name",
"timezone",
"rules",
"inherited_rules",
"templates",
"occurrences"
],
"title": "ScheduleOutput",
"type": "object"
}ScheduleInput
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Enabled"
},
"inherit": {
"default": false,
"title": "Inherit",
"type": "boolean"
},
"rules": {
"default": [],
"items": {
"$ref": "#/components/schemas/InvitationRule"
},
"maxItems": 12,
"title": "Rules",
"type": "array"
}
},
"required": [
"expected_revision"
],
"title": "ScheduleInput",
"type": "object"
}ProfilePhoto
{
"additionalProperties": false,
"properties": {
"content": {
"maxLength": 2800000,
"minLength": 1,
"title": "Content",
"type": "string"
}
},
"required": [
"content"
],
"title": "ProfilePhoto",
"type": "object"
}SquadMemberInput
{
"additionalProperties": false,
"properties": {
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"role": {
"default": "musician",
"enum": [
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
}
},
"required": [
"member_id"
],
"title": "SquadMemberInput",
"type": "object"
}SquadInput
{
"additionalProperties": false,
"properties": {
"share_event_schedule": {
"default": false,
"title": "Share Event Schedule",
"type": "boolean"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"leader_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Leader Member Id"
},
"members": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SquadMemberInput"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Members"
}
},
"required": [
"name"
],
"title": "SquadInput",
"type": "object"
}SquadUpdate
{
"additionalProperties": false,
"properties": {
"share_event_schedule": {
"default": false,
"title": "Share Event Schedule",
"type": "boolean"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"leader_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Leader Member Id"
},
"members": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/SquadMemberInput"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Members"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"archived": {
"default": false,
"title": "Archived",
"type": "boolean"
}
},
"required": [
"name",
"expected_revision"
],
"title": "SquadUpdate",
"type": "object"
}SquadMembersUpdate
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"members": {
"items": {
"$ref": "#/components/schemas/SquadMemberInput"
},
"maxItems": 1000,
"title": "Members",
"type": "array"
}
},
"required": [
"expected_revision",
"members"
],
"title": "SquadMembersUpdate",
"type": "object"
}ResourceAssignment
{
"additionalProperties": false,
"properties": {
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"responsible_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Responsible Member Id"
}
},
"title": "ResourceAssignment",
"type": "object"
}GoogleStart
{
"additionalProperties": false,
"properties": {
"platform": {
"default": "web",
"enum": [
"web",
"ios",
"android"
],
"title": "Platform",
"type": "string"
},
"proof_hash": {
"anyOf": [
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Proof Hash"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
}
},
"title": "GoogleStart",
"type": "object"
}GoogleFinish
{
"additionalProperties": false,
"properties": {
"code": {
"maxLength": 128,
"minLength": 32,
"title": "Code",
"type": "string"
},
"proof": {
"anyOf": [
{
"maxLength": 128,
"minLength": 32,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Proof"
}
},
"required": [
"code"
],
"title": "GoogleFinish",
"type": "object"
}SiteCard
{
"additionalProperties": false,
"properties": {
"title": {
"maxLength": 180,
"minLength": 1,
"title": "Title",
"type": "string"
},
"body": {
"maxLength": 2500,
"title": "Body",
"type": "string"
},
"visible": {
"default": true,
"title": "Visible",
"type": "boolean"
}
},
"required": [
"title",
"body"
],
"title": "SiteCard",
"type": "object"
}SitePlan
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 180,
"minLength": 1,
"title": "Name",
"type": "string"
},
"seats": {
"maxLength": 180,
"minLength": 1,
"title": "Seats",
"type": "string"
},
"price": {
"maximum": 100000,
"minimum": 0,
"title": "Price",
"type": "integer"
},
"description": {
"maxLength": 2500,
"title": "Description",
"type": "string"
},
"visible": {
"default": true,
"title": "Visible",
"type": "boolean"
}
},
"required": [
"name",
"seats",
"price",
"description"
],
"title": "SitePlan",
"type": "object"
}SiteShot
{
"additionalProperties": false,
"properties": {
"asset": {
"enum": [
"web-overview",
"web-program",
"web-viewer",
"ios-stage",
"ios-events"
],
"title": "Asset",
"type": "string"
},
"caption": {
"maxLength": 180,
"minLength": 1,
"title": "Caption",
"type": "string"
},
"visible": {
"default": true,
"title": "Visible",
"type": "boolean"
}
},
"required": [
"asset",
"caption"
],
"title": "SiteShot",
"type": "object"
}PublicSiteContent
{
"additionalProperties": false,
"properties": {
"currency": {
"enum": [
"PLN",
"EUR"
],
"title": "Currency",
"type": "string"
},
"headline": {
"maxLength": 180,
"minLength": 1,
"title": "Headline",
"type": "string"
},
"lead": {
"maxLength": 2500,
"title": "Lead",
"type": "string"
},
"features_title": {
"maxLength": 180,
"minLength": 1,
"title": "Features Title",
"type": "string"
},
"features": {
"items": {
"$ref": "#/components/schemas/SiteCard"
},
"maxItems": 12,
"title": "Features",
"type": "array"
},
"pricing_title": {
"maxLength": 180,
"minLength": 1,
"title": "Pricing Title",
"type": "string"
},
"pricing_note": {
"maxLength": 2500,
"title": "Pricing Note",
"type": "string"
},
"plans": {
"items": {
"$ref": "#/components/schemas/SitePlan"
},
"title": "Plans",
"type": "array"
},
"licenses_title": {
"maxLength": 180,
"minLength": 1,
"title": "Licenses Title",
"type": "string"
},
"licenses": {
"items": {
"$ref": "#/components/schemas/SiteCard"
},
"maxItems": 8,
"title": "Licenses",
"type": "array"
},
"contact_title": {
"title": "Contact Title",
"type": "string"
},
"contact_body": {
"maxLength": 2500,
"title": "Contact Body",
"type": "string"
},
"contact_email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Contact Email"
},
"contact_phone": {
"default": "",
"maxLength": 60,
"title": "Contact Phone",
"type": "string"
},
"contact_address": {
"default": "",
"maxLength": 2500,
"title": "Contact Address",
"type": "string"
},
"screenshots": {
"items": {
"$ref": "#/components/schemas/SiteShot"
},
"maxItems": 8,
"title": "Screenshots",
"type": "array"
},
"show_features": {
"default": true,
"title": "Show Features",
"type": "boolean"
},
"show_pricing": {
"default": true,
"title": "Show Pricing",
"type": "boolean"
},
"show_licenses": {
"default": true,
"title": "Show Licenses",
"type": "boolean"
},
"show_screenshots": {
"default": true,
"title": "Show Screenshots",
"type": "boolean"
},
"show_contact": {
"default": true,
"title": "Show Contact",
"type": "boolean"
},
"language": {
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Language",
"type": "string"
}
},
"required": [
"currency",
"headline",
"lead",
"features_title",
"features",
"pricing_title",
"pricing_note",
"plans",
"licenses_title",
"licenses",
"contact_title",
"contact_body",
"screenshots",
"language"
],
"title": "PublicSiteContent",
"type": "object"
}OverviewSong
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"event_count": {
"default": 0,
"title": "Event Count",
"type": "integer"
}
},
"required": [
"id",
"title",
"created_at"
],
"title": "OverviewSong",
"type": "object"
}OverviewOutput
{
"properties": {
"recent_songs": {
"items": {
"$ref": "#/components/schemas/OverviewSong"
},
"title": "Recent Songs",
"type": "array"
},
"popular_songs": {
"items": {
"$ref": "#/components/schemas/OverviewSong"
},
"title": "Popular Songs",
"type": "array"
}
},
"required": [
"recent_songs",
"popular_songs"
],
"title": "OverviewOutput",
"type": "object"
}Preferences
{
"additionalProperties": false,
"properties": {
"email": {
"title": "Email",
"type": "boolean"
},
"push": {
"title": "Push",
"type": "boolean"
}
},
"required": [
"email",
"push"
],
"title": "Preferences",
"type": "object"
}ContextPreferences
{
"additionalProperties": false,
"properties": {
"email": {
"title": "Email",
"type": "boolean"
},
"push": {
"title": "Push",
"type": "boolean"
},
"email_enabled": {
"title": "Email Enabled",
"type": "boolean"
},
"push_enabled": {
"title": "Push Enabled",
"type": "boolean"
}
},
"required": [
"email",
"push",
"email_enabled",
"push_enabled"
],
"title": "ContextPreferences",
"type": "object"
}DeviceOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "DeviceOutput",
"type": "object"
}Device
{
"additionalProperties": false,
"properties": {
"provider": {
"enum": [
"apns",
"fcm"
],
"title": "Provider",
"type": "string"
},
"token": {
"maxLength": 4096,
"minLength": 16,
"pattern": "^[A-Za-z0-9_:\\-]+$",
"title": "Token",
"type": "string"
}
},
"required": [
"provider",
"token"
],
"title": "Device",
"type": "object"
}SettingsOutput
{
"additionalProperties": false,
"properties": {
"send_on_publish": {
"default": false,
"title": "Send On Publish",
"type": "boolean"
},
"template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Template Id"
},
"email_enabled": {
"title": "Email Enabled",
"type": "boolean"
},
"push_enabled": {
"title": "Push Enabled",
"type": "boolean"
},
"delivery_mode": {
"enum": [
"off",
"capture",
"send"
],
"title": "Delivery Mode",
"type": "string"
},
"variables": {
"items": {
"type": "string"
},
"title": "Variables",
"type": "array"
},
"templates": {
"items": {
"$ref": "#/components/schemas/TemplateOutput"
},
"title": "Templates",
"type": "array"
}
},
"required": [
"email_enabled",
"push_enabled",
"delivery_mode",
"variables",
"templates"
],
"title": "SettingsOutput",
"type": "object"
}TeamSettings
{
"additionalProperties": false,
"properties": {
"send_on_publish": {
"default": false,
"title": "Send On Publish",
"type": "boolean"
},
"template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Template Id"
},
"email_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Email Enabled"
},
"push_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Push Enabled"
}
},
"title": "TeamSettings",
"type": "object"
}Template
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"title": "Name",
"type": "string"
},
"locale": {
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
},
"subject": {
"maxLength": 200,
"minLength": 1,
"title": "Subject",
"type": "string"
},
"body": {
"maxLength": 20000,
"minLength": 1,
"title": "Body",
"type": "string"
}
},
"required": [
"name",
"locale",
"subject",
"body"
],
"title": "Template",
"type": "object"
}TemplateUpdate
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"title": "Name",
"type": "string"
},
"locale": {
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
},
"subject": {
"maxLength": 200,
"minLength": 1,
"title": "Subject",
"type": "string"
},
"body": {
"maxLength": 20000,
"minLength": 1,
"title": "Body",
"type": "string"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"name",
"locale",
"subject",
"body",
"expected_revision"
],
"title": "TemplateUpdate",
"type": "object"
}DeliveryCount
{
"properties": {
"channel": {
"enum": [
"email",
"push"
],
"title": "Channel",
"type": "string"
},
"status": {
"enum": [
"pending",
"sending",
"sent",
"captured",
"failed",
"skipped"
],
"title": "Status",
"type": "string"
},
"count": {
"title": "Count",
"type": "integer"
}
},
"required": [
"channel",
"status",
"count"
],
"title": "DeliveryCount",
"type": "object"
}OptionsOutput
{
"properties": {
"delivery_mode": {
"enum": [
"off",
"capture",
"send"
],
"title": "Delivery Mode",
"type": "string"
},
"email_enabled": {
"title": "Email Enabled",
"type": "boolean"
},
"push_enabled": {
"title": "Push Enabled",
"type": "boolean"
},
"templates": {
"items": {
"$ref": "#/components/schemas/TemplateOutput"
},
"title": "Templates",
"type": "array"
},
"deliveries": {
"items": {
"$ref": "#/components/schemas/DeliveryCount"
},
"title": "Deliveries",
"type": "array"
}
},
"required": [
"delivery_mode",
"email_enabled",
"push_enabled",
"templates",
"deliveries"
],
"title": "OptionsOutput",
"type": "object"
}BatchOutput
{
"properties": {
"batch_id": {
"format": "uuid",
"title": "Batch Id",
"type": "string"
},
"deliveries": {
"items": {
"$ref": "#/components/schemas/DeliveryCount"
},
"title": "Deliveries",
"type": "array"
},
"queued": {
"title": "Queued",
"type": "integer"
}
},
"required": [
"batch_id",
"deliveries",
"queued"
],
"title": "BatchOutput",
"type": "object"
}Send
{
"additionalProperties": false,
"properties": {
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"channels": {
"anyOf": [
{
"items": {
"enum": [
"email",
"push"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Channels"
},
"person_ids": {
"anyOf": [
{
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 1000,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Person Ids"
},
"template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Template Id"
}
},
"required": [
"request_id"
],
"title": "Send",
"type": "object"
}MessageResult
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"queued": {
"title": "Queued",
"type": "integer"
},
"recipient_count": {
"title": "Recipient Count",
"type": "integer"
}
},
"required": [
"id",
"queued",
"recipient_count"
],
"title": "MessageResult",
"type": "object"
}MessageSend
{
"additionalProperties": false,
"properties": {
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"subject": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Subject"
},
"body": {
"maxLength": 20000,
"minLength": 1,
"title": "Body",
"type": "string"
},
"channels": {
"items": {
"enum": [
"email",
"push"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Channels",
"type": "array"
},
"statuses": {
"anyOf": [
{
"items": {
"enum": [
"planned",
"invited",
"accepted",
"declined"
],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Statuses"
},
"person_ids": {
"anyOf": [
{
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Person Ids"
},
"member_ids": {
"anyOf": [
{
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 1000,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Member Ids"
}
},
"required": [
"request_id",
"body",
"channels"
],
"title": "MessageSend",
"type": "object"
}InvitationOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"token": {
"title": "Token",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"email_sent": {
"default": false,
"title": "Email Sent",
"type": "boolean"
}
},
"required": [
"id",
"token",
"expires_at"
],
"title": "InvitationOutput",
"type": "object"
}EventPersonOutput
{
"properties": {
"schedule_conflict": {
"default": false,
"title": "Schedule Conflict",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"section_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Section Id"
},
"section_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Section Name"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Position Id"
},
"position_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Position Name"
},
"status": {
"enum": [
"planned",
"invited",
"accepted",
"declined"
],
"title": "Status",
"type": "string"
},
"planned_at": {
"format": "date-time",
"title": "Planned At",
"type": "string"
},
"invited_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Invited At"
},
"responded_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Responded At"
},
"notification_sent": {
"default": false,
"title": "Notification Sent",
"type": "boolean"
}
},
"required": [
"id",
"member_id",
"display_name",
"section_id",
"section_name",
"position_id",
"position_name",
"status",
"planned_at",
"invited_at",
"responded_at"
],
"title": "EventPersonOutput",
"type": "object"
}EventResponse
{
"additionalProperties": false,
"properties": {
"status": {
"enum": [
"planned",
"invited",
"accepted",
"declined"
],
"title": "Status",
"type": "string"
}
},
"required": [
"status"
],
"title": "EventResponse",
"type": "object"
}UserOutput
{
"properties": {
"has_password": {
"default": true,
"title": "Has Password",
"type": "boolean"
},
"apple_connected": {
"default": false,
"title": "Apple Connected",
"type": "boolean"
},
"apple_available": {
"default": false,
"title": "Apple Available",
"type": "boolean"
},
"google_connected": {
"default": false,
"title": "Google Connected",
"type": "boolean"
},
"google_available": {
"default": false,
"title": "Google Available",
"type": "boolean"
},
"first_name": {
"default": "",
"title": "First Name",
"type": "string"
},
"last_name": {
"default": "",
"title": "Last Name",
"type": "string"
},
"contact_phones": {
"default": [],
"items": {
"type": "string"
},
"title": "Contact Phones",
"type": "array"
},
"contact_emails": {
"default": [],
"items": {
"type": "string"
},
"title": "Contact Emails",
"type": "array"
},
"social_links": {
"default": [],
"items": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"title": "Social Links",
"type": "array"
},
"has_photo": {
"default": false,
"title": "Has Photo",
"type": "boolean"
},
"phone": {
"default": "",
"title": "Phone",
"type": "string"
},
"is_platform_admin": {
"default": false,
"title": "Is Platform Admin",
"type": "boolean"
},
"date_format": {
"anyOf": [
{
"enum": [
"iso",
"dmy_dot",
"dmy_slash",
"mdy_slash",
"long",
"language",
"system"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Format"
},
"show_event_type": {
"default": true,
"title": "Show Event Type",
"type": "boolean"
},
"group_event_sections": {
"default": true,
"title": "Group Event Sections",
"type": "boolean"
},
"theme": {
"default": "light",
"enum": [
"light",
"dark",
"system"
],
"title": "Theme",
"type": "string"
},
"screen_font_sizes": {
"additionalProperties": {
"type": "integer"
},
"title": "Screen Font Sizes",
"type": "object"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"locale": {
"title": "Locale",
"type": "string"
},
"session_expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Session Expires At"
}
},
"required": [
"id",
"email",
"display_name",
"locale"
],
"title": "UserOutput",
"type": "object"
}SocialLink
{
"additionalProperties": false,
"properties": {
"label": {
"maxLength": 40,
"minLength": 1,
"title": "Label",
"type": "string"
},
"url": {
"maxLength": 500,
"minLength": 1,
"title": "Url",
"type": "string"
}
},
"required": [
"label",
"url"
],
"title": "SocialLink",
"type": "object"
}PersonalProfile
{
"additionalProperties": false,
"properties": {
"display_name": {
"maxLength": 120,
"minLength": 1,
"title": "Display Name",
"type": "string"
},
"phone": {
"default": "",
"maxLength": 40,
"title": "Phone",
"type": "string"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
},
"first_name": {
"default": "",
"maxLength": 80,
"title": "First Name",
"type": "string"
},
"last_name": {
"default": "",
"maxLength": 80,
"title": "Last Name",
"type": "string"
},
"contact_phones": {
"default": [],
"items": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"maxItems": 5,
"title": "Contact Phones",
"type": "array"
},
"contact_emails": {
"default": [],
"items": {
"format": "email",
"type": "string"
},
"maxItems": 5,
"title": "Contact Emails",
"type": "array"
},
"social_links": {
"default": [],
"items": {
"$ref": "#/components/schemas/SocialLink"
},
"maxItems": 8,
"title": "Social Links",
"type": "array"
}
},
"required": [
"display_name"
],
"title": "PersonalProfile",
"type": "object"
}PasswordChange
{
"additionalProperties": false,
"properties": {
"current_password": {
"default": "",
"maxLength": 1024,
"title": "Current Password",
"type": "string"
},
"new_password": {
"maxLength": 1024,
"minLength": 12,
"title": "New Password",
"type": "string"
}
},
"required": [
"new_password"
],
"title": "PasswordChange",
"type": "object"
}RegistrationOutput
{
"properties": {
"status": {
"const": "pending",
"title": "Status",
"type": "string"
},
"verification_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Verification Token"
}
},
"required": [
"status"
],
"title": "RegistrationOutput",
"type": "object"
}Empty
{
"additionalProperties": false,
"properties": {},
"title": "Empty",
"type": "object"
}EmailChange
{
"additionalProperties": false,
"properties": {
"current_password": {
"maxLength": 1024,
"minLength": 1,
"title": "Current Password",
"type": "string"
},
"email": {
"format": "email",
"title": "Email",
"type": "string"
}
},
"required": [
"current_password",
"email"
],
"title": "EmailChange",
"type": "object"
}VerifyEmail
{
"additionalProperties": false,
"properties": {
"token": {
"maxLength": 128,
"minLength": 32,
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "VerifyEmail",
"type": "object"
}VerificationRequest
{
"additionalProperties": false,
"properties": {
"email": {
"format": "email",
"title": "Email",
"type": "string"
}
},
"required": [
"email"
],
"title": "VerificationRequest",
"type": "object"
}PasswordReset
{
"additionalProperties": false,
"properties": {
"token": {
"maxLength": 128,
"minLength": 32,
"title": "Token",
"type": "string"
},
"new_password": {
"maxLength": 1024,
"minLength": 12,
"title": "New Password",
"type": "string"
}
},
"required": [
"token",
"new_password"
],
"title": "PasswordReset",
"type": "object"
}AccountSession
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"current": {
"title": "Current",
"type": "boolean"
},
"ip_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ip Address"
},
"device_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Device Name"
},
"location_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Location Name"
}
},
"required": [
"id",
"created_at",
"expires_at",
"current"
],
"title": "AccountSession",
"type": "object"
}LoginHistory
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"revoked_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Revoked At"
},
"ip_address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ip Address"
},
"device_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Device Name"
},
"location_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Location Name"
}
},
"required": [
"id",
"created_at",
"expires_at",
"revoked_at"
],
"title": "LoginHistory",
"type": "object"
}AccountSessions
{
"properties": {
"history": {
"default": [],
"items": {
"$ref": "#/components/schemas/LoginHistory"
},
"title": "History",
"type": "array"
},
"sessions": {
"items": {
"$ref": "#/components/schemas/AccountSession"
},
"title": "Sessions",
"type": "array"
}
},
"required": [
"sessions"
],
"title": "AccountSessions",
"type": "object"
}AccountTeam
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"role": {
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
},
"role_name": {
"default": "",
"title": "Role Name",
"type": "string"
},
"is_owner": {
"title": "Is Owner",
"type": "boolean"
},
"last_opened_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Opened At"
}
},
"required": [
"id",
"name",
"role",
"is_owner"
],
"title": "AccountTeam",
"type": "object"
}AccountTeams
{
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/AccountTeam"
},
"title": "Results",
"type": "array"
}
},
"required": [
"results"
],
"title": "AccountTeams",
"type": "object"
}AccountDelete
{
"additionalProperties": false,
"properties": {
"current_password": {
"maxLength": 1024,
"minLength": 1,
"title": "Current Password",
"type": "string"
},
"confirmation": {
"const": "DELETE",
"title": "Confirmation",
"type": "string"
}
},
"required": [
"current_password",
"confirmation"
],
"title": "AccountDelete",
"type": "object"
}OwnershipTransfer
{
"additionalProperties": false,
"properties": {
"current_password": {
"maxLength": 1024,
"minLength": 1,
"title": "Current Password",
"type": "string"
},
"membership_id": {
"format": "uuid",
"title": "Membership Id",
"type": "string"
}
},
"required": [
"current_password",
"membership_id"
],
"title": "OwnershipTransfer",
"type": "object"
}TeamDelete
{
"additionalProperties": false,
"properties": {
"current_password": {
"maxLength": 1024,
"minLength": 1,
"title": "Current Password",
"type": "string"
},
"confirmation": {
"title": "Confirmation",
"type": "string"
}
},
"required": [
"current_password",
"confirmation"
],
"title": "TeamDelete",
"type": "object"
}RosterResult
{
"properties": {
"people": {
"title": "People",
"type": "integer"
},
"active_people": {
"title": "Active People",
"type": "integer"
},
"teams": {
"title": "Teams",
"type": "integer"
},
"assignments": {
"title": "Assignments",
"type": "integer"
},
"duplicate_primary_emails": {
"title": "Duplicate Primary Emails",
"type": "integer"
},
"new_people": {
"title": "New People",
"type": "integer"
},
"updated_people": {
"title": "Updated People",
"type": "integer"
}
},
"required": [
"people",
"active_people",
"teams",
"assignments",
"duplicate_primary_emails",
"new_people",
"updated_people"
],
"title": "RosterResult",
"type": "object"
}Assignment
{
"additionalProperties": false,
"properties": {
"planning_center_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Planning Center Id",
"type": "string"
},
"person_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Person Id",
"type": "string"
},
"team_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Team Id",
"type": "string"
},
"position_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Position Id",
"type": "string"
}
},
"required": [
"planning_center_id",
"person_id",
"team_id",
"position_id"
],
"title": "Assignment",
"type": "object"
}{
"additionalProperties": false,
"properties": {
"address": {
"format": "email",
"title": "Address",
"type": "string"
},
"primary": {
"default": false,
"title": "Primary",
"type": "boolean"
}
},
"required": [
"address"
],
"title": "Email",
"type": "object"
}Person
{
"additionalProperties": false,
"properties": {
"planning_center_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Planning Center Id",
"type": "string"
},
"full_name": {
"maxLength": 120,
"minLength": 1,
"title": "Full Name",
"type": "string"
},
"first_name": {
"anyOf": [
{
"maxLength": 120,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "First Name"
},
"last_name": {
"anyOf": [
{
"maxLength": 120,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Name"
},
"emails": {
"items": {
"$ref": "#/components/schemas/Email"
},
"maxItems": 10,
"title": "Emails",
"type": "array"
},
"archived": {
"default": false,
"title": "Archived",
"type": "boolean"
},
"status": {
"anyOf": [
{
"maxLength": 80,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
}
},
"required": [
"planning_center_id",
"full_name"
],
"title": "Person",
"type": "object"
}Position
{
"additionalProperties": false,
"properties": {
"planning_center_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Planning Center Id",
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"planning_center_id",
"name"
],
"title": "Position",
"type": "object"
}Team
{
"additionalProperties": false,
"properties": {
"planning_center_id": {
"maxLength": 120,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"title": "Planning Center Id",
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"archived": {
"default": false,
"title": "Archived",
"type": "boolean"
},
"deleted": {
"default": false,
"title": "Deleted",
"type": "boolean"
},
"positions": {
"items": {
"$ref": "#/components/schemas/Position"
},
"maxItems": 100,
"title": "Positions",
"type": "array"
}
},
"required": [
"planning_center_id",
"name"
],
"title": "Team",
"type": "object"
}Roster
{
"additionalProperties": false,
"properties": {
"source": {
"const": "Planning Center Services",
"title": "Source",
"type": "string"
},
"exported_at": {
"title": "Exported At",
"type": "string"
},
"people": {
"items": {
"$ref": "#/components/schemas/Person"
},
"maxItems": 5000,
"title": "People",
"type": "array"
},
"teams": {
"items": {
"$ref": "#/components/schemas/Team"
},
"maxItems": 500,
"title": "Teams",
"type": "array"
},
"assignments": {
"items": {
"$ref": "#/components/schemas/Assignment"
},
"maxItems": 20000,
"title": "Assignments",
"type": "array"
}
},
"required": [
"source",
"exported_at",
"people",
"teams",
"assignments"
],
"title": "Roster",
"type": "object"
}RosterPerson
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"full_name": {
"title": "Full Name",
"type": "string"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Email"
},
"archived": {
"title": "Archived",
"type": "boolean"
},
"roles": {
"items": {
"type": "string"
},
"title": "Roles",
"type": "array"
}
},
"required": [
"id",
"full_name",
"email",
"archived",
"roles"
],
"title": "RosterPerson",
"type": "object"
}RosterList
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
},
"results": {
"items": {
"$ref": "#/components/schemas/RosterPerson"
},
"title": "Results",
"type": "array"
}
},
"required": [
"count",
"results"
],
"title": "RosterList",
"type": "object"
}HistoryItem
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"title": "Kind",
"type": "string"
},
"source_namespace": {
"title": "Source Namespace",
"type": "string"
},
"item_count": {
"title": "Item Count",
"type": "integer"
},
"changed_count": {
"title": "Changed Count",
"type": "integer"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
}
},
"required": [
"id",
"kind",
"source_namespace",
"item_count",
"changed_count",
"created_at"
],
"title": "HistoryItem",
"type": "object"
}History
{
"properties": {
"people_imports": {
"items": {
"$ref": "#/components/schemas/HistoryItem"
},
"title": "People Imports",
"type": "array"
},
"song_count": {
"title": "Song Count",
"type": "integer"
},
"song_last_imported_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Song Last Imported At"
}
},
"required": [
"people_imports",
"song_count",
"song_last_imported_at"
],
"title": "History",
"type": "object"
}ImportResult
{
"properties": {
"status": {
"title": "Status",
"type": "string"
},
"material_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Material Id"
},
"source_id": {
"title": "Source Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"arrangements": {
"title": "Arrangements",
"type": "integer"
},
"keys": {
"title": "Keys",
"type": "integer"
},
"files": {
"title": "Files",
"type": "integer"
},
"warnings": {
"items": {
"type": "string"
},
"title": "Warnings",
"type": "array"
},
"default_arrangement_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Arrangement Id"
},
"attachments": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Attachments",
"type": "array"
}
},
"required": [
"status",
"source_id",
"title",
"arrangements",
"keys",
"files",
"warnings"
],
"title": "ImportResult",
"type": "object"
}Arrangement
{
"additionalProperties": false,
"properties": {
"record": {
"$ref": "#/components/schemas/Record"
},
"tags": {
"items": {
"$ref": "#/components/schemas/Record"
},
"maxItems": 200,
"title": "Tags",
"type": "array"
},
"sections": {
"items": {
"$ref": "#/components/schemas/Record"
},
"maxItems": 200,
"title": "Sections",
"type": "array"
},
"keys": {
"items": {
"$ref": "#/components/schemas/Record"
},
"maxItems": 100,
"title": "Keys",
"type": "array"
}
},
"required": [
"record"
],
"title": "Arrangement",
"type": "object"
}Attachment
{
"additionalProperties": false,
"properties": {
"record": {
"$ref": "#/components/schemas/Record"
},
"contexts": {
"items": {
"$ref": "#/components/schemas/Context"
},
"maxItems": 300,
"minItems": 1,
"title": "Contexts",
"type": "array"
},
"status": {
"enum": [
"downloaded",
"skipped",
"unavailable",
"error"
],
"title": "Status",
"type": "string"
},
"reason": {
"default": "",
"maxLength": 200,
"title": "Reason",
"type": "string"
},
"size": {
"default": 0,
"maximum": 52428800,
"minimum": 0,
"title": "Size",
"type": "integer"
},
"sha256": {
"default": "",
"pattern": "^([a-f0-9]{64})?$",
"title": "Sha256",
"type": "string"
}
},
"required": [
"record",
"contexts",
"status"
],
"title": "Attachment",
"type": "object"
}Context
{
"additionalProperties": false,
"properties": {
"level": {
"enum": [
"song",
"arrangement",
"key"
],
"title": "Level",
"type": "string"
},
"source_id": {
"pattern": "^[A-Za-z0-9_-]{1,120}$",
"title": "Source Id",
"type": "string"
}
},
"required": [
"level",
"source_id"
],
"title": "Context",
"type": "object"
}Record
{
"additionalProperties": false,
"properties": {
"id": {
"pattern": "^[A-Za-z0-9_-]{1,120}$",
"title": "Id",
"type": "string"
},
"type": {
"title": "Type",
"type": "string"
},
"attributes": {
"additionalProperties": true,
"title": "Attributes",
"type": "object"
},
"relationships": {
"additionalProperties": true,
"title": "Relationships",
"type": "object"
},
"links": {
"additionalProperties": true,
"title": "Links",
"type": "object"
}
},
"required": [
"id",
"type",
"attributes"
],
"title": "Record",
"type": "object"
}Bundle
{
"additionalProperties": false,
"properties": {
"namespace": {
"default": "planning-center",
"maxLength": 120,
"minLength": 1,
"title": "Namespace",
"type": "string"
},
"language": {
"default": "pl",
"maxLength": 10,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$",
"title": "Language",
"type": "string"
},
"default_arrangement_id": {
"anyOf": [
{
"pattern": "^[A-Za-z0-9_-]{1,120}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Arrangement Id"
},
"song": {
"$ref": "#/components/schemas/Record"
},
"tags": {
"items": {
"$ref": "#/components/schemas/Record"
},
"maxItems": 200,
"title": "Tags",
"type": "array"
},
"arrangements": {
"items": {
"$ref": "#/components/schemas/Arrangement"
},
"maxItems": 100,
"title": "Arrangements",
"type": "array"
},
"attachments": {
"items": {
"$ref": "#/components/schemas/Attachment"
},
"maxItems": 500,
"title": "Attachments",
"type": "array"
}
},
"required": [
"song"
],
"title": "Bundle",
"type": "object"
}ProPresenterArrangement
{
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"name": {
"title": "Name",
"type": "string"
},
"sequence": {
"items": {
"type": "string"
},
"title": "Sequence",
"type": "array"
},
"default": {
"type": "boolean",
"title": "Default"
}
},
"required": [
"id",
"name",
"sequence",
"default"
],
"title": "ProPresenterArrangement",
"type": "object"
}ProPresenterExisting
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"title"
],
"title": "ProPresenterExisting",
"type": "object"
}ProPresenterGroup
{
"properties": {
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"label": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Label"
},
"color": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Color"
},
"slides": {
"items": {
"$ref": "#/components/schemas/ProPresenterSlide"
},
"title": "Slides",
"type": "array"
}
},
"required": [
"id",
"name",
"label",
"color",
"slides"
],
"title": "ProPresenterGroup",
"type": "object"
}ProPresenterSlide
{
"properties": {
"text": {
"title": "Text",
"type": "string"
},
"label": {
"title": "Label",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
}
},
"required": [
"text",
"label",
"enabled"
],
"title": "ProPresenterSlide",
"type": "object"
}ProPresenterPreviewOutput
{
"properties": {
"source": {
"default": "propresenter",
"enum": [
"propresenter",
"opensong"
],
"title": "Source",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"ccli": {
"additionalProperties": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "null"
}
]
},
"title": "Ccli",
"type": "object"
},
"key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Key"
},
"source_key": {
"title": "Source Key",
"type": "string"
},
"groups": {
"items": {
"$ref": "#/components/schemas/ProPresenterGroup"
},
"title": "Groups",
"type": "array"
},
"arrangements": {
"items": {
"$ref": "#/components/schemas/ProPresenterArrangement"
},
"title": "Arrangements",
"type": "array"
},
"body": {
"title": "Body",
"type": "string"
},
"warnings": {
"items": {
"type": "string"
},
"title": "Warnings",
"type": "array"
},
"existing": {
"items": {
"$ref": "#/components/schemas/ProPresenterExisting"
},
"title": "Existing",
"type": "array"
}
},
"required": [
"filename",
"title",
"ccli",
"key",
"source_key",
"groups",
"arrangements",
"body",
"warnings",
"existing"
],
"title": "ProPresenterPreviewOutput",
"type": "object"
}OpenSongPreviewInput
{
"additionalProperties": false,
"properties": {
"filename": {
"maxLength": 255,
"minLength": 1,
"title": "Filename",
"type": "string"
},
"content": {
"maxLength": 933336,
"minLength": 4,
"title": "Content",
"type": "string"
}
},
"required": [
"filename",
"content"
],
"title": "OpenSongPreviewInput",
"type": "object"
}ProPresenterImportOutput
{
"properties": {
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"arrangements": {
"title": "Arrangements",
"type": "integer"
},
"link_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Link Id"
},
"warnings": {
"items": {
"type": "string"
},
"title": "Warnings",
"type": "array"
}
},
"required": [
"material_id",
"title",
"arrangements",
"link_id",
"warnings"
],
"title": "ProPresenterImportOutput",
"type": "object"
}SongBatchImportOutput
{
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/ProPresenterImportOutput"
},
"title": "Results",
"type": "array"
}
},
"required": [
"results"
],
"title": "SongBatchImportOutput",
"type": "object"
}FileSongSource
{
"additionalProperties": false,
"properties": {
"pages": {
"anyOf": [
{
"items": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Pages"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"page": {
"anyOf": [
{
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Page"
}
},
"required": [
"file_id"
],
"title": "FileSongSource",
"type": "object"
}MaterialInput
{
"additionalProperties": false,
"properties": {
"source_file": {
"anyOf": [
{
"$ref": "#/components/schemas/FileSongSource"
},
{
"type": "null"
}
],
"default": null
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"title": {
"maxLength": 200,
"minLength": 1,
"title": "Title",
"type": "string"
},
"kind": {
"enum": [
"song",
"spoken",
"score",
"lyrics",
"chords"
],
"title": "Kind",
"type": "string"
},
"language": {
"default": "pl",
"maxLength": 10,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$",
"title": "Language",
"type": "string"
},
"author_credit": {
"default": "",
"maxLength": 300,
"title": "Author Credit",
"type": "string"
},
"body": {
"default": "",
"maxLength": 100000,
"title": "Body",
"type": "string"
},
"default_key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Default Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"maximum": 300,
"minimum": 20,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"maxLength": 12,
"pattern": "^$|^[1-9][0-9]?/[1248]$",
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"composer_credit": {
"default": "",
"maxLength": 300,
"title": "Composer Credit",
"type": "string"
},
"lyricist_credit": {
"default": "",
"maxLength": 300,
"title": "Lyricist Credit",
"type": "string"
},
"arranger_credit": {
"default": "",
"maxLength": 300,
"title": "Arranger Credit",
"type": "string"
},
"ccli_number": {
"default": "",
"maxLength": 120,
"title": "Ccli Number",
"type": "string"
},
"copyright": {
"default": "",
"maxLength": 4000,
"title": "Copyright",
"type": "string"
},
"publisher_credit": {
"default": "",
"maxLength": 1000,
"title": "Publisher Credit",
"type": "string"
},
"themes": {
"default": "",
"maxLength": 4000,
"title": "Themes",
"type": "string"
},
"notes": {
"default": "",
"maxLength": 10000,
"title": "Notes",
"type": "string"
},
"tags": {
"items": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"maxItems": 20,
"title": "Tags",
"type": "array"
},
"pdf_layout": {
"$ref": "#/components/schemas/PdfLayout"
}
},
"required": [
"title",
"kind"
],
"title": "MaterialInput",
"type": "object"
}PdfLayout
{
"additionalProperties": false,
"properties": {
"compact": {
"default": false,
"title": "Compact",
"type": "boolean"
},
"fontFamily": {
"default": "Arial",
"enum": [
"Arial",
"Georgia",
"Times New Roman",
"Verdana",
"Courier New"
],
"title": "Fontfamily",
"type": "string"
},
"fontSize": {
"default": 12,
"enum": [
6,
7,
8,
9,
10,
11,
12,
13,
14,
16,
18,
20
],
"title": "Fontsize",
"type": "integer"
},
"orientation": {
"default": "portrait",
"enum": [
"portrait",
"landscape"
],
"title": "Orientation",
"type": "string"
},
"columns": {
"default": 1,
"enum": [
1,
2,
3
],
"title": "Columns",
"type": "integer"
}
},
"title": "PdfLayout",
"type": "object"
}ProPresenterImportInput
{
"additionalProperties": false,
"properties": {
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"title": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
}
},
"required": [
"file_id"
],
"title": "ProPresenterImportInput",
"type": "object"
}SongTextImportInput
{
"additionalProperties": false,
"properties": {
"material": {
"$ref": "#/components/schemas/MaterialInput"
},
"arrangements": {
"items": {
"$ref": "#/components/schemas/VariantInput"
},
"maxItems": 100,
"minItems": 1,
"title": "Arrangements",
"type": "array"
},
"default_index": {
"default": 0,
"maximum": 99,
"minimum": 0,
"title": "Default Index",
"type": "integer"
}
},
"required": [
"material",
"arrangements"
],
"title": "SongTextImportInput",
"type": "object"
}VariantInput
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"maximum": 300,
"minimum": 20,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"maxLength": 12,
"pattern": "^$|^[1-9][0-9]?/[1248]$",
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"arranger_credit": {
"default": "",
"maxLength": 300,
"title": "Arranger Credit",
"type": "string"
},
"body": {
"default": "",
"maxLength": 100000,
"title": "Body",
"type": "string"
},
"sequence": {
"items": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"maxItems": 200,
"title": "Sequence",
"type": "array"
},
"notes": {
"default": "",
"maxLength": 4000,
"title": "Notes",
"type": "string"
}
},
"required": [
"name"
],
"title": "VariantInput",
"type": "object"
}SongBatchImportInput
{
"additionalProperties": false,
"properties": {
"unique_sections": {
"default": false,
"title": "Unique Sections",
"type": "boolean"
},
"source": {
"default": "auto",
"enum": [
"propresenter",
"opensong",
"auto"
],
"title": "Source",
"type": "string"
},
"songs": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/ProPresenterImportInput"
},
{
"$ref": "#/components/schemas/SongTextImportInput"
}
]
},
"maxItems": 100,
"minItems": 1,
"title": "Songs",
"type": "array"
}
},
"required": [
"songs"
],
"title": "SongBatchImportInput",
"type": "object"
}ProPresenterPreviewInput
{
"additionalProperties": false,
"properties": {
"filename": {
"maxLength": 255,
"minLength": 5,
"pattern": "(?i)\\.pro$",
"title": "Filename",
"type": "string"
},
"content": {
"maxLength": 933336,
"minLength": 4,
"title": "Content",
"type": "string"
}
},
"required": [
"filename",
"content"
],
"title": "ProPresenterPreviewInput",
"type": "object"
}SourceOutput
{
"properties": {
"imports": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Imports",
"type": "array"
},
"keys": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Keys",
"type": "array"
},
"files": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Files",
"type": "array"
},
"contexts": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Contexts",
"type": "array"
}
},
"required": [
"imports",
"keys",
"files",
"contexts"
],
"title": "SourceOutput",
"type": "object"
}FileAssignmentOutput
{
"properties": {
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Id"
}
},
"required": [
"file_id",
"variant_id"
],
"title": "FileAssignmentOutput",
"type": "object"
}FileAssignment
{
"additionalProperties": false,
"properties": {
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Id"
}
},
"required": [
"variant_id"
],
"title": "FileAssignment",
"type": "object"
}FileOutput
{
"properties": {
"display_name": {
"default": "",
"title": "Display Name",
"type": "string"
},
"author_credit": {
"default": "",
"title": "Author Credit",
"type": "string"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"source_id": {
"title": "Source Id",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"filetype": {
"title": "Filetype",
"type": "string"
},
"expected_size": {
"title": "Expected Size",
"type": "integer"
},
"uploaded_size": {
"title": "Uploaded Size",
"type": "integer"
},
"sha256": {
"title": "Sha256",
"type": "string"
},
"status": {
"title": "Status",
"type": "string"
},
"reason": {
"title": "Reason",
"type": "string"
}
},
"required": [
"id",
"source_id",
"filename",
"filetype",
"expected_size",
"uploaded_size",
"sha256",
"status",
"reason"
],
"title": "FileOutput",
"type": "object"
}Chunk
{
"additionalProperties": false,
"properties": {
"offset": {
"maximum": 52428800,
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"data": {
"maxLength": 349528,
"minLength": 4,
"title": "Data",
"type": "string"
}
},
"required": [
"offset",
"data"
],
"title": "Chunk",
"type": "object"
}ChunkOutput
{
"properties": {
"offset": {
"title": "Offset",
"type": "integer"
},
"data": {
"title": "Data",
"type": "string"
}
},
"required": [
"offset",
"data"
],
"title": "ChunkOutput",
"type": "object"
}Register
{
"additionalProperties": false,
"properties": {
"email": {
"format": "email",
"title": "Email",
"type": "string"
},
"display_name": {
"maxLength": 120,
"minLength": 1,
"title": "Display Name",
"type": "string"
},
"password": {
"maxLength": 1024,
"minLength": 12,
"title": "Password",
"type": "string"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
}
},
"required": [
"email",
"display_name",
"password"
],
"title": "Register",
"type": "object"
}TokenOutput
{
"properties": {
"access_token": {
"title": "Access Token",
"type": "string"
},
"token_type": {
"const": "Bearer",
"title": "Token Type",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"refresh_token": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Refresh Token"
}
},
"required": [
"access_token",
"token_type",
"expires_at"
],
"title": "TokenOutput",
"type": "object"
}Login
{
"additionalProperties": false,
"properties": {
"email": {
"format": "email",
"title": "Email",
"type": "string"
},
"password": {
"maxLength": 1024,
"minLength": 1,
"title": "Password",
"type": "string"
},
"remember_device": {
"default": false,
"title": "Remember Device",
"type": "boolean"
}
},
"required": [
"email",
"password"
],
"title": "Login",
"type": "object"
}RefreshSession
{
"additionalProperties": false,
"properties": {
"refresh_token": {
"maxLength": 128,
"minLength": 32,
"title": "Refresh Token",
"type": "string"
}
},
"required": [
"refresh_token"
],
"title": "RefreshSession",
"type": "object"
}BrowserSessionOutput
{
"properties": {
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
}
},
"required": [
"expires_at"
],
"title": "BrowserSessionOutput",
"type": "object"
}UserAppearance
{
"additionalProperties": false,
"properties": {
"theme": {
"anyOf": [
{
"enum": [
"light",
"dark",
"system"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Theme"
},
"screen": {
"anyOf": [
{
"enum": [
"overview",
"library",
"song",
"files",
"plans",
"event",
"templates",
"template",
"sections",
"section",
"members",
"roles",
"catalog",
"licenses",
"subscription",
"settings",
"account",
"admin"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Screen"
},
"font_size": {
"anyOf": [
{
"enum": [
85,
100,
115,
130,
150
],
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Font Size"
}
},
"title": "UserAppearance",
"type": "object"
}UserPreferences
{
"additionalProperties": false,
"properties": {
"locale": {
"anyOf": [
{
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Locale"
},
"date_format": {
"anyOf": [
{
"enum": [
"iso",
"dmy_dot",
"dmy_slash",
"mdy_slash",
"long",
"language",
"system"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Date Format"
},
"show_event_type": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Show Event Type"
},
"group_event_sections": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Group Event Sections"
}
},
"title": "UserPreferences",
"type": "object"
}TeamPreferences
{
"additionalProperties": false,
"properties": {
"date_format": {
"enum": [
"iso",
"dmy_dot",
"dmy_slash",
"mdy_slash",
"long",
"language",
"system"
],
"title": "Date Format",
"type": "string"
}
},
"required": [
"date_format"
],
"title": "TeamPreferences",
"type": "object"
}NewTeam
{
"additionalProperties": false,
"properties": {
"timezone": {
"default": "UTC",
"title": "Timezone",
"type": "string"
},
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
}
},
"required": [
"name"
],
"title": "NewTeam",
"type": "object"
}MemberSquadOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"is_leader": {
"title": "Is Leader",
"type": "boolean"
},
"role": {
"default": "musician",
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
},
"role_name": {
"default": "",
"title": "Role Name",
"type": "string"
}
},
"required": [
"id",
"name",
"is_leader"
],
"title": "MemberSquadOutput",
"type": "object"
}MemberOutput
{
"properties": {
"squads": {
"default": [],
"items": {
"$ref": "#/components/schemas/MemberSquadOutput"
},
"title": "Squads",
"type": "array"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"user_id": {
"format": "uuid",
"title": "User Id",
"type": "string"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"email": {
"anyOf": [
{
"format": "email",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"has_photo": {
"title": "Has Photo",
"type": "boolean"
},
"account_active": {
"title": "Account Active",
"type": "boolean"
},
"last_login_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Login At"
},
"role": {
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
},
"role_name": {
"default": "",
"title": "Role Name",
"type": "string"
},
"is_owner": {
"default": false,
"title": "Is Owner",
"type": "boolean"
},
"active": {
"title": "Active",
"type": "boolean"
}
},
"required": [
"id",
"user_id",
"display_name",
"has_photo",
"account_active",
"last_login_at",
"role",
"active"
],
"title": "MemberOutput",
"type": "object"
}MemberChange
{
"additionalProperties": false,
"properties": {
"role": {
"anyOf": [
{
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
}
},
"title": "MemberChange",
"type": "object"
}MemberProfileOutput
{
"properties": {
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"section_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"title": "Section Ids",
"type": "array"
},
"position_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"title": "Position Ids",
"type": "array"
},
"assignments": {
"items": {
"additionalProperties": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
"title": "Assignments",
"type": "array"
}
},
"required": [
"member_id",
"section_ids",
"position_ids"
],
"title": "MemberProfileOutput",
"type": "object"
}MemberProfileInput
{
"additionalProperties": false,
"properties": {
"section_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"title": "Section Ids",
"type": "array"
},
"position_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 100,
"title": "Position Ids",
"type": "array"
}
},
"required": [
"section_ids",
"position_ids"
],
"title": "MemberProfileInput",
"type": "object"
}MemberAccountOutput
{
"properties": {
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"email": {
"format": "email",
"title": "Email",
"type": "string"
},
"has_photo": {
"title": "Has Photo",
"type": "boolean"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"phone": {
"title": "Phone",
"type": "string"
},
"locale": {
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
},
"first_name": {
"title": "First Name",
"type": "string"
},
"last_name": {
"title": "Last Name",
"type": "string"
},
"contact_phones": {
"items": {
"type": "string"
},
"title": "Contact Phones",
"type": "array"
},
"contact_emails": {
"items": {
"format": "email",
"type": "string"
},
"title": "Contact Emails",
"type": "array"
},
"social_links": {
"items": {
"$ref": "#/components/schemas/SocialLink"
},
"title": "Social Links",
"type": "array"
}
},
"required": [
"member_id",
"email",
"has_photo",
"display_name",
"phone",
"locale",
"first_name",
"last_name",
"contact_phones",
"contact_emails",
"social_links"
],
"title": "MemberAccountOutput",
"type": "object"
}MemberAccountUpdate
{
"additionalProperties": false,
"properties": {
"display_name": {
"maxLength": 120,
"minLength": 1,
"title": "Display Name",
"type": "string"
},
"phone": {
"default": "",
"maxLength": 40,
"title": "Phone",
"type": "string"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
},
"first_name": {
"default": "",
"maxLength": 80,
"title": "First Name",
"type": "string"
},
"last_name": {
"default": "",
"maxLength": 80,
"title": "Last Name",
"type": "string"
},
"contact_phones": {
"default": [],
"items": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"maxItems": 5,
"title": "Contact Phones",
"type": "array"
},
"contact_emails": {
"default": [],
"items": {
"format": "email",
"type": "string"
},
"maxItems": 5,
"title": "Contact Emails",
"type": "array"
},
"social_links": {
"default": [],
"items": {
"$ref": "#/components/schemas/SocialLink"
},
"maxItems": 8,
"title": "Social Links",
"type": "array"
}
},
"required": [
"display_name"
],
"title": "MemberAccountUpdate",
"type": "object"
}MemberPasswordUpdate
{
"additionalProperties": false,
"properties": {
"new_password": {
"maxLength": 1024,
"minLength": 12,
"title": "New Password",
"type": "string"
}
},
"required": [
"new_password"
],
"title": "MemberPasswordUpdate",
"type": "object"
}MemberEmailChange
{
"additionalProperties": false,
"properties": {
"email": {
"format": "email",
"title": "Email",
"type": "string"
}
},
"required": [
"email"
],
"title": "MemberEmailChange",
"type": "object"
}SectionOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"can_edit": {
"default": false,
"title": "Can Edit",
"type": "boolean"
}
},
"required": [
"id",
"name"
],
"title": "SectionOutput",
"type": "object"
}SectionInput
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
}
},
"required": [
"name"
],
"title": "SectionInput",
"type": "object"
}SectionPositionOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"section_id": {
"format": "uuid",
"title": "Section Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"section_id",
"name"
],
"title": "SectionPositionOutput",
"type": "object"
}NamedInput
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "NamedInput",
"type": "object"
}SectionRosterOutput
{
"properties": {
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Position Id"
},
"position_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Position Name"
}
},
"required": [
"member_id",
"display_name",
"position_id",
"position_name"
],
"title": "SectionRosterOutput",
"type": "object"
}SectionMoveInput
{
"additionalProperties": false,
"properties": {
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"source_position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Position Id"
},
"target_section_id": {
"format": "uuid",
"title": "Target Section Id",
"type": "string"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Position Id"
}
},
"required": [
"member_id",
"target_section_id"
],
"title": "SectionMoveInput",
"type": "object"
}EventPersonInput
{
"additionalProperties": false,
"properties": {
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"section_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Section Id"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Position Id"
}
},
"required": [
"member_id"
],
"title": "EventPersonInput",
"type": "object"
}EventPeopleInput
{
"additionalProperties": false,
"properties": {
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"people": {
"items": {
"$ref": "#/components/schemas/EventPersonInput"
},
"maxItems": 1000,
"minItems": 1,
"title": "People",
"type": "array"
}
},
"required": [
"people"
],
"title": "EventPeopleInput",
"type": "object"
}SectionAssignmentInput
{
"additionalProperties": false,
"properties": {
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"member_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"title": "Member Ids",
"type": "array"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Position Id"
}
},
"required": [
"member_ids"
],
"title": "SectionAssignmentInput",
"type": "object"
}PermissionAreaOutput
{
"properties": {
"key": {
"title": "Key",
"type": "string"
},
"levels": {
"items": {
"enum": [
"none",
"view",
"edit",
"manage"
],
"type": "string"
},
"title": "Levels",
"type": "array"
}
},
"required": [
"key",
"levels"
],
"title": "PermissionAreaOutput",
"type": "object"
}ResourceGrant
{
"additionalProperties": false,
"properties": {
"area": {
"enum": [
"plans",
"library",
"templates",
"files"
],
"title": "Area",
"type": "string"
},
"action": {
"enum": [
"view",
"edit",
"manage",
"drafts",
"lineup"
],
"title": "Action",
"type": "string"
},
"scope": {
"enum": [
"all",
"own",
"squad",
"scheduled"
],
"title": "Scope",
"type": "string"
}
},
"required": [
"area",
"action",
"scope"
],
"title": "ResourceGrant",
"type": "object"
}TeamRoleOutput
{
"properties": {
"grants": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ResourceGrant"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Grants"
},
"id": {
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"builtin": {
"title": "Builtin",
"type": "boolean"
},
"permissions": {
"additionalProperties": {
"enum": [
"none",
"view",
"edit",
"manage"
],
"type": "string"
},
"title": "Permissions",
"type": "object"
},
"member_count": {
"title": "Member Count",
"type": "integer"
},
"invitation_count": {
"title": "Invitation Count",
"type": "integer"
},
"in_use": {
"title": "In Use",
"type": "boolean"
},
"revision": {
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"name",
"builtin",
"permissions",
"member_count",
"invitation_count",
"in_use",
"revision"
],
"title": "TeamRoleOutput",
"type": "object"
}TeamRolesOutput
{
"properties": {
"areas": {
"items": {
"$ref": "#/components/schemas/PermissionAreaOutput"
},
"title": "Areas",
"type": "array"
},
"dependencies": {
"additionalProperties": {
"additionalProperties": {
"enum": [
"none",
"view",
"edit",
"manage"
],
"type": "string"
},
"type": "object"
},
"title": "Dependencies",
"type": "object"
},
"roles": {
"items": {
"$ref": "#/components/schemas/TeamRoleOutput"
},
"title": "Roles",
"type": "array"
},
"can_manage": {
"title": "Can Manage",
"type": "boolean"
}
},
"required": [
"areas",
"dependencies",
"roles",
"can_manage"
],
"title": "TeamRolesOutput",
"type": "object"
}TeamRoleInput
{
"additionalProperties": false,
"properties": {
"grants": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ResourceGrant"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Grants"
},
"name": {
"maxLength": 60,
"minLength": 1,
"title": "Name",
"type": "string"
},
"permissions": {
"additionalProperties": {
"enum": [
"none",
"view",
"edit",
"manage"
],
"type": "string"
},
"propertyNames": {
"maxLength": 40
},
"title": "Permissions",
"type": "object"
}
},
"required": [
"name",
"permissions"
],
"title": "TeamRoleInput",
"type": "object"
}TeamRoleUpdate
{
"additionalProperties": false,
"properties": {
"grants": {
"anyOf": [
{
"items": {
"$ref": "#/components/schemas/ResourceGrant"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Grants"
},
"name": {
"maxLength": 60,
"minLength": 1,
"title": "Name",
"type": "string"
},
"permissions": {
"additionalProperties": {
"enum": [
"none",
"view",
"edit",
"manage"
],
"type": "string"
},
"propertyNames": {
"maxLength": 40
},
"title": "Permissions",
"type": "object"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"name",
"permissions",
"expected_revision"
],
"title": "TeamRoleUpdate",
"type": "object"
}TeamRoleDelete
{
"additionalProperties": false,
"properties": {
"replacement_role": {
"anyOf": [
{
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Replacement Role"
},
"replacement_role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Replacement Role Id"
}
},
"title": "TeamRoleDelete",
"type": "object"
}SentInvitationOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
},
"role": {
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Role Id"
},
"role_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Role Name"
},
"status": {
"enum": [
"pending",
"accepted",
"declined",
"revoked",
"expired"
],
"title": "Status",
"type": "string"
},
"invited_by_name": {
"title": "Invited By Name",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"responded_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Responded At"
},
"can_revoke": {
"title": "Can Revoke",
"type": "boolean"
},
"can_delete": {
"title": "Can Delete",
"type": "boolean"
}
},
"required": [
"id",
"email",
"role",
"role_id",
"role_name",
"status",
"invited_by_name",
"created_at",
"expires_at",
"responded_at",
"can_revoke",
"can_delete"
],
"title": "SentInvitationOutput",
"type": "object"
}Invite
{
"additionalProperties": false,
"properties": {
"squad_ids": {
"anyOf": [
{
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 100,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Ids"
},
"email": {
"format": "email",
"title": "Email",
"type": "string"
},
"role": {
"default": "musician",
"enum": [
"owner",
"leader",
"editor",
"musician",
"custom"
],
"title": "Role",
"type": "string"
},
"role_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Role Id"
},
"send_email": {
"default": false,
"title": "Send Email",
"type": "boolean"
}
},
"required": [
"email"
],
"title": "Invite",
"type": "object"
}ReceivedInvitationOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"team_id": {
"format": "uuid",
"title": "Team Id",
"type": "string"
},
"team_name": {
"title": "Team Name",
"type": "string"
},
"invited_by_name": {
"title": "Invited By Name",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
}
},
"required": [
"id",
"team_id",
"team_name",
"invited_by_name",
"created_at",
"expires_at"
],
"title": "ReceivedInvitationOutput",
"type": "object"
}Accept
{
"additionalProperties": false,
"properties": {
"token": {
"maxLength": 128,
"minLength": 1,
"title": "Token",
"type": "string"
}
},
"required": [
"token"
],
"title": "Accept",
"type": "object"
}ArrangementSummaryOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Bpm"
},
"meter": {
"title": "Meter",
"type": "string"
},
"is_default": {
"title": "Is Default",
"type": "boolean"
},
"archived_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Archived At"
},
"tags": {
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"has_lyrics": {
"default": false,
"title": "Has Lyrics",
"type": "boolean"
}
},
"required": [
"id",
"name",
"key",
"bpm",
"meter",
"is_default"
],
"title": "ArrangementSummaryOutput",
"type": "object"
}MaterialOutput
{
"properties": {
"thumbnail_revision": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thumbnail Revision"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"responsible_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Responsible Member Id"
},
"capabilities": {
"anyOf": [
{
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Capabilities"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"kind": {
"enum": [
"lyrics",
"chords",
"score",
"song",
"spoken"
],
"title": "Kind",
"type": "string"
},
"language": {
"title": "Language",
"type": "string"
},
"author_credit": {
"title": "Author Credit",
"type": "string"
},
"body": {
"title": "Body",
"type": "string"
},
"default_key": {
"default": "",
"title": "Default Key",
"type": "string"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
},
"bpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"composer_credit": {
"default": "",
"title": "Composer Credit",
"type": "string"
},
"lyricist_credit": {
"default": "",
"title": "Lyricist Credit",
"type": "string"
},
"arranger_credit": {
"default": "",
"title": "Arranger Credit",
"type": "string"
},
"ccli_number": {
"default": "",
"title": "Ccli Number",
"type": "string"
},
"copyright": {
"default": "",
"title": "Copyright",
"type": "string"
},
"publisher_credit": {
"default": "",
"title": "Publisher Credit",
"type": "string"
},
"themes": {
"default": "",
"title": "Themes",
"type": "string"
},
"notes": {
"default": "",
"title": "Notes",
"type": "string"
},
"pdf_layout": {
"$ref": "#/components/schemas/PdfLayout"
},
"tags": {
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"archived_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Archived At"
},
"pc_last_scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pc Last Scheduled At"
},
"last_used_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Last Used At"
},
"next_planned_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Planned At"
},
"usage_count": {
"default": 0,
"title": "Usage Count",
"type": "integer"
},
"arrangements": {
"items": {
"$ref": "#/components/schemas/ArrangementSummaryOutput"
},
"title": "Arrangements",
"type": "array"
}
},
"required": [
"id",
"title",
"kind",
"language",
"author_credit",
"body",
"revision",
"updated_at"
],
"title": "MaterialOutput",
"type": "object"
}MaterialPickerOutput
{
"properties": {
"duration_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"kind": {
"enum": [
"lyrics",
"chords",
"score",
"song",
"spoken"
],
"title": "Kind",
"type": "string"
},
"author_credit": {
"title": "Author Credit",
"type": "string"
},
"default_key": {
"title": "Default Key",
"type": "string"
},
"available_keys": {
"items": {
"type": "string"
},
"title": "Available Keys",
"type": "array"
},
"pc_last_scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Pc Last Scheduled At"
},
"last_used_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Used At"
},
"next_planned_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Planned At"
}
},
"required": [
"id",
"title",
"kind",
"author_credit",
"default_key",
"available_keys",
"last_used_at",
"next_planned_at"
],
"title": "MaterialPickerOutput",
"type": "object"
}MaterialDeleteTarget
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
}
},
"required": [
"expected_revision",
"id"
],
"title": "MaterialDeleteTarget",
"type": "object"
}MaterialsDelete
{
"additionalProperties": false,
"properties": {
"materials": {
"items": {
"$ref": "#/components/schemas/MaterialDeleteTarget"
},
"maxItems": 1000,
"minItems": 1,
"title": "Materials",
"type": "array"
}
},
"required": [
"materials"
],
"title": "MaterialsDelete",
"type": "object"
}PdfExcerptOutput
{
"properties": {
"cached": {
"title": "Cached",
"type": "boolean"
},
"expected_size": {
"title": "Expected Size",
"type": "integer"
},
"sha256": {
"title": "Sha256",
"type": "string"
},
"original_pages": {
"items": {
"type": "integer"
},
"title": "Original Pages",
"type": "array"
}
},
"required": [
"cached",
"expected_size",
"sha256",
"original_pages"
],
"title": "PdfExcerptOutput",
"type": "object"
}PlanPreviewFileOutput
{
"properties": {
"preview": {
"anyOf": [
{
"$ref": "#/components/schemas/PdfExcerptOutput"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"filetype": {
"default": "",
"title": "Filetype",
"type": "string"
},
"display_name": {
"default": "",
"title": "Display Name",
"type": "string"
},
"category": {
"default": "",
"title": "Category",
"type": "string"
},
"pages": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Pages"
},
"start_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Seconds"
},
"end_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "End Seconds"
},
"filename": {
"title": "Filename",
"type": "string"
},
"expected_size": {
"title": "Expected Size",
"type": "integer"
},
"sha256": {
"title": "Sha256",
"type": "string"
},
"storage_kind": {
"default": "material",
"enum": [
"material",
"global"
],
"title": "Storage Kind",
"type": "string"
}
},
"required": [
"id",
"filename",
"expected_size",
"sha256"
],
"title": "PlanPreviewFileOutput",
"type": "object"
}PlanPreviewGlobalPageOutput
{
"properties": {
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"page_number": {
"title": "Page Number",
"type": "integer"
},
"position": {
"title": "Position",
"type": "integer"
}
},
"required": [
"file_id",
"filename",
"page_number",
"position"
],
"title": "PlanPreviewGlobalPageOutput",
"type": "object"
}PreviewPageState
{
"additionalProperties": false,
"properties": {
"display_mode": {
"default": "page",
"enum": [
"page",
"width",
"manual"
],
"title": "Display Mode",
"type": "string"
},
"zoom": {
"default": 1,
"maximum": 4,
"minimum": 0.15,
"title": "Zoom",
"type": "number"
},
"scroll_x": {
"default": 0,
"maximum": 1,
"minimum": 0,
"title": "Scroll X",
"type": "number"
},
"scroll_y": {
"default": 0,
"maximum": 1,
"minimum": 0,
"title": "Scroll Y",
"type": "number"
}
},
"title": "PreviewPageState",
"type": "object"
}PlanPreviewOutput
{
"properties": {
"item_id": {
"format": "uuid",
"title": "Item Id",
"type": "string"
},
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"body": {
"title": "Body",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"arrangement_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Arrangement Name"
},
"pdf_layout": {
"$ref": "#/components/schemas/PdfLayout"
},
"lyrics_available": {
"title": "Lyrics Available",
"type": "boolean"
},
"files": {
"items": {
"$ref": "#/components/schemas/PlanPreviewFileOutput"
},
"title": "Files",
"type": "array"
},
"global_pages": {
"items": {
"$ref": "#/components/schemas/PlanPreviewGlobalPageOutput"
},
"title": "Global Pages",
"type": "array"
},
"selected_source_kind": {
"enum": [
"lyrics",
"file"
],
"title": "Selected Source Kind",
"type": "string"
},
"selected_file_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Selected File Id"
},
"display_mode": {
"default": "page",
"enum": [
"page",
"width",
"manual"
],
"title": "Display Mode",
"type": "string"
},
"zoom": {
"default": 1,
"title": "Zoom",
"type": "number"
},
"page_states": {
"additionalProperties": {
"$ref": "#/components/schemas/PreviewPageState"
},
"title": "Page States",
"type": "object"
}
},
"required": [
"item_id",
"material_id",
"title",
"body",
"key",
"lyrics_available",
"files",
"selected_source_kind"
],
"title": "PlanPreviewOutput",
"type": "object"
}MaterialPreviewPreferenceOutput
{
"properties": {
"source_kind": {
"title": "Source Kind",
"type": "string"
},
"file_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "File Id"
},
"display_mode": {
"default": "page",
"title": "Display Mode",
"type": "string"
},
"zoom": {
"default": 1,
"title": "Zoom",
"type": "number"
},
"page_states": {
"additionalProperties": {
"additionalProperties": {
"$ref": "#/components/schemas/PreviewPageState"
},
"type": "object"
},
"title": "Page States",
"type": "object"
}
},
"required": [
"source_kind"
],
"title": "MaterialPreviewPreferenceOutput",
"type": "object"
}PlanPreviewPreferenceInput
{
"additionalProperties": false,
"properties": {
"display_mode": {
"default": "page",
"enum": [
"page",
"width",
"manual"
],
"title": "Display Mode",
"type": "string"
},
"zoom": {
"default": 1,
"maximum": 4,
"minimum": 0.15,
"title": "Zoom",
"type": "number"
},
"scroll_x": {
"default": 0,
"maximum": 1,
"minimum": 0,
"title": "Scroll X",
"type": "number"
},
"scroll_y": {
"default": 0,
"maximum": 1,
"minimum": 0,
"title": "Scroll Y",
"type": "number"
},
"source_kind": {
"enum": [
"lyrics",
"file"
],
"title": "Source Kind",
"type": "string"
},
"file_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "File Id"
},
"page_number": {
"anyOf": [
{
"maximum": 300,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Page Number"
}
},
"required": [
"source_kind"
],
"title": "PlanPreviewPreferenceInput",
"type": "object"
}MaterialDelete
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "MaterialDelete",
"type": "object"
}MaterialScheduleOutput
{
"properties": {
"event_id": {
"format": "uuid",
"title": "Event Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"starts_at": {
"format": "date-time",
"title": "Starts At",
"type": "string"
},
"published_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Published At"
},
"key": {
"title": "Key",
"type": "string"
},
"variant_name_snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Name Snapshot"
},
"position": {
"title": "Position",
"type": "integer"
}
},
"required": [
"event_id",
"title",
"starts_at",
"published_at",
"key",
"variant_name_snapshot",
"position"
],
"title": "MaterialScheduleOutput",
"type": "object"
}MaterialUpdate
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"update_future_items": {
"default": false,
"title": "Update Future Items",
"type": "boolean"
},
"title": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"author_credit": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Author Credit"
},
"body": {
"anyOf": [
{
"maxLength": 100000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"default_key": {
"anyOf": [
{
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Key"
},
"bpm": {
"anyOf": [
{
"maximum": 300,
"minimum": 20,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"anyOf": [
{
"maxLength": 12,
"pattern": "^$|^[1-9][0-9]?/[1248]$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Meter"
},
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"composer_credit": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Composer Credit"
},
"lyricist_credit": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Lyricist Credit"
},
"arranger_credit": {
"anyOf": [
{
"maxLength": 300,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Arranger Credit"
},
"ccli_number": {
"anyOf": [
{
"maxLength": 120,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ccli Number"
},
"copyright": {
"anyOf": [
{
"maxLength": 4000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Copyright"
},
"publisher_credit": {
"anyOf": [
{
"maxLength": 1000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Publisher Credit"
},
"themes": {
"anyOf": [
{
"maxLength": 4000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Themes"
},
"notes": {
"anyOf": [
{
"maxLength": 10000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Notes"
},
"tags": {
"anyOf": [
{
"items": {
"maxLength": 40,
"minLength": 1,
"type": "string"
},
"maxItems": 20,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Tags"
}
},
"required": [
"expected_revision"
],
"title": "MaterialUpdate",
"type": "object"
}PlannedUsageOutput
{
"properties": {
"planned_items": {
"title": "Planned Items",
"type": "integer"
},
"published_events": {
"title": "Published Events",
"type": "integer"
},
"draft_events": {
"title": "Draft Events",
"type": "integer"
}
},
"required": [
"planned_items",
"published_events",
"draft_events"
],
"title": "PlannedUsageOutput",
"type": "object"
}VariantOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"body": {
"title": "Body",
"type": "string"
},
"bpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Bpm"
},
"meter": {
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Duration Seconds"
},
"arranger_credit": {
"title": "Arranger Credit",
"type": "string"
},
"is_default": {
"title": "Is Default",
"type": "boolean"
},
"tags": {
"items": {
"type": "string"
},
"title": "Tags",
"type": "array"
},
"sequence": {
"items": {
"type": "string"
},
"title": "Sequence",
"type": "array"
},
"notes": {
"default": "",
"title": "Notes",
"type": "string"
},
"archived_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Archived At"
},
"source_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Id"
},
"original_lyrics": {
"default": "",
"title": "Original Lyrics",
"type": "string"
},
"original_chord_chart": {
"default": "",
"title": "Original Chord Chart",
"type": "string"
},
"chord_chart_key": {
"default": "",
"title": "Chord Chart Key",
"type": "string"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
}
},
"required": [
"id",
"material_id",
"name",
"key",
"body",
"bpm",
"meter",
"duration_seconds",
"arranger_credit",
"is_default",
"revision",
"updated_at"
],
"title": "VariantOutput",
"type": "object"
}VariantCreateInput
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"maximum": 300,
"minimum": 20,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"maxLength": 12,
"pattern": "^$|^[1-9][0-9]?/[1248]$",
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"arranger_credit": {
"default": "",
"maxLength": 300,
"title": "Arranger Credit",
"type": "string"
}
},
"required": [
"name"
],
"title": "VariantCreateInput",
"type": "object"
}VariantDelete
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "VariantDelete",
"type": "object"
}VariantDefaultInput
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "VariantDefaultInput",
"type": "object"
}VariantUpdate
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
},
"key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"maximum": 300,
"minimum": 20,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"maxLength": 12,
"pattern": "^$|^[1-9][0-9]?/[1248]$",
"title": "Meter",
"type": "string"
},
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"arranger_credit": {
"default": "",
"maxLength": 300,
"title": "Arranger Credit",
"type": "string"
},
"body": {
"default": "",
"maxLength": 100000,
"title": "Body",
"type": "string"
},
"sequence": {
"items": {
"maxLength": 80,
"minLength": 1,
"type": "string"
},
"maxItems": 200,
"title": "Sequence",
"type": "array"
},
"notes": {
"default": "",
"maxLength": 4000,
"title": "Notes",
"type": "string"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"update_future_items": {
"default": false,
"title": "Update Future Items",
"type": "boolean"
}
},
"required": [
"name",
"expected_revision"
],
"title": "VariantUpdate",
"type": "object"
}EventOutput
{
"properties": {
"source_template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Source Template Id"
},
"reminders_enabled": {
"default": false,
"title": "Reminders Enabled",
"type": "boolean"
},
"schedule_only": {
"default": false,
"title": "Schedule Only",
"type": "boolean"
},
"squad_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Name"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"responsible_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Responsible Member Id"
},
"capabilities": {
"anyOf": [
{
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Capabilities"
},
"program_duration_seconds": {
"default": 0,
"title": "Program Duration Seconds",
"type": "integer"
},
"untimed_items": {
"default": 0,
"title": "Untimed Items",
"type": "integer"
},
"my_status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "My Status"
},
"my_person_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "My Person Id"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"event_type_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Event Type Id"
},
"title": {
"title": "Title",
"type": "string"
},
"starts_at": {
"format": "date-time",
"title": "Starts At",
"type": "string"
},
"published_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Published At"
},
"series_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Series Id"
},
"occurrence_index": {
"default": 0,
"title": "Occurrence Index",
"type": "integer"
},
"recurrence": {
"default": "none",
"title": "Recurrence",
"type": "string"
},
"timezone": {
"default": "UTC",
"title": "Timezone",
"type": "string"
},
"duration_minutes": {
"default": 120,
"title": "Duration Minutes",
"type": "integer"
},
"revision": {
"default": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"title",
"starts_at",
"published_at"
],
"title": "EventOutput",
"type": "object"
}EventInput
{
"additionalProperties": false,
"properties": {
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"title": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"starts_at": {
"format": "date-time",
"title": "Starts At",
"type": "string"
},
"event_type_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Event Type Id"
},
"template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Template Id"
},
"recurrence": {
"default": "none",
"enum": [
"none",
"weekly",
"biweekly",
"monthly"
],
"title": "Recurrence",
"type": "string"
},
"occurrences": {
"default": 1,
"maximum": 52,
"minimum": 1,
"title": "Occurrences",
"type": "integer"
},
"timezone": {
"default": "UTC",
"maxLength": 64,
"minLength": 1,
"title": "Timezone",
"type": "string"
},
"duration_minutes": {
"anyOf": [
{
"maximum": 1440,
"minimum": 15,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Minutes"
}
},
"required": [
"starts_at"
],
"title": "EventInput",
"type": "object"
}EventTypeOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"default_template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Template Id"
}
},
"required": [
"id",
"name"
],
"title": "EventTypeOutput",
"type": "object"
}EventTypeInput
{
"additionalProperties": false,
"properties": {
"default_template_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Default Template Id"
},
"name": {
"maxLength": 80,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "EventTypeInput",
"type": "object"
}TemplateInput
{
"additionalProperties": false,
"properties": {
"duration_minutes": {
"anyOf": [
{
"maximum": 1440,
"minimum": 15,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Minutes"
},
"is_default": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Is Default"
},
"expected_revision": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Expected Revision"
},
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"name": {
"maxLength": 120,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "TemplateInput",
"type": "object"
}TemplatePersonOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"member_id": {
"format": "uuid",
"title": "Member Id",
"type": "string"
},
"display_name": {
"title": "Display Name",
"type": "string"
},
"section_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Section Id"
},
"section_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Section Name"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Position Id"
},
"position_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Position Name"
}
},
"required": [
"id",
"member_id",
"display_name",
"section_id",
"section_name",
"position_id",
"position_name"
],
"title": "TemplatePersonOutput",
"type": "object"
}EventPersonUpdate
{
"additionalProperties": false,
"properties": {
"section_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Section Id"
},
"position_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Position Id"
}
},
"title": "EventPersonUpdate",
"type": "object"
}ItemOutput
{
"properties": {
"note_pdf_layout": {
"$ref": "#/components/schemas/PdfLayout"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"material_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Material Id"
},
"item_type": {
"default": "material",
"enum": [
"material",
"section",
"note"
],
"title": "Item Type",
"type": "string"
},
"position": {
"title": "Position",
"type": "integer"
},
"key": {
"title": "Key",
"type": "string"
},
"material_revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Material Revision"
},
"title_snapshot": {
"title": "Title Snapshot",
"type": "string"
},
"body_snapshot": {
"title": "Body Snapshot",
"type": "string"
},
"bpm_snapshot": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm Snapshot"
},
"meter_snapshot": {
"default": "",
"title": "Meter Snapshot",
"type": "string"
},
"duration_seconds_snapshot": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds Snapshot"
},
"manual_duration_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Manual Duration Seconds"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"variant_revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Revision"
},
"variant_name_snapshot": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Name Snapshot"
},
"lyrics_available": {
"default": false,
"title": "Lyrics Available",
"type": "boolean"
},
"pdf_available": {
"default": false,
"title": "Pdf Available",
"type": "boolean"
}
},
"required": [
"id",
"material_id",
"position",
"key",
"material_revision",
"title_snapshot",
"body_snapshot"
],
"title": "ItemOutput",
"type": "object"
}PlanItemInput
{
"additionalProperties": false,
"properties": {
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"material_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Material Id"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"item_type": {
"default": "material",
"enum": [
"material",
"section",
"note"
],
"title": "Item Type",
"type": "string"
},
"title": {
"default": "",
"maxLength": 200,
"title": "Title",
"type": "string"
},
"body": {
"default": "",
"maxLength": 100000,
"title": "Body",
"type": "string"
},
"position": {
"maximum": 1000,
"minimum": 0,
"title": "Position",
"type": "integer"
},
"key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Key",
"type": "string"
}
},
"required": [
"position"
],
"title": "PlanItemInput",
"type": "object"
}BulkSongsOutput
{
"properties": {
"count": {
"title": "Count",
"type": "integer"
}
},
"required": [
"count"
],
"title": "BulkSongsOutput",
"type": "object"
}BulkSongChoice
{
"additionalProperties": false,
"properties": {
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Key",
"type": "string"
}
},
"required": [
"material_id"
],
"title": "BulkSongChoice",
"type": "object"
}BulkSongsInput
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BulkSongChoice"
},
"maxItems": 500,
"minItems": 1,
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "BulkSongsInput",
"type": "object"
}ItemOrder
{
"additionalProperties": false,
"properties": {
"item_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 1000,
"minItems": 1,
"title": "Item Ids",
"type": "array"
}
},
"required": [
"item_ids"
],
"title": "ItemOrder",
"type": "object"
}EventDeleteTarget
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
}
},
"required": [
"expected_revision",
"id"
],
"title": "EventDeleteTarget",
"type": "object"
}EventsDelete
{
"additionalProperties": false,
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/EventDeleteTarget"
},
"maxItems": 1000,
"minItems": 1,
"title": "Events",
"type": "array"
}
},
"required": [
"events"
],
"title": "EventsDelete",
"type": "object"
}EventDelete
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "EventDelete",
"type": "object"
}EventUpdate
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"title": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"starts_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Starts At"
},
"duration_minutes": {
"anyOf": [
{
"maximum": 1440,
"minimum": 15,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Minutes"
},
"event_type_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Event Type Id"
}
},
"required": [
"expected_revision"
],
"title": "EventUpdate",
"type": "object"
}EventRecurrenceInput
{
"additionalProperties": false,
"properties": {
"recurrence": {
"enum": [
"weekly",
"biweekly",
"monthly"
],
"title": "Recurrence",
"type": "string"
},
"occurrences": {
"maximum": 52,
"minimum": 2,
"title": "Occurrences",
"type": "integer"
},
"timezone": {
"default": "UTC",
"maxLength": 64,
"minLength": 1,
"title": "Timezone",
"type": "string"
}
},
"required": [
"recurrence",
"occurrences"
],
"title": "EventRecurrenceInput",
"type": "object"
}AnnotationOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"source_key": {
"title": "Source Key",
"type": "string"
},
"page_number": {
"title": "Page Number",
"type": "integer"
},
"kind": {
"enum": [
"text",
"emoji",
"ink"
],
"title": "Kind",
"type": "string"
},
"visibility": {
"enum": [
"private",
"shared"
],
"title": "Visibility",
"type": "string"
},
"payload": {
"additionalProperties": true,
"title": "Payload",
"type": "object"
},
"author_id": {
"format": "uuid",
"title": "Author Id",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
}
},
"required": [
"id",
"source_key",
"page_number",
"kind",
"visibility",
"payload",
"author_id",
"created_at"
],
"title": "AnnotationOutput",
"type": "object"
}AnnotationInput
{
"additionalProperties": false,
"properties": {
"source_key": {
"maxLength": 80,
"pattern": "^(lyrics|file:[0-9a-fA-F-]{36})$",
"title": "Source Key",
"type": "string"
},
"page_number": {
"maximum": 1000,
"minimum": 1,
"title": "Page Number",
"type": "integer"
},
"kind": {
"enum": [
"text",
"emoji",
"ink"
],
"title": "Kind",
"type": "string"
},
"visibility": {
"default": "private",
"enum": [
"private",
"shared"
],
"title": "Visibility",
"type": "string"
},
"x": {
"maximum": 1,
"minimum": 0,
"title": "X",
"type": "number"
},
"y": {
"maximum": 1,
"minimum": 0,
"title": "Y",
"type": "number"
},
"size": {
"default": 0.035,
"maximum": 0.2,
"minimum": 0.005,
"title": "Size",
"type": "number"
},
"text": {
"default": "",
"maxLength": 300,
"title": "Text",
"type": "string"
},
"points": {
"items": {
"maxItems": 2,
"minItems": 2,
"prefixItems": [
{
"type": "number"
},
{
"type": "number"
}
],
"type": "array"
},
"maxItems": 3000,
"title": "Points",
"type": "array"
},
"color": {
"default": "#5146bf",
"pattern": "^#[0-9a-fA-F]{6}$",
"title": "Color",
"type": "string"
}
},
"required": [
"source_key",
"page_number",
"kind",
"x",
"y"
],
"title": "AnnotationInput",
"type": "object"
}AnnotationVisibility
{
"additionalProperties": false,
"properties": {
"visibility": {
"enum": [
"private",
"shared"
],
"title": "Visibility",
"type": "string"
}
},
"required": [
"visibility"
],
"title": "AnnotationVisibility",
"type": "object"
}ItemDurationInput
{
"additionalProperties": false,
"properties": {
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
}
},
"title": "ItemDurationInput",
"type": "object"
}PlanItemUpdate
{
"additionalProperties": false,
"properties": {
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"key": {
"default": "",
"maxLength": 12,
"pattern": "^([A-H](#|b|♯|♭)?m?)?$",
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"maximum": 300,
"minimum": 20,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"maxLength": 12,
"pattern": "^$|^[1-9][0-9]?/[1248]$",
"title": "Meter",
"type": "string"
}
},
"title": "PlanItemUpdate",
"type": "object"
}NoteViewOutput
{
"properties": {
"last_page": {
"default": 1,
"title": "Last Page",
"type": "integer"
},
"page_states": {
"additionalProperties": {
"$ref": "#/components/schemas/PreviewPageState"
},
"title": "Page States",
"type": "object"
}
},
"title": "NoteViewOutput",
"type": "object"
}NoteViewInput
{
"additionalProperties": false,
"properties": {
"display_mode": {
"default": "page",
"enum": [
"page",
"width",
"manual"
],
"title": "Display Mode",
"type": "string"
},
"zoom": {
"default": 1,
"maximum": 4,
"minimum": 0.15,
"title": "Zoom",
"type": "number"
},
"scroll_x": {
"default": 0,
"maximum": 1,
"minimum": 0,
"title": "Scroll X",
"type": "number"
},
"scroll_y": {
"default": 0,
"maximum": 1,
"minimum": 0,
"title": "Scroll Y",
"type": "number"
},
"page_number": {
"maximum": 1000,
"minimum": 1,
"title": "Page Number",
"type": "integer"
}
},
"required": [
"page_number"
],
"title": "NoteViewInput",
"type": "object"
}NoteUpdate
{
"additionalProperties": false,
"properties": {
"title": {
"anyOf": [
{
"maxLength": 200,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Title"
},
"body": {
"anyOf": [
{
"maxLength": 100000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Body"
},
"pdf_layout": {
"anyOf": [
{
"$ref": "#/components/schemas/PdfLayout"
},
{
"type": "null"
}
],
"default": null
}
},
"title": "NoteUpdate",
"type": "object"
}PlanPrice
{
"properties": {
"plan": {
"enum": [
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan",
"type": "string"
},
"interval": {
"enum": [
"month",
"year"
],
"title": "Interval",
"type": "string"
},
"amount_minor": {
"title": "Amount Minor",
"type": "integer"
},
"currency": {
"title": "Currency",
"type": "string"
}
},
"required": [
"plan",
"interval",
"amount_minor",
"currency"
],
"title": "PlanPrice",
"type": "object"
}SubscriptionOutput
{
"properties": {
"seat_limit": {
"title": "Seat Limit",
"type": "integer"
},
"active_members": {
"title": "Active Members",
"type": "integer"
},
"paid_until": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Paid Until"
},
"plan_code": {
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan Code",
"type": "string"
},
"billing_account": {
"title": "Billing Account",
"type": "boolean"
},
"stripe_active": {
"title": "Stripe Active",
"type": "boolean"
},
"granted_seats": {
"title": "Granted Seats",
"type": "integer"
},
"stripe_period_end": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Stripe Period End"
},
"pending_plan_code": {
"anyOf": [
{
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Pending Plan Code"
},
"pending_from": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Pending From"
},
"billing_interval": {
"anyOf": [
{
"enum": [
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Billing Interval"
},
"pending_interval": {
"anyOf": [
{
"enum": [
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Pending Interval"
},
"prices": {
"items": {
"$ref": "#/components/schemas/PlanPrice"
},
"title": "Prices",
"type": "array"
},
"payments_enabled": {
"title": "Payments Enabled",
"type": "boolean"
}
},
"required": [
"seat_limit",
"active_members",
"paid_until",
"plan_code",
"billing_account",
"stripe_active",
"granted_seats",
"stripe_period_end",
"pending_plan_code",
"pending_from",
"billing_interval",
"pending_interval",
"prices",
"payments_enabled"
],
"title": "SubscriptionOutput",
"type": "object"
}CheckoutSessionOutput
{
"properties": {
"url": {
"title": "Url",
"type": "string"
}
},
"required": [
"url"
],
"title": "CheckoutSessionOutput",
"type": "object"
}CheckoutInput
{
"additionalProperties": false,
"properties": {
"plan": {
"enum": [
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan",
"type": "string"
},
"interval": {
"default": "month",
"enum": [
"month",
"year"
],
"title": "Interval",
"type": "string"
}
},
"required": [
"plan"
],
"title": "CheckoutInput",
"type": "object"
}PlanChangeOutput
{
"properties": {
"plan_code": {
"enum": [
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan Code",
"type": "string"
},
"interval": {
"enum": [
"month",
"year"
],
"title": "Interval",
"type": "string"
},
"pending_plan_code": {
"anyOf": [
{
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Pending Plan Code"
},
"pending_interval": {
"anyOf": [
{
"enum": [
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Pending Interval"
},
"pending_from": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Pending From"
}
},
"required": [
"plan_code",
"interval",
"pending_plan_code",
"pending_interval",
"pending_from"
],
"title": "PlanChangeOutput",
"type": "object"
}PlanChangeInput
{
"additionalProperties": false,
"properties": {
"plan": {
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan",
"type": "string"
},
"interval": {
"anyOf": [
{
"enum": [
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Interval"
},
"proration_date": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Proration Date"
}
},
"required": [
"plan"
],
"title": "PlanChangeInput",
"type": "object"
}PlanChangePreview
{
"properties": {
"plan_code": {
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan Code",
"type": "string"
},
"interval": {
"enum": [
"month",
"year"
],
"title": "Interval",
"type": "string"
},
"kind": {
"enum": [
"upgrade",
"downgrade",
"keep"
],
"title": "Kind",
"type": "string"
},
"amount_due": {
"title": "Amount Due",
"type": "integer"
},
"credit": {
"title": "Credit",
"type": "integer"
},
"currency": {
"title": "Currency",
"type": "string"
},
"recurring_amount": {
"title": "Recurring Amount",
"type": "integer"
},
"proration_date": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Proration Date"
},
"effective_from": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Effective From"
}
},
"required": [
"plan_code",
"interval",
"kind",
"amount_due",
"credit",
"currency",
"recurring_amount",
"proration_date",
"effective_from"
],
"title": "PlanChangePreview",
"type": "object"
}PlanTargetInput
{
"additionalProperties": false,
"properties": {
"plan": {
"enum": [
"trio",
"combo",
"stage",
"festival",
"arena"
],
"title": "Plan",
"type": "string"
},
"interval": {
"anyOf": [
{
"enum": [
"month",
"year"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Interval"
}
},
"required": [
"plan"
],
"title": "PlanTargetInput",
"type": "object"
}ProductOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"kind": {
"title": "Kind",
"type": "string"
},
"language": {
"title": "Language",
"type": "string"
},
"preview": {
"title": "Preview",
"type": "string"
},
"publisher_name": {
"title": "Publisher Name",
"type": "string"
}
},
"required": [
"id",
"title",
"kind",
"language",
"preview",
"publisher_name"
],
"title": "ProductOutput",
"type": "object"
}FileSongDraft
{
"additionalProperties": false,
"properties": {
"bpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"meter": {
"default": "",
"title": "Meter",
"type": "string"
},
"default_key": {
"default": "",
"title": "Default Key",
"type": "string"
},
"author_credit": {
"default": "",
"title": "Author Credit",
"type": "string"
},
"copyright": {
"default": "",
"title": "Copyright",
"type": "string"
},
"ccli_number": {
"default": "",
"title": "Ccli Number",
"type": "string"
},
"notes": {
"default": "",
"title": "Notes",
"type": "string"
},
"review_chords": {
"default": false,
"title": "Review Chords",
"type": "boolean"
},
"pdf_layout": {
"anyOf": [
{
"$ref": "#/components/schemas/PdfLayout"
},
{
"type": "null"
}
],
"default": null
},
"title": {
"title": "Title",
"type": "string"
},
"body": {
"title": "Body",
"type": "string"
},
"method": {
"title": "Method",
"type": "string"
},
"empty": {
"title": "Empty",
"type": "boolean"
},
"truncated": {
"title": "Truncated",
"type": "boolean"
}
},
"required": [
"title",
"body",
"method",
"empty",
"truncated"
],
"title": "FileSongDraft",
"type": "object"
}FileSongPreview
{
"additionalProperties": false,
"properties": {
"pages": {
"anyOf": [
{
"items": {
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
"maxItems": 20,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Pages"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"page": {
"anyOf": [
{
"maximum": 1000,
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Page"
},
"metadata_only": {
"default": false,
"title": "Metadata Only",
"type": "boolean"
},
"whole_file": {
"default": false,
"title": "Whole File",
"type": "boolean"
}
},
"required": [
"file_id"
],
"title": "FileSongPreview",
"type": "object"
}GlobalFileOutput
{
"properties": {
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"responsible_member_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Responsible Member Id"
},
"capabilities": {
"anyOf": [
{
"additionalProperties": {
"type": "boolean"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Capabilities"
},
"created_by": {
"format": "uuid",
"title": "Created By",
"type": "string"
},
"created_by_name": {
"title": "Created By Name",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"filename": {
"title": "Filename",
"type": "string"
},
"filetype": {
"title": "Filetype",
"type": "string"
},
"expected_size": {
"title": "Expected Size",
"type": "integer"
},
"uploaded_size": {
"title": "Uploaded Size",
"type": "integer"
},
"description": {
"default": "",
"title": "Description",
"type": "string"
},
"category": {
"default": "",
"title": "Category",
"type": "string"
},
"captured_on": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Captured On"
},
"tags": {
"default": "",
"title": "Tags",
"type": "string"
},
"sha256": {
"title": "Sha256",
"type": "string"
},
"status": {
"enum": [
"pending",
"ready",
"error",
"deleted"
],
"title": "Status",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
},
"thumbnail": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Thumbnail"
}
},
"required": [
"created_by",
"created_by_name",
"id",
"filename",
"filetype",
"expected_size",
"uploaded_size",
"sha256",
"status",
"created_at",
"updated_at"
],
"title": "GlobalFileOutput",
"type": "object"
}GlobalFileCreate
{
"additionalProperties": false,
"properties": {
"squad_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Squad Id"
},
"library_visible": {
"default": true,
"title": "Library Visible",
"type": "boolean"
},
"filename": {
"maxLength": 255,
"minLength": 1,
"title": "Filename",
"type": "string"
},
"filetype": {
"default": "application/pdf",
"maxLength": 120,
"title": "Filetype",
"type": "string"
},
"expected_size": {
"exclusiveMinimum": 0,
"maximum": 536870912,
"title": "Expected Size",
"type": "integer"
},
"description": {
"default": "",
"maxLength": 2000,
"title": "Description",
"type": "string"
},
"category": {
"default": "",
"maxLength": 80,
"title": "Category",
"type": "string"
},
"captured_on": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Captured On"
},
"tags": {
"default": "",
"maxLength": 500,
"title": "Tags",
"type": "string"
}
},
"required": [
"filename",
"expected_size"
],
"title": "GlobalFileCreate",
"type": "object"
}GlobalFileUpdate
{
"additionalProperties": false,
"properties": {
"filename": {
"maxLength": 255,
"minLength": 1,
"title": "Filename",
"type": "string"
},
"filetype": {
"default": "application/pdf",
"maxLength": 120,
"title": "Filetype",
"type": "string"
},
"description": {
"default": "",
"maxLength": 2000,
"title": "Description",
"type": "string"
},
"category": {
"default": "",
"maxLength": 80,
"title": "Category",
"type": "string"
},
"captured_on": {
"anyOf": [
{
"format": "date",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Captured On"
},
"tags": {
"default": "",
"maxLength": 500,
"title": "Tags",
"type": "string"
}
},
"required": [
"filename"
],
"title": "GlobalFileUpdate",
"type": "object"
}GlobalFileChunk
{
"additionalProperties": false,
"properties": {
"offset": {
"minimum": 0,
"title": "Offset",
"type": "integer"
},
"data": {
"minLength": 1,
"title": "Data",
"type": "string"
}
},
"required": [
"offset",
"data"
],
"title": "GlobalFileChunk",
"type": "object"
}GlobalFileComplete
{
"additionalProperties": false,
"properties": {
"sha256": {
"anyOf": [
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Sha256"
}
},
"title": "GlobalFileComplete",
"type": "object"
}GlobalFileThumbnail
{
"additionalProperties": false,
"properties": {
"image": {
"anyOf": [
{
"maxLength": 270000,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Image"
}
},
"title": "GlobalFileThumbnail",
"type": "object"
}MaterialMediaOutput
{
"properties": {
"display_name": {
"title": "Display Name",
"type": "string"
},
"author_credit": {
"title": "Author Credit",
"type": "string"
},
"description": {
"title": "Description",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Id"
},
"pages": {
"anyOf": [
{
"items": {
"type": "integer"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Pages"
},
"start_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Start Seconds"
},
"end_seconds": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "End Seconds"
},
"filename": {
"title": "Filename",
"type": "string"
},
"filetype": {
"title": "Filetype",
"type": "string"
},
"expected_size": {
"title": "Expected Size",
"type": "integer"
},
"sha256": {
"title": "Sha256",
"type": "string"
}
},
"required": [
"display_name",
"author_credit",
"description",
"id",
"file_id",
"variant_id",
"pages",
"start_seconds",
"end_seconds",
"filename",
"filetype",
"expected_size",
"sha256"
],
"title": "MaterialMediaOutput",
"type": "object"
}MaterialMediaInput
{
"additionalProperties": false,
"properties": {
"display_name": {
"default": "",
"maxLength": 300,
"title": "Display Name",
"type": "string"
},
"author_credit": {
"default": "",
"maxLength": 300,
"title": "Author Credit",
"type": "string"
},
"description": {
"default": "",
"maxLength": 4000,
"title": "Description",
"type": "string"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"pages": {
"anyOf": [
{
"items": {
"type": "integer"
},
"maxItems": 1000,
"minItems": 1,
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Pages"
},
"start_seconds": {
"anyOf": [
{
"maximum": 604800,
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Start Seconds"
},
"end_seconds": {
"anyOf": [
{
"exclusiveMinimum": 0,
"maximum": 604800,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "End Seconds"
}
},
"required": [
"file_id"
],
"title": "MaterialMediaInput",
"type": "object"
}MediaLinkUpdate
{
"additionalProperties": false,
"properties": {
"display_name": {
"default": "",
"maxLength": 300,
"title": "Display Name",
"type": "string"
},
"author_credit": {
"default": "",
"maxLength": 300,
"title": "Author Credit",
"type": "string"
},
"description": {
"default": "",
"maxLength": 4000,
"title": "Description",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
}
},
"title": "MediaLinkUpdate",
"type": "object"
}AttachmentDetails
{
"additionalProperties": false,
"properties": {
"display_name": {
"default": "",
"maxLength": 300,
"title": "Display Name",
"type": "string"
},
"author_credit": {
"default": "",
"maxLength": 300,
"title": "Author Credit",
"type": "string"
},
"description": {
"default": "",
"maxLength": 4000,
"title": "Description",
"type": "string"
}
},
"title": "AttachmentDetails",
"type": "object"
}GlobalFilePageOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"page_number": {
"title": "Page Number",
"type": "integer"
},
"position": {
"title": "Position",
"type": "integer"
}
},
"required": [
"id",
"file_id",
"page_number",
"position"
],
"title": "GlobalFilePageOutput",
"type": "object"
}GlobalFilePagesInput
{
"additionalProperties": false,
"properties": {
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"pages": {
"items": {
"type": "integer"
},
"maxItems": 300,
"minItems": 1,
"title": "Pages",
"type": "array"
}
},
"required": [
"file_id",
"pages"
],
"title": "GlobalFilePagesInput",
"type": "object"
}LicenseOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"version_id": {
"format": "uuid",
"title": "Version Id",
"type": "string"
},
"terms_version": {
"title": "Terms Version",
"type": "string"
},
"can_export": {
"title": "Can Export",
"type": "boolean"
},
"can_transpose": {
"title": "Can Transpose",
"type": "boolean"
},
"expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At"
}
},
"required": [
"id",
"title",
"version_id",
"terms_version",
"can_export",
"can_transpose",
"expires_at"
],
"title": "LicenseOutput",
"type": "object"
}LicensedContentOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"version_id": {
"format": "uuid",
"title": "Version Id",
"type": "string"
},
"terms_version": {
"title": "Terms Version",
"type": "string"
},
"can_export": {
"title": "Can Export",
"type": "boolean"
},
"can_transpose": {
"title": "Can Transpose",
"type": "boolean"
},
"expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Expires At"
},
"body": {
"title": "Body",
"type": "string"
},
"terms": {
"title": "Terms",
"type": "string"
}
},
"required": [
"id",
"title",
"version_id",
"terms_version",
"can_export",
"can_transpose",
"expires_at",
"body",
"terms"
],
"title": "LicensedContentOutput",
"type": "object"
}InvitationPreview
{
"properties": {
"team_name": {
"title": "Team Name",
"type": "string"
},
"email": {
"title": "Email",
"type": "string"
},
"account_exists": {
"title": "Account Exists",
"type": "boolean"
}
},
"required": [
"team_name",
"email",
"account_exists"
],
"title": "InvitationPreview",
"type": "object"
}InvitationRegistration
{
"additionalProperties": false,
"properties": {
"email": {
"format": "email",
"title": "Email",
"type": "string"
},
"display_name": {
"maxLength": 120,
"minLength": 1,
"title": "Display Name",
"type": "string"
},
"password": {
"maxLength": 1024,
"minLength": 12,
"title": "Password",
"type": "string"
},
"locale": {
"default": "pl",
"enum": [
"pl",
"en",
"sk",
"cs",
"hu",
"de",
"fr"
],
"title": "Locale",
"type": "string"
},
"token": {
"maxLength": 128,
"minLength": 32,
"title": "Token",
"type": "string"
}
},
"required": [
"email",
"display_name",
"password",
"token"
],
"title": "InvitationRegistration",
"type": "object"
}PlaybackTitleEntry
{
"additionalProperties": false,
"properties": {
"setlist_song_id": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"title": "Setlist Song Id",
"type": "integer"
},
"title": {
"maxLength": 256,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"setlist_song_id",
"title"
],
"title": "PlaybackTitleEntry",
"type": "object"
}PlaybackTitleCacheOutput
{
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PlaybackTitleEntry"
},
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "PlaybackTitleCacheOutput",
"type": "object"
}PlaybackTitleQuery
{
"additionalProperties": false,
"properties": {
"setlist_id": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"title": "Setlist Id",
"type": "integer"
}
},
"required": [
"setlist_id"
],
"title": "PlaybackTitleQuery",
"type": "object"
}PlaybackTitleCacheWrite
{
"additionalProperties": false,
"properties": {
"setlist_id": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"title": "Setlist Id",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/PlaybackTitleEntry"
},
"maxItems": 2000,
"minItems": 1,
"title": "Items",
"type": "array"
}
},
"required": [
"setlist_id",
"items"
],
"title": "PlaybackTitleCacheWrite",
"type": "object"
}PlaybackConfigOutput
{
"properties": {
"broadcast_enabled": {
"title": "Broadcast Enabled",
"type": "boolean"
},
"broadcast_play": {
"title": "Broadcast Play",
"type": "boolean"
},
"broadcast_stop": {
"title": "Broadcast Stop",
"type": "boolean"
},
"broadcast_song_change": {
"title": "Broadcast Song Change",
"type": "boolean"
}
},
"required": [
"broadcast_enabled",
"broadcast_play",
"broadcast_stop",
"broadcast_song_change"
],
"title": "PlaybackConfigOutput",
"type": "object"
}PlaybackSessionSummary
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"event_id": {
"format": "uuid",
"title": "Event Id",
"type": "string"
},
"event_title": {
"title": "Event Title",
"type": "string"
},
"device_name": {
"title": "Device Name",
"type": "string"
},
"started_at": {
"format": "date-time",
"title": "Started At",
"type": "string"
},
"last_seen_at": {
"format": "date-time",
"title": "Last Seen At",
"type": "string"
},
"playback_connected": {
"title": "Playback Connected",
"type": "boolean"
},
"fresh": {
"title": "Fresh",
"type": "boolean"
},
"last_error": {
"title": "Last Error",
"type": "string"
}
},
"required": [
"id",
"event_id",
"event_title",
"device_name",
"started_at",
"last_seen_at",
"playback_connected",
"fresh",
"last_error"
],
"title": "PlaybackSessionSummary",
"type": "object"
}PlaybackIntegrationOutput
{
"properties": {
"configured": {
"title": "Configured",
"type": "boolean"
},
"status": {
"enum": [
"none",
"pairing",
"configured",
"live",
"disconnected",
"error"
],
"title": "Status",
"type": "string"
},
"config": {
"anyOf": [
{
"$ref": "#/components/schemas/PlaybackConfigOutput"
},
{
"type": "null"
}
]
},
"pairing_state": {
"title": "Pairing State",
"type": "string"
},
"paired_device_name": {
"title": "Paired Device Name",
"type": "string"
},
"paired_by_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Paired By Name"
},
"paired_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Paired At"
},
"last_error": {
"title": "Last Error",
"type": "string"
},
"last_error_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Error At"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"session": {
"anyOf": [
{
"$ref": "#/components/schemas/PlaybackSessionSummary"
},
{
"type": "null"
}
]
},
"stale_after_seconds": {
"title": "Stale After Seconds",
"type": "integer"
},
"playback_write_supported": {
"title": "Playback Write Supported",
"type": "boolean"
}
},
"required": [
"configured",
"status",
"config",
"pairing_state",
"paired_device_name",
"paired_by_name",
"paired_at",
"last_error",
"last_error_at",
"revision",
"session",
"stale_after_seconds",
"playback_write_supported"
],
"title": "PlaybackIntegrationOutput",
"type": "object"
}PlaybackConfig
{
"additionalProperties": false,
"properties": {
"broadcast_enabled": {
"title": "Broadcast Enabled",
"type": "boolean"
},
"broadcast_play": {
"title": "Broadcast Play",
"type": "boolean"
},
"broadcast_stop": {
"title": "Broadcast Stop",
"type": "boolean"
},
"broadcast_song_change": {
"title": "Broadcast Song Change",
"type": "boolean"
}
},
"required": [
"broadcast_enabled",
"broadcast_play",
"broadcast_stop",
"broadcast_song_change"
],
"title": "PlaybackConfig",
"type": "object"
}PlaybackPairing
{
"additionalProperties": false,
"properties": {
"state": {
"enum": [
"started",
"completed",
"failed"
],
"title": "State",
"type": "string"
},
"device_name": {
"maxLength": 120,
"minLength": 1,
"title": "Device Name",
"type": "string"
},
"error_code": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"pattern": "^[a-z0-9_]+$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
}
},
"required": [
"state",
"device_name"
],
"title": "PlaybackPairing",
"type": "object"
}PlaybackSessionStartOutput
{
"properties": {
"session_id": {
"format": "uuid",
"title": "Session Id",
"type": "string"
},
"session_token": {
"title": "Session Token",
"type": "string"
},
"config": {
"$ref": "#/components/schemas/PlaybackConfigOutput"
},
"stale_after_seconds": {
"title": "Stale After Seconds",
"type": "integer"
}
},
"required": [
"session_id",
"session_token",
"config",
"stale_after_seconds"
],
"title": "PlaybackSessionStartOutput",
"type": "object"
}PlaybackSessionStart
{
"additionalProperties": false,
"properties": {
"event_id": {
"format": "uuid",
"title": "Event Id",
"type": "string"
},
"device_name": {
"maxLength": 120,
"minLength": 1,
"title": "Device Name",
"type": "string"
},
"takeover": {
"default": false,
"title": "Takeover",
"type": "boolean"
}
},
"required": [
"event_id",
"device_name"
],
"title": "PlaybackSessionStart",
"type": "object"
}PlaybackReportOutput
{
"properties": {
"accepted": {
"title": "Accepted",
"type": "boolean"
},
"duplicate": {
"title": "Duplicate",
"type": "boolean"
},
"ended": {
"title": "Ended",
"type": "boolean"
},
"ended_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Ended Reason"
},
"config": {
"$ref": "#/components/schemas/PlaybackConfigOutput"
}
},
"required": [
"accepted",
"duplicate",
"ended",
"ended_reason",
"config"
],
"title": "PlaybackReportOutput",
"type": "object"
}PlaybackLiveEvent
{
"additionalProperties": false,
"properties": {
"type": {
"enum": [
"play",
"stop",
"song_change"
],
"title": "Type",
"type": "string"
},
"setlist_song_id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Setlist Song Id"
},
"occurred_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Occurred At"
}
},
"required": [
"type"
],
"title": "PlaybackLiveEvent",
"type": "object"
}PlaybackLiveState
{
"additionalProperties": false,
"properties": {
"setlist_song_id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Setlist Song Id"
},
"playing": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Playing"
},
"position_seconds": {
"anyOf": [
{
"maximum": 86400,
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Position Seconds"
}
},
"title": "PlaybackLiveState",
"type": "object"
}PlaybackSetlist
{
"additionalProperties": false,
"properties": {
"setlist_id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Setlist Id"
},
"name": {
"default": "",
"maxLength": 200,
"title": "Name",
"type": "string"
},
"version": {
"default": 0,
"minimum": 0,
"title": "Version",
"type": "integer"
},
"items": {
"items": {
"$ref": "#/components/schemas/PlaybackSetlistEntry"
},
"maxItems": 200,
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "PlaybackSetlist",
"type": "object"
}PlaybackSetlistEntry
{
"additionalProperties": false,
"properties": {
"setlist_song_id": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"title": "Setlist Song Id",
"type": "integer"
},
"content_id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Id"
},
"title": {
"default": "",
"maxLength": 200,
"title": "Title",
"type": "string"
},
"artist": {
"default": "",
"maxLength": 200,
"title": "Artist",
"type": "string"
},
"key": {
"default": "",
"maxLength": 12,
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"maximum": 400,
"minimum": 0,
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"duration_seconds": {
"anyOf": [
{
"maximum": 14400,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
}
},
"required": [
"setlist_song_id"
],
"title": "PlaybackSetlistEntry",
"type": "object"
}PlaybackReport
{
"additionalProperties": false,
"properties": {
"session_token": {
"maxLength": 128,
"minLength": 32,
"title": "Session Token",
"type": "string"
},
"seq": {
"maximum": 9007199254740991,
"minimum": 1,
"title": "Seq",
"type": "integer"
},
"playback_connected": {
"title": "Playback Connected",
"type": "boolean"
},
"state": {
"anyOf": [
{
"$ref": "#/components/schemas/PlaybackLiveState"
},
{
"type": "null"
}
],
"default": null
},
"events": {
"items": {
"$ref": "#/components/schemas/PlaybackLiveEvent"
},
"maxItems": 20,
"title": "Events",
"type": "array"
},
"setlist": {
"anyOf": [
{
"$ref": "#/components/schemas/PlaybackSetlist"
},
{
"type": "null"
}
],
"default": null
},
"error_code": {
"anyOf": [
{
"maxLength": 64,
"minLength": 1,
"pattern": "^[a-z0-9_]+$",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error Code"
}
},
"required": [
"session_token",
"seq",
"playback_connected"
],
"title": "PlaybackReport",
"type": "object"
}PlaybackSessionEnd
{
"additionalProperties": false,
"properties": {
"session_token": {
"anyOf": [
{
"maxLength": 128,
"minLength": 32,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Session Token"
}
},
"title": "PlaybackSessionEnd",
"type": "object"
}PlaybackLinkOutput
{
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"playback_key": {
"title": "Playback Key",
"type": "string"
},
"playback_title": {
"title": "Playback Title",
"type": "string"
},
"content_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Content Id"
},
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"material_title": {
"title": "Material Title",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Id"
},
"variant_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Name"
},
"key": {
"title": "Key",
"type": "string"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
}
},
"required": [
"id",
"playback_key",
"playback_title",
"content_id",
"material_id",
"material_title",
"variant_id",
"variant_name",
"key",
"updated_at"
],
"title": "PlaybackLinkOutput",
"type": "object"
}PlaybackLinkList
{
"properties": {
"results": {
"items": {
"$ref": "#/components/schemas/PlaybackLinkOutput"
},
"title": "Results",
"type": "array"
}
},
"required": [
"results"
],
"title": "PlaybackLinkList",
"type": "object"
}PlaybackLink
{
"additionalProperties": false,
"properties": {
"playback_key": {
"maxLength": 220,
"minLength": 4,
"pattern": "^(mt:\\d+|title:.+)$",
"title": "Playback Key",
"type": "string"
},
"playback_title": {
"default": "",
"maxLength": 200,
"title": "Playback Title",
"type": "string"
},
"content_id": {
"anyOf": [
{
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Id"
},
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Variant Id"
},
"key": {
"default": "",
"maxLength": 12,
"title": "Key",
"type": "string"
}
},
"required": [
"playback_key",
"material_id"
],
"title": "PlaybackLink",
"type": "object"
}PlaybackMissing
{
"properties": {
"plan_item_id": {
"format": "uuid",
"title": "Plan Item Id",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"position": {
"title": "Position",
"type": "integer"
}
},
"required": [
"plan_item_id",
"title",
"key",
"position"
],
"title": "PlaybackMissing",
"type": "object"
}PlaybackRow
{
"properties": {
"setlist_song_id": {
"title": "Setlist Song Id",
"type": "integer"
},
"content_id": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Content Id"
},
"title": {
"default": "",
"title": "Title",
"type": "string"
},
"artist": {
"default": "",
"title": "Artist",
"type": "string"
},
"key": {
"default": "",
"title": "Key",
"type": "string"
},
"bpm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"title": "Bpm"
},
"duration_seconds": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Duration Seconds"
},
"position": {
"title": "Position",
"type": "integer"
},
"playback_key": {
"title": "Playback Key",
"type": "string"
},
"link": {
"anyOf": [
{
"$ref": "#/components/schemas/PlaybackLinkOutput"
},
{
"type": "null"
}
]
},
"plan_item_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Item Id"
},
"match_source": {
"anyOf": [
{
"enum": [
"manual",
"link"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Match Source"
},
"status": {
"enum": [
"matched",
"extra",
"unlinked"
],
"title": "Status",
"type": "string"
},
"order_ok": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Order Ok"
},
"key_differs": {
"title": "Key Differs",
"type": "boolean"
},
"current": {
"title": "Current",
"type": "boolean"
},
"suggestions": {
"items": {
"$ref": "#/components/schemas/PlaybackSuggestion"
},
"title": "Suggestions",
"type": "array"
}
},
"required": [
"setlist_song_id",
"position",
"playback_key",
"link",
"plan_item_id",
"match_source",
"status",
"order_ok",
"key_differs",
"current",
"suggestions"
],
"title": "PlaybackRow",
"type": "object"
}PlaybackSuggestion
{
"properties": {
"material_id": {
"format": "uuid",
"title": "Material Id",
"type": "string"
},
"variant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Id"
},
"title": {
"title": "Title",
"type": "string"
},
"variant_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Variant Name"
},
"key": {
"title": "Key",
"type": "string"
},
"score": {
"title": "Score",
"type": "number"
},
"confident": {
"title": "Confident",
"type": "boolean"
}
},
"required": [
"material_id",
"variant_id",
"title",
"variant_name",
"key",
"score",
"confident"
],
"title": "PlaybackSuggestion",
"type": "object"
}PlaybackSummary
{
"properties": {
"matched": {
"title": "Matched",
"type": "integer"
},
"extra": {
"title": "Extra",
"type": "integer"
},
"unlinked": {
"title": "Unlinked",
"type": "integer"
},
"missing": {
"title": "Missing",
"type": "integer"
},
"order_differences": {
"title": "Order Differences",
"type": "integer"
}
},
"required": [
"matched",
"extra",
"unlinked",
"missing",
"order_differences"
],
"title": "PlaybackSummary",
"type": "object"
}EventPlaybackOutput
{
"properties": {
"available": {
"title": "Available",
"type": "boolean"
},
"status": {
"enum": [
"none",
"pairing",
"configured",
"live",
"disconnected",
"error"
],
"title": "Status",
"type": "string"
},
"session_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Session Id"
},
"device_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Device Name"
},
"last_seq": {
"title": "Last Seq",
"type": "integer"
},
"last_seen_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Seen At"
},
"fresh": {
"title": "Fresh",
"type": "boolean"
},
"playback_connected": {
"title": "Playback Connected",
"type": "boolean"
},
"state": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "State"
},
"setlist_name": {
"title": "Setlist Name",
"type": "string"
},
"setlist_version": {
"title": "Setlist Version",
"type": "integer"
},
"rows": {
"items": {
"$ref": "#/components/schemas/PlaybackRow"
},
"title": "Rows",
"type": "array"
},
"missing": {
"items": {
"$ref": "#/components/schemas/PlaybackMissing"
},
"title": "Missing",
"type": "array"
},
"summary": {
"$ref": "#/components/schemas/PlaybackSummary"
},
"can_link": {
"title": "Can Link",
"type": "boolean"
},
"can_reconcile": {
"title": "Can Reconcile",
"type": "boolean"
},
"stale_after_seconds": {
"title": "Stale After Seconds",
"type": "integer"
},
"playback_write_supported": {
"title": "Playback Write Supported",
"type": "boolean"
}
},
"required": [
"available",
"status",
"session_id",
"device_name",
"last_seq",
"last_seen_at",
"fresh",
"playback_connected",
"state",
"setlist_name",
"setlist_version",
"rows",
"missing",
"summary",
"can_link",
"can_reconcile",
"stale_after_seconds",
"playback_write_supported"
],
"title": "EventPlaybackOutput",
"type": "object"
}PlaybackMatch
{
"additionalProperties": false,
"properties": {
"setlist_song_id": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"title": "Setlist Song Id",
"type": "integer"
},
"plan_item_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Item Id"
}
},
"required": [
"setlist_song_id",
"plan_item_id"
],
"title": "PlaybackMatch",
"type": "object"
}PlaybackProgramLine
{
"properties": {
"id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Id"
},
"item_type": {
"title": "Item Type",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
},
"key": {
"title": "Key",
"type": "string"
},
"change": {
"enum": [
"kept",
"moved",
"added"
],
"title": "Change",
"type": "string"
}
},
"required": [
"id",
"item_type",
"title",
"key",
"change"
],
"title": "PlaybackProgramLine",
"type": "object"
}PlaybackReconcileOutput
{
"properties": {
"dry_run": {
"title": "Dry Run",
"type": "boolean"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"before": {
"items": {
"$ref": "#/components/schemas/PlaybackProgramLine"
},
"title": "Before",
"type": "array"
},
"after": {
"items": {
"$ref": "#/components/schemas/PlaybackProgramLine"
},
"title": "After",
"type": "array"
},
"added": {
"title": "Added",
"type": "integer"
},
"moved": {
"title": "Moved",
"type": "integer"
}
},
"required": [
"dry_run",
"revision",
"before",
"after",
"added",
"moved"
],
"title": "PlaybackReconcileOutput",
"type": "object"
}PlaybackReconcile
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"add": {
"items": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"maxItems": 200,
"title": "Add",
"type": "array"
},
"add_as_notes": {
"items": {
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
},
"maxItems": 200,
"title": "Add As Notes",
"type": "array"
},
"reorder": {
"default": false,
"title": "Reorder",
"type": "boolean"
},
"dry_run": {
"default": true,
"title": "Dry Run",
"type": "boolean"
}
},
"required": [
"expected_revision"
],
"title": "PlaybackReconcile",
"type": "object"
}