vikarti.anatra/polaris-mirror
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Auto-format

Browse source
This commit is contained in:
Antoine Gersant 2020-01-11 01:56:44 -08:00
parent 0a0a6ce955
commit 2de5b34a48
1 changed files with 101 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

130
docs/swagger/polaris-api.json
View file

@ -35,7 +35,9 @@
"paths": { "paths": {
"/version": { "/version": {
"get": { "get": {
"tags": ["Other"], "tags": [
"Other"
],
"summary": "Returns which API version this server implements", "summary": "Returns which API version this server implements",
"operationId": "getVersion", "operationId": "getVersion",
"responses": { "responses": {
@ -54,7 +56,9 @@
}, },
"/initial_setup": { "/initial_setup": {
"get": { "get": {
"tags": ["Other"], "tags": [
"Other"
],
"summary": "Returns the current state of the initial setup flow", "summary": "Returns the current state of the initial setup flow",
"operationId": "getInitialSetup", "operationId": "getInitialSetup",
"responses": { "responses": {
@ -73,7 +77,9 @@
}, },
"/trigger_index": { "/trigger_index": {
"post": { "post": {
"tags": ["Other"], "tags": [
"Other"
],
"summary": "Begins or queues a crawl of the music collection", "summary": "Begins or queues a crawl of the music collection",
"operationId": "postTriggerIndex", "operationId": "postTriggerIndex",
"responses": { "responses": {
@ -91,7 +97,9 @@
}, },
"/settings": { "/settings": {
"get": { "get": {
"tags": ["Settings"], "tags": [
"Settings"
],
"summary": "Reads the existing server configuration", "summary": "Reads the existing server configuration",
"operationId": "getSettings", "operationId": "getSettings",
"responses": { "responses": {
@ -114,12 +122,20 @@
] ]
}, },
"put": { "put": {
"tags": ["Settings"], "tags": [
"Settings"
],
"summary": "Overwrites the server configuration", "summary": "Overwrites the server configuration",
"operationId": "getSettings", "operationId": "getSettings",
"requestBody": { "requestBody": {
"required": true, "required": true,
"content": { "application/json": { "schema": { "$ref": "#components/schemas/Config" } } } "content": {
"application/json": {
"schema": {
"$ref": "#components/schemas/Config"
}
}
}
}, },
"responses": { "responses": {
"200": { "200": {
@ -136,7 +152,9 @@
}, },
"/preferences": { "/preferences": {
"get": { "get": {
"tags": ["Settings"], "tags": [
"Settings"
],
"summary": "Reads the preferences of the current user", "summary": "Reads the preferences of the current user",
"operationId": "getPreferences", "operationId": "getPreferences",
"responses": { "responses": {
@ -161,17 +179,31 @@
}, },
"/auth": { "/auth": {
"post": { "post": {
"tags": ["Other"], "tags": [
"Other"
],
"summary": "Returns information about user permissions and a session cookie for future authenticated requests.", "summary": "Returns information about user permissions and a session cookie for future authenticated requests.",
"operationId": "postAuth", "operationId": "postAuth",
"requestBody": { "requestBody": {
"required": true, "required": true,
"content": { "application/json": { "schema": { "$ref": "#components/schemas/AuthCredentials" } } } "content": {
"application/json": {
"schema": {
"$ref": "#components/schemas/AuthCredentials"
}
}
}
}, },
"responses": { "responses": {
"200": { "200": {
"description": "Successful operation", "description": "Successful operation",
"content": { "application/json": { "schema": { "$ref":"#components/schemas/AuthOutput" } } } "content": {
"application/json": {
"schema": {
"$ref": "#components/schemas/AuthOutput"
}
}
}
}, },
"401": { "401": {
"description": "Invalid credentials" "description": "Invalid credentials"
@ -181,7 +213,9 @@
}, },
"/browse": { "/browse": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Reads the content of the top-level directory in the music collection", "summary": "Reads the content of the top-level directory in the music collection",
"operationId": "getBrowse", "operationId": "getBrowse",
"responses": { "responses": {
@ -209,7 +243,9 @@
}, },
"/browse/{location}": { "/browse/{location}": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Reads the content of a directory in the music collection", "summary": "Reads the content of a directory in the music collection",
"operationId": "getBrowsePath", "operationId": "getBrowsePath",
"parameters": [ "parameters": [
@ -247,7 +283,9 @@
}, },
"/flatten": { "/flatten": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Recursively lists all the songs in the music collection", "summary": "Recursively lists all the songs in the music collection",
"operationId": "getFlatten", "operationId": "getFlatten",
"responses": { "responses": {
@ -275,7 +313,9 @@
}, },
"/flatten/{location}": { "/flatten/{location}": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Recursively lists all the songs within a directory of the music collection", "summary": "Recursively lists all the songs within a directory of the music collection",
"operationId": "getFlattenPath", "operationId": "getFlattenPath",
"parameters": [ "parameters": [
@ -313,7 +353,9 @@
}, },
"/random": { "/random": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Returns a list of random albums", "summary": "Returns a list of random albums",
"operationId": "getRandom", "operationId": "getRandom",
"responses": { "responses": {
@ -341,7 +383,9 @@
}, },
"/recent": { "/recent": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Returns the albums most recently added to the collection", "summary": "Returns the albums most recently added to the collection",
"operationId": "getRecent", "operationId": "getRecent",
"responses": { "responses": {
@ -369,7 +413,9 @@
}, },
"/search/{query}": { "/search/{query}": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Searches for songs and directories", "summary": "Searches for songs and directories",
"operationId": "getSearch", "operationId": "getSearch",
"parameters": [ "parameters": [
@ -407,7 +453,9 @@
}, },
"/serve/{file}": { "/serve/{file}": {
"get": { "get": {
"tags": ["Collection"], "tags": [
"Collection"
],
"summary": "Access a media file in the collection", "summary": "Access a media file in the collection",
"operationId": "getServe", "operationId": "getServe",
"parameters": [ "parameters": [
@ -424,8 +472,16 @@
"200": { "200": {
"description": "Successful operation", "description": "Successful operation",
"content": { "content": {
"image/*": { "schema": { "format": "binary" } }, "image/*": {
"audio/*": { "schema": { "format": "binary" } } "schema": {
"format": "binary"
}
},
"audio/*": {
"schema": {
"format": "binary"
}
}
} }
} }
}, },
@ -439,7 +495,9 @@
}, },
"/playlists": { "/playlists": {
"get": { "get": {
"tags": ["Playlists"], "tags": [
"Playlists"
],
"summary": "Lists the playlists belonging to the current user", "summary": "Lists the playlists belonging to the current user",
"operationId": "getPlaylists", "operationId": "getPlaylists",
"responses": { "responses": {
@ -467,7 +525,9 @@
}, },
"/playlist/{playlistName}": { "/playlist/{playlistName}": {
"get": { "get": {
"tags": ["Playlists"], "tags": [
"Playlists"
],
"summary": "Reads the content of a playlist", "summary": "Reads the content of a playlist",
"operationId": "getPlaylist", "operationId": "getPlaylist",
"parameters": [ "parameters": [
@ -503,7 +563,9 @@
] ]
}, },
"put": { "put": {
"tags": ["Playlists"], "tags": [
"Playlists"
],
"summary": "Saves a playlist", "summary": "Saves a playlist",
"operationId": "putPlaylist", "operationId": "putPlaylist",
"parameters": [ "parameters": [
@ -519,7 +581,7 @@
"requestBody": { "requestBody": {
"required": true, "required": true,
"content": { "content": {
"application/json":{ "application/json": {
"schema": { "schema": {
"$ref": "#/components/schemas/SavePlaylistInput" "$ref": "#/components/schemas/SavePlaylistInput"
} }
@ -539,7 +601,9 @@
] ]
}, },
"delete": { "delete": {
"tags": ["Playlists"], "tags": [
"Playlists"
],
"summary": "Deletes a playlist", "summary": "Deletes a playlist",
"operationId": "deletePlaylist", "operationId": "deletePlaylist",
"parameters": [ "parameters": [
@ -567,7 +631,9 @@
}, },
"/lastfm/now_playing/{song}": { "/lastfm/now_playing/{song}": {
"put": { "put": {
"tags": ["Last.fm"], "tags": [
"Last.fm"
],
"summary": "Tells Last.fm the song currently being played", "summary": "Tells Last.fm the song currently being played",
"operationId": "putLastFMNowPlaying", "operationId": "putLastFMNowPlaying",
"parameters": [ "parameters": [
@ -595,7 +661,9 @@
}, },
"/lastfm/scrobble/{song}": { "/lastfm/scrobble/{song}": {
"post": { "post": {
"tags": ["Last.fm"], "tags": [
"Last.fm"
],
"summary": "Tells Last.fm that a song has been playing for long enough to be scrobbled", "summary": "Tells Last.fm that a song has been playing for long enough to be scrobbled",
"operationId": "postLastFMScrobble", "operationId": "postLastFMScrobble",
"parameters": [ "parameters": [
@ -623,7 +691,9 @@
}, },
"/lastfm/link": { "/lastfm/link": {
"get": { "get": {
"tags": ["Last.fm"], "tags": [
"Last.fm"
],
"summary": "Links a Polaris user with a Last.fm account.", "summary": "Links a Polaris user with a Last.fm account.",
"externalDocs": { "externalDocs": {
"description": "This endpoint is meant to be used as a Last.fm authentication handler, as described here:", "description": "This endpoint is meant to be used as a Last.fm authentication handler, as described here:",
@ -662,7 +732,9 @@
} }
}, },
"delete": { "delete": {
"tags": ["Last.fm"], "tags": [
"Last.fm"
],
"summary": "Unlinks Polaris user and Last.fm account", "summary": "Unlinks Polaris user and Last.fm account",
"operationId": "deleteLastFMLink", "operationId": "deleteLastFMLink",
"responses": { "responses": {