@cascateer/sterio 1.0.1

package/build/swagger.json

@@ -0,0 +1,775 @@
+{
+	"openapi": "3.0.0",
+	"components": {
+		"examples": {},
+		"headers": {},
+		"parameters": {},
+		"requestBodies": {},
+		"responses": {},
+		"schemas": {
+			"SterioAlbumResource": {
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"iteratee": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"id"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"Partial_SterioAlbumResourcesFull_": {
+				"properties": {
+					"youtubeMusic": {
+						"$ref": "#/components/schemas/SterioAlbumResource"
+					},
+					"youtube": {
+						"$ref": "#/components/schemas/SterioAlbumResource"
+					},
+					"spotify": {
+						"$ref": "#/components/schemas/SterioAlbumResource"
+					}
+				},
+				"type": "object",
+				"description": "Make all properties in T optional"
+			},
+			"SterioAlbumResources": {
+				"$ref": "#/components/schemas/Partial_SterioAlbumResourcesFull_"
+			},
+			"SterioAlbum": {
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"resources": {
+						"$ref": "#/components/schemas/SterioAlbumResources"
+					},
+					"songs": {
+						"properties": {
+							"exclude": {
+								"items": {
+									"type": "number",
+									"format": "double"
+								},
+								"type": "array"
+							},
+							"include": {
+								"items": {
+									"type": "number",
+									"format": "double"
+								},
+								"type": "array"
+							},
+							"videoIds": {
+								"items": {
+									"properties": {
+										"newValue": {
+											"type": "string"
+										},
+										"expectedValue": {
+											"type": "string"
+										},
+										"index": {
+											"type": "number",
+											"format": "double"
+										}
+									},
+									"required": [
+										"newValue",
+										"expectedValue",
+										"index"
+									],
+									"type": "object"
+								},
+								"type": "array"
+							}
+						},
+						"type": "object"
+					}
+				},
+				"required": [
+					"id"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"SterioAlbumResourcesTable": {
+				"properties": {
+					"youtubeMusic": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"youtube": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					},
+					"spotify": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array"
+					}
+				},
+				"required": [
+					"youtubeMusic",
+					"youtube",
+					"spotify"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"SpotifyApi.ExternalUrlObject": {
+				"description": "External Url Object\n[](https://developer.spotify.com/web-api/object-model/)\n\nNote that there might be other types available, it couldn't be found in the docs.",
+				"properties": {
+					"spotify": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"spotify"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"SpotifyApi.ArtistObjectSimplified": {
+				"description": "Simplified Artist Object\n[artist object (simplified)](https://developer.spotify.com/web-api/object-model/)",
+				"properties": {
+					"type": {
+						"type": "string",
+						"enum": [
+							"artist"
+						],
+						"nullable": false,
+						"description": "The object type."
+					},
+					"href": {
+						"type": "string",
+						"description": "A link to the Web API endpoint providing full details."
+					},
+					"external_urls": {
+						"$ref": "#/components/schemas/SpotifyApi.ExternalUrlObject",
+						"description": "Known external URLs."
+					},
+					"uri": {
+						"type": "string",
+						"description": "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)."
+					},
+					"name": {
+						"type": "string",
+						"description": "The name of the artist."
+					},
+					"id": {
+						"type": "string",
+						"description": "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids) for the artist."
+					}
+				},
+				"required": [
+					"type",
+					"href",
+					"external_urls",
+					"uri",
+					"name",
+					"id"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"SpotifyApi.ImageObject": {
+				"description": "Image Object\n[](https://developer.spotify.com/web-api/object-model/)",
+				"properties": {
+					"height": {
+						"type": "number",
+						"format": "double",
+						"description": "The image height in pixels. If unknown: `null` or not returned."
+					},
+					"url": {
+						"type": "string",
+						"description": "The source URL of the image."
+					},
+					"width": {
+						"type": "number",
+						"format": "double",
+						"description": "The image width in pixels. If unknown: null or not returned."
+					}
+				},
+				"required": [
+					"url"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"SpotifyApi.RestrictionsObject": {
+				"properties": {
+					"reason": {
+						"type": "string"
+					}
+				},
+				"required": [
+					"reason"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"SpotifyApi.AlbumObjectSimplified": {
+				"description": "Simplified Album Object\n[album object (simplified)](https://developer.spotify.com/web-api/object-model/#album-object-simplified)",
+				"properties": {
+					"type": {
+						"type": "string",
+						"enum": [
+							"album"
+						],
+						"nullable": false,
+						"description": "The object type."
+					},
+					"href": {
+						"type": "string",
+						"description": "A link to the Web API endpoint providing full details."
+					},
+					"external_urls": {
+						"$ref": "#/components/schemas/SpotifyApi.ExternalUrlObject",
+						"description": "Known external URLs."
+					},
+					"uri": {
+						"type": "string",
+						"description": "The [Spotify URI](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids)."
+					},
+					"album_group": {
+						"type": "string",
+						"enum": [
+							"album",
+							"single",
+							"compilation",
+							"appears_on"
+						],
+						"description": "The field is present when getting an artist’s albums.\nPossible values are “album”, “single”, “compilation”, “appears_on”.\nCompare to album_type this field represents relationship between the artist and the album.",
+						"deprecated": true
+					},
+					"album_type": {
+						"type": "string",
+						"enum": [
+							"album",
+							"single",
+							"compilation"
+						],
+						"description": "The type of the album: one of “album”, “single”, or “compilation”."
+					},
+					"artists": {
+						"items": {
+							"$ref": "#/components/schemas/SpotifyApi.ArtistObjectSimplified"
+						},
+						"type": "array",
+						"description": "The artists of the album.\nEach artist object includes a link in href to more detailed information about the artist."
+					},
+					"available_markets": {
+						"items": {
+							"type": "string"
+						},
+						"type": "array",
+						"description": "The markets in which the album is available: [ISO 3166-1 alpha-2 country codes](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).\nNote that an album is considered available in a market when at least 1 of its tracks is available in that market.",
+						"deprecated": true
+					},
+					"id": {
+						"type": "string",
+						"description": "The [Spotify ID](https://developer.spotify.com/documentation/web-api/#spotify-uris-and-ids) for the album."
+					},
+					"images": {
+						"items": {
+							"$ref": "#/components/schemas/SpotifyApi.ImageObject"
+						},
+						"type": "array",
+						"description": "The cover art for the album in various sizes, widest first."
+					},
+					"name": {
+						"type": "string",
+						"description": "The name of the album. In case of an album takedown, the value may be an empty string."
+					},
+					"release_date": {
+						"type": "string",
+						"description": "The date the album was first released, for example `1981`.\nDepending on the precision, it might be shown as `1981-12` or `1981-12-15`."
+					},
+					"release_date_precision": {
+						"type": "string",
+						"enum": [
+							"year",
+							"month",
+							"day"
+						],
+						"description": "The precision with which release_date value is known: `year`, `month`, or `day`."
+					},
+					"restrictions": {
+						"$ref": "#/components/schemas/SpotifyApi.RestrictionsObject",
+						"description": "Part of the response when [Track Relinking](https://developer.spotify.com/documentation/general/guides/track-relinking-guide/) is applied,\nthe original track is not available in the given market, and Spotify did not have any tracks to relink it with.\nThe track response will still contain metadata for the original track,\nand a restrictions object containing the reason why the track is not available: `\"restrictions\" : {\"reason\" : \"market\"}`"
+					},
+					"total_tracks": {
+						"type": "number",
+						"format": "double",
+						"description": "The number of tracks in the album."
+					}
+				},
+				"required": [
+					"type",
+					"href",
+					"external_urls",
+					"uri",
+					"album_type",
+					"artists",
+					"id",
+					"images",
+					"name",
+					"release_date",
+					"release_date_precision",
+					"total_tracks"
+				],
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_PlaylistItemContentDetails": {
+				"properties": {
+					"endAt": {
+						"type": "string",
+						"nullable": true,
+						"description": "The time, measured in seconds from the start of the video, when the video should stop playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) By default, assume that the video.endTime is the end of the video."
+					},
+					"note": {
+						"type": "string",
+						"nullable": true,
+						"description": "A user-generated note for this item."
+					},
+					"startAt": {
+						"type": "string",
+						"nullable": true,
+						"description": "The time, measured in seconds from the start of the video, when the video should start playing. (The playlist owner can specify the times when the video should start and stop playing when the video is played in the context of the playlist.) The default value is 0."
+					},
+					"videoId": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify a video. To retrieve the video resource, set the id query parameter to this value in your API request."
+					},
+					"videoPublishedAt": {
+						"type": "string",
+						"nullable": true,
+						"description": "The date and time that the video was published to YouTube."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_ResourceId": {
+				"description": "A resource id is a generic reference that points to another YouTube resource.",
+				"properties": {
+					"channelId": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify the referred resource, if that resource is a channel. This property is only present if the resourceId.kind value is youtube#channel."
+					},
+					"kind": {
+						"type": "string",
+						"nullable": true,
+						"description": "The type of the API resource."
+					},
+					"playlistId": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify the referred resource, if that resource is a playlist. This property is only present if the resourceId.kind value is youtube#playlist."
+					},
+					"videoId": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify the referred resource, if that resource is a video. This property is only present if the resourceId.kind value is youtube#video."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_Thumbnail": {
+				"description": "A thumbnail is an image representing a YouTube resource.",
+				"properties": {
+					"height": {
+						"type": "number",
+						"format": "double",
+						"nullable": true,
+						"description": "(Optional) Height of the thumbnail image."
+					},
+					"url": {
+						"type": "string",
+						"nullable": true,
+						"description": "The thumbnail image's URL."
+					},
+					"width": {
+						"type": "number",
+						"format": "double",
+						"nullable": true,
+						"description": "(Optional) Width of the thumbnail image."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_ThumbnailDetails": {
+				"description": "Internal representation of thumbnails for a YouTube resource.",
+				"properties": {
+					"default": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_Thumbnail",
+						"description": "The default image for this resource."
+					},
+					"high": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_Thumbnail",
+						"description": "The high quality image for this resource."
+					},
+					"maxres": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_Thumbnail",
+						"description": "The maximum resolution quality image for this resource."
+					},
+					"medium": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_Thumbnail",
+						"description": "The medium quality image for this resource."
+					},
+					"standard": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_Thumbnail",
+						"description": "The standard quality image for this resource."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_PlaylistItemSnippet": {
+				"description": "Basic details about a playlist, including title, description and thumbnails. Basic details of a YouTube Playlist item provided by the author. Next ID: 15",
+				"properties": {
+					"channelId": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify the user that added the item to the playlist."
+					},
+					"channelTitle": {
+						"type": "string",
+						"nullable": true,
+						"description": "Channel title for the channel that the playlist item belongs to."
+					},
+					"description": {
+						"type": "string",
+						"nullable": true,
+						"description": "The item's description."
+					},
+					"playlistId": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify thGe playlist that the playlist item is in."
+					},
+					"position": {
+						"type": "number",
+						"format": "double",
+						"nullable": true,
+						"description": "The order in which the item appears in the playlist. The value uses a zero-based index, so the first item has a position of 0, the second item has a position of 1, and so forth."
+					},
+					"publishedAt": {
+						"type": "string",
+						"nullable": true,
+						"description": "The date and time that the item was added to the playlist."
+					},
+					"resourceId": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_ResourceId",
+						"description": "The id object contains information that can be used to uniquely identify the resource that is included in the playlist as the playlist item."
+					},
+					"thumbnails": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_ThumbnailDetails",
+						"description": "A map of thumbnail images associated with the playlist item. For each object in the map, the key is the name of the thumbnail image, and the value is an object that contains other information about the thumbnail."
+					},
+					"title": {
+						"type": "string",
+						"nullable": true,
+						"description": "The item's title."
+					},
+					"videoOwnerChannelId": {
+						"type": "string",
+						"nullable": true,
+						"description": "Channel id for the channel this video belongs to."
+					},
+					"videoOwnerChannelTitle": {
+						"type": "string",
+						"nullable": true,
+						"description": "Channel title for the channel this video belongs to."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_PlaylistItemStatus": {
+				"description": "Information about the playlist item's privacy status.",
+				"properties": {
+					"privacyStatus": {
+						"type": "string",
+						"nullable": true,
+						"description": "This resource's privacy status."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"youtube_v3.Schema_36_PlaylistItem": {
+				"description": "A *playlistItem* resource identifies another resource, such as a video, that is included in a playlist. In addition, the playlistItem resource contains details about the included resource that pertain specifically to how that resource is used in that playlist. YouTube uses playlists to identify special collections of videos for a channel, such as: - uploaded videos - favorite videos - positively rated (liked) videos - watch history - watch later To be more specific, these lists are associated with a channel, which is a collection of a person, group, or company's videos, playlists, and other YouTube information. You can retrieve the playlist IDs for each of these lists from the channel resource for a given channel. You can then use the playlistItems.list method to retrieve any of those lists. You can also add or remove items from those lists by calling the playlistItems.insert and playlistItems.delete methods. For example, if a user gives a positive rating to a video, you would insert that video into the liked videos playlist for that user's channel.",
+				"properties": {
+					"contentDetails": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_PlaylistItemContentDetails",
+						"description": "The contentDetails object is included in the resource if the included item is a YouTube video. The object contains additional information about the video."
+					},
+					"etag": {
+						"type": "string",
+						"nullable": true,
+						"description": "Etag of this resource."
+					},
+					"id": {
+						"type": "string",
+						"nullable": true,
+						"description": "The ID that YouTube uses to uniquely identify the playlist item."
+					},
+					"kind": {
+						"type": "string",
+						"nullable": true,
+						"description": "Identifies what kind of resource this is. Value: the fixed string \"youtube#playlistItem\"."
+					},
+					"snippet": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_PlaylistItemSnippet",
+						"description": "The snippet object contains basic details about the playlist item, such as its title and position in the playlist."
+					},
+					"status": {
+						"$ref": "#/components/schemas/youtube_v3.Schema_36_PlaylistItemStatus",
+						"description": "The status object contains information about the playlist item's privacy status."
+					}
+				},
+				"type": "object",
+				"additionalProperties": false
+			},
+			"YoutubePlaylist": {
+				"properties": {
+					"id": {
+						"type": "string"
+					},
+					"title": {
+						"type": "string"
+					},
+					"items": {
+						"items": {
+							"$ref": "#/components/schemas/youtube_v3.Schema_36_PlaylistItem"
+						},
+						"type": "array"
+					}
+				},
+				"required": [
+					"id",
+					"items"
+				],
+				"type": "object",
+				"additionalProperties": false
+			}
+		},
+		"securitySchemes": {}
+	},
+	"info": {
+		"title": "@cascateer/sterio",
+		"version": "1.0.0",
+		"contact": {}
+	},
+	"paths": {
+		"/sterio/album/{id}": {
+			"get": {
+				"operationId": "GetAlbum",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/SterioAlbum"
+								}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						}
+					}
+				]
+			}
+		},
+		"/sterio/album": {
+			"patch": {
+				"operationId": "UpdateAlbum",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [],
+				"requestBody": {
+					"required": true,
+					"content": {
+						"application/json": {
+							"schema": {
+								"$ref": "#/components/schemas/SterioAlbum"
+							}
+						}
+					}
+				}
+			}
+		},
+		"/sterio/album/{id}/resources/table": {
+			"post": {
+				"operationId": "GetAlbumResourcesTable",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/SterioAlbumResourcesTable"
+								}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [
+					{
+						"in": "path",
+						"name": "id",
+						"required": true,
+						"schema": {
+							"type": "string"
+						}
+					}
+				]
+			}
+		},
+		"/sterio/spotify/albums": {
+			"get": {
+				"operationId": "GetSpotifyAlbums",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"items": {
+										"$ref": "#/components/schemas/SpotifyApi.AlbumObjectSimplified"
+									},
+									"type": "array"
+								}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "q",
+						"required": true,
+						"schema": {
+							"type": "string"
+						}
+					}
+				]
+			}
+		},
+		"/sterio/youtube/playlists": {
+			"get": {
+				"operationId": "GetYoutubePlaylists",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"items": {
+										"$ref": "#/components/schemas/YoutubePlaylist"
+									},
+									"type": "array"
+								}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "ids",
+						"required": true,
+						"schema": {
+							"type": "string"
+						}
+					}
+				]
+			}
+		},
+		"/sterio/youtube-music/albums": {
+			"get": {
+				"operationId": "GetYoutubeMusicAlbums",
+				"responses": {
+					"200": {
+						"description": "Ok",
+						"content": {
+							"application/json": {
+								"schema": {
+									"items": {
+										"properties": {
+											"text": {
+												"type": "string"
+											},
+											"albumId": {
+												"type": "string"
+											}
+										},
+										"required": [
+											"text",
+											"albumId"
+										],
+										"type": "object"
+									},
+									"type": "array"
+								}
+							}
+						}
+					}
+				},
+				"security": [],
+				"parameters": [
+					{
+						"in": "query",
+						"name": "q",
+						"required": true,
+						"schema": {
+							"type": "string"
+						}
+					}
+				]
+			}
+		}
+	},
+	"servers": [
+		{
+			"url": "http://127.0.0.1:2700/"
+		}
+	]
+}