diff --git a/proxy/api/index.html b/proxy/api/index.html index badefb1..83e479e 100644 --- a/proxy/api/index.html +++ b/proxy/api/index.html @@ -50,9 +50,9 @@ .hmCwJW polygon{fill:#1d8127;}/*!sc*/ .fmmJjS{height:20px;width:20px;min-width:20px;vertical-align:middle;float:right;transition:transform 0.2s ease-out;transform:rotateZ(0);}/*!sc*/ .fmmJjS polygon{fill:white;}/*!sc*/ -.ccTkAM{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ .bEpxpV{height:1.3em;width:1.3em;min-width:1.3em;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ -data-styled.g15[id="sc-cHqXqK"]{content:"gkUOTk,hmCwJW,fmmJjS,ccTkAM,bEpxpV,"}/*!sc*/ +.ccTkAM{height:18px;width:18px;min-width:18px;vertical-align:middle;transition:transform 0.2s ease-out;transform:rotateZ(-90deg);}/*!sc*/ +data-styled.g15[id="sc-cHqXqK"]{content:"gkUOTk,hmCwJW,fmmJjS,bEpxpV,ccTkAM,"}/*!sc*/ .iyKqKI{border-left:1px solid #7c7cbb;box-sizing:border-box;position:relative;padding:10px 10px 10px 0;}/*!sc*/ @media screen and (max-width: 50rem){.iyKqKI{display:block;overflow:hidden;}}/*!sc*/ tr:first-of-type>.iyKqKI,tr.last>.iyKqKI{border-left-width:0;background-position:top left;background-repeat:no-repeat;background-size:1px 100%;}/*!sc*/ @@ -392,7 +392,7 @@ -
API docs by Redocly
API docs by Redocly

OSC Microservices API (1.0.0)

Download OpenAPI specification:Download

jukeboxes

JukeboxController_create

Request Body schema: application/json
required
name
required
string
club_id
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "club_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "spotify_links": [
    ],
  • "active_spotify_link": {
    }
}

JukeboxController_findAll

Responses

Response samples

Content type
application/json
[
  • {
    }
]

JukeboxController_findOne

path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "spotify_links": [
    ],
  • "active_spotify_link": {
    }
}

JukeboxController_update

path Parameters
id
required
number
Request Body schema: application/json
required
name
string
object (SpotifyLinkNestedDto)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "active_spotify_link": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "spotify_links": [
    ],
  • "active_spotify_link": {
    }
}

JukeboxController_remove

path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "spotify_links": [
    ],
  • "active_spotify_link": {
    }
}

JukeboxController_addLinkToJukebox

path Parameters
jukebox_id
required
number
Request Body schema: application/json
required
spotifyEmail
required
string

Responses

Request samples

Content type
application/json
{
  • "spotifyEmail": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "access_token": "string",
  • "user_id": "string",
  • "spotify_email": "string",
  • "expires_at": "2019-08-24T14:15:22Z",
  • "token_type": "string",
  • "expires_in": 0
}

spotify

SpotifyController_login

Responses

SpotifyController_loginSuccessCallback

Responses

Response samples

Content type
application/json
{ }

club

club_clubs_list

OSC Microservices API (1.0.0)

Download OpenAPI specification:Download

jukeboxes

JukeboxController_create

Request Body schema: application/json
required
name
required
string
club_id
required
number

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "club_id": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "links": [
    ]
}

JukeboxController_findAll

Responses

Response samples

Content type
application/json
[
  • {
    }
]

JukeboxController_findOne

path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "links": [
    ]
}

JukeboxController_update

path Parameters
id
required
number
Request Body schema: application/json
required
name
string

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "links": [
    ]
}

JukeboxController_remove

path Parameters
id
required
number

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "name": "string",
  • "club_id": 0,
  • "links": [
    ]
}

JukeboxController_addLinkToJukebox

path Parameters
jukebox_id
required
number
Request Body schema: application/json
required
type
required
string
email
required
string

Responses

Request samples

Content type
application/json
{
  • "type": "string",
  • "email": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "type": "string",
  • "email": "string",
  • "active": true
}

spotify

SpotifyController_login

Responses

SpotifyController_loginSuccessCallback

Responses

Response samples

Content type
application/json
{ }

club

club_clubs_list

CRUD Api routes for Club models.

-
Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

club_clubs_create

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

club_clubs_create

CRUD Api routes for Club models.

-
Authorizations:
tokenAuth
Request Body schema:
required
name
required
string <= 64 characters
logo
string or null <uri>

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_members_list

Authorizations:
tokenAuth
Request Body schema:
required
name
required
string <= 64 characters
logo
string or null <uri>

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_members_list

CRUD Api routes for ClubMembership for a specific Club.

-
Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$

Responses

Response samples

Content type
application/json
[
  • {
    }
]

club_clubs_members_create

Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$

Responses

Response samples

Content type
application/json
[
  • {
    }
]

club_clubs_members_create

CRUD Api routes for ClubMembership for a specific Club.

-
Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$
Request Body schema:
required
user_id
required
integer
RoleEnum (string) or BlankEnum (any)
owner
boolean
coins
integer [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

club_clubs_members_retrieve

Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$
Request Body schema:
required
user_id
required
integer
RoleEnum (string) or BlankEnum (any)
owner
boolean
points
integer [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

club_clubs_members_retrieve

CRUD Api routes for ClubMembership for a specific Club.

Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$
id
required
integer

A unique integer value identifying this club membership.

-

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

club_clubs_members_update

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

club_clubs_members_update

CRUD Api routes for ClubMembership for a specific Club.

Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$
id
required
integer

A unique integer value identifying this club membership.

-
Request Body schema:
required
user_id
required
integer
RoleEnum (string) or BlankEnum (any)
owner
boolean
coins
integer [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

club_clubs_members_partial_update

Request Body schema:
required
user_id
required
integer
RoleEnum (string) or BlankEnum (any)
owner
boolean
points
integer [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

club_clubs_members_partial_update

CRUD Api routes for ClubMembership for a specific Club.

Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$
id
required
integer

A unique integer value identifying this club membership.

-
Request Body schema:
user_id
integer
RoleEnum (string) or BlankEnum (any)
owner
boolean
coins
integer [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "coins": -2147483648
}

club_clubs_members_destroy

Request Body schema:
user_id
integer
RoleEnum (string) or BlankEnum (any)
owner
boolean
points
integer [ -2147483648 .. 2147483647 ]

Responses

Request samples

Content type
{
  • "user_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_id": 0,
  • "club_id": 0,
  • "role": "president",
  • "owner": true,
  • "points": -2147483648
}

club_clubs_members_destroy

CRUD Api routes for ClubMembership for a specific Club.

Authorizations:
tokenAuth
path Parameters
club_id
required
string^.+$
id
required
integer

A unique integer value identifying this club membership.

@@ -440,15 +440,15 @@ " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

CRUD Api routes for Club models.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this club.

-

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_update

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_update

CRUD Api routes for Club models.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this club.

-
Request Body schema:
required
name
required
string <= 64 characters
logo
string or null <uri>

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_partial_update

Request Body schema:
required
name
required
string <= 64 characters
logo
string or null <uri>

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_partial_update

CRUD Api routes for Club models.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this club.

-
Request Body schema:
name
string <= 64 characters
logo
string or null <uri>

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_destroy

Request Body schema:
name
string <= 64 characters
logo
string or null <uri>

Responses

Request samples

Content type
{}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "logo": "http://example.com",
  • "members": [
    ]
}

club_clubs_destroy

CRUD Api routes for Club models.

Authorizations:
tokenAuth
path Parameters
id
required
integer

A unique integer value identifying this club.

@@ -468,15 +468,15 @@ " class="sc-epnzzT sc-eMwmJz drsioI dWZUhK">

Manage the authenticated user.

Authorizations:
tokenAuth

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "clubs": [
    ]
}

user_me_update

Manage the authenticated user.

-
Authorizations:
tokenAuth
Request Body schema:
required
username
string
email
required
string <email>
first_name
string
last_name
string
password
required
string [ 5 .. 128 ] characters
required
Array of objects (UserClubNested)

Responses

Request samples

Content type
{
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "clubs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "clubs": [
    ]
}

user_me_partial_update

Authorizations:
tokenAuth
Request Body schema:
required
username
string
email
required
string <email>
first_name
string
last_name
string
password
required
string [ 5 .. 128 ] characters
Array of objects (UserClubNested)

Responses

Request samples

Content type
{
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "clubs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "clubs": [
    ]
}

user_me_partial_update

Manage the authenticated user.

Authorizations:
tokenAuth
Request Body schema:
username
string
email
string <email>
first_name
string
last_name
string
password
string [ 5 .. 128 ] characters
Array of objects (UserClubNested)

Responses

Request samples

Content type
{
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "clubs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "clubs": [
    ]
}

user_token_create

Create a new auth token for user.

Authorizations:
cookieAuthbasicAuth
Request Body schema:
required
email
required
string <email>
password
required
string

Responses

Request samples

Content type
No sample

Response samples

Content type
application/json
{
  • "email": "user@example.com",
  • "password": "string"
}

user_users_create_create

Create a new user in the system.

-
Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
username
string
email
required
string <email>
first_name
string
last_name
string
password
required
string [ 5 .. 128 ] characters
required
Array of objects (UserClubNested)

Responses

Request samples

Content type
{
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "clubs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "clubs": [
    ]
}
+
Authorizations:
cookieAuthbasicAuthNone
Request Body schema:
required
username
string
email
required
string <email>
first_name
string
last_name
string
password
required
string [ 5 .. 128 ] characters
Array of objects (UserClubNested)

Responses

Request samples

Content type
{
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "password": "string",
  • "clubs": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "username": "string",
  • "email": "user@example.com",
  • "first_name": "string",
  • "last_name": "string",
  • "clubs": [
    ]
}