vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-07-06 02:00:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[@types/spotify-api]: Add the appropriate descriptions for fields in artist, playlist, and track objects (#43835)

Browse Source 
* Format: fix spacing format

* Meta: add name to the contributors list

* Fix: specify the only possible options for album_group and album_type

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#album-object-simplified

* Docs: include official documentation for descriptions in album objects

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#album-object-full

* Meta: include name in the tests file

* Docs: update the `SearchForItemParameterObject` by adding the field `include_external`

Source: https://developer.spotify.com/documentation/web-api/reference/search/search

* Format: fix inconsistent field delimiters

* Docs: include documentation for artist objects

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#artist-object-full

* Docs: include documentation for followers object

This also includes a type fix. Currently, the Web API does not support
the `href` field. It is temporarily there as a placeholder for the
future feature.

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#followers-object

* Docs: include documentation for image objects

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#image-object

* Docs: include documentation for error objects

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#error-object

* Format: remove type definitions to inline them instead

* Docs: include documentation for track objects

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#track-object-full

* Format: remove double quotes from field names

* Fix: make `is_local` an optional field for track objects

* Fix: move `is_local` to definition of only full track objects

* Format: extend similar artist, playlist, and album objects as context objects

* Docs: include documentation for playlists

Source: https://developer.spotify.com/documentation/web-api/reference/object-model/#playlist-object-full
This commit is contained in:
Basti Ortiz
2020-04-14 03:00:19 +08:00
committed by GitHub
parent 491e0d5730
commit f8797c8d40
2 changed files with 479 additions and 242 deletions
Download Patch File Download Diff File Expand all files Collapse all files

710
types/spotify-api/index.d.ts vendored
View File

File diff suppressed because it is too large Load Diff

11
types/spotify-api/spotify-api-tests.ts
View File

@@ -2,6 +2,7 @@
// Project: https://developer.spotify.com/web-api/
// Definitions by: Niels Kristian Hansen Skovmand <https://github.com/skovmand>
// Nils Måsén <https://github.com/piksel>
// Basti Ortiz <https://github.com/Some-Dood>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/*
@@ -5532,7 +5533,7 @@ const usersTopTracks : SpotifyApi.UsersTopTracksResponse = {
"items": [
{
"album": {
"album_type": "ALBUM",
"album_type": "album",
"artists": [
{
"external_urls": {
@@ -5783,7 +5784,7 @@ const usersTopTracks : SpotifyApi.UsersTopTracksResponse = {
},
{
"album": {
"album_type": "ALBUM",
"album_type": "album",
"artists": [
{
"external_urls": {
@@ -6016,7 +6017,7 @@ const usersTopTracks : SpotifyApi.UsersTopTracksResponse = {
},
{
"album": {
"album_type": "ALBUM",
"album_type": "album",
"artists": [
{
"external_urls": {
@@ -6251,7 +6252,7 @@ const usersTopTracks : SpotifyApi.UsersTopTracksResponse = {
},
{
"album": {
"album_type": "COMPILATION",
"album_type": "album",
"artists": [
{
"external_urls": {
@@ -6340,7 +6341,7 @@ const usersTopTracks : SpotifyApi.UsersTopTracksResponse = {
},
{
"album": {
"album_type": "ALBUM",
"album_type": "album",
"artists": [
{
"external_urls": {