63118db805
This PR contains the work done to implement the *User Lists* endpoints of the *Discogs API* service in the `Open API` specification document:
* GET `/users/{username}/lists`
* GET `/lists/{list_id}`
Reviewed-on: #14
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
8.1 KiB
JSON
1 line
8.1 KiB
JSON
{"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","kind":"typeIdentifier","text":"GetReleaseStats"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2OkV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/Ok-swift.struct","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":")"}]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"anchor":"discussion","text":"Discussion"},{"type":"aside","name":"Warning","style":"warning","content":[{"inlineContent":[{"type":"text","text":"There is a discrepancy about this response between was is documented and what the endpoints actually responds. In the "},{"identifier":"https:\/\/www.discogs.com\/developers#page:database,header:database-release-stats","isActive":true,"type":"reference"},{"type":"text","text":", it is defined that a type containing a statistical data would be returned but the actual response returns an object that contains a boolean flag instead."}],"type":"paragraph"}]},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/releases\/{release_id}\/stats\/get(getReleaseStats)\/responses\/200","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"paragraph","inlineContent":[{"text":"HTTP response code: ","type":"text"},{"code":"200 ok","type":"codeVoice"},{"text":".","type":"text"}]}],"kind":"content"}],"metadata":{"roleHeading":"Case","symbolKind":"case","title":"Operations.GetReleaseStats.Output.ok(_:)","externalID":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2okyA2G2OkVcAGmF","role":"symbol","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO","kind":"typeIdentifier","text":"GetReleaseStats"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO","kind":"typeIdentifier","text":"Output"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2OkV","kind":"typeIdentifier","text":"Ok"},{"kind":"text","text":")"}]},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output"]]},"sections":[],"schemaVersion":{"minor":3,"major":0,"patch":0},"abstract":[{"type":"text","text":"Successfully retrieved release rating details by a given user."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok(_:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/ok(_:)","interfaceLanguage":"swift"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"https://www.discogs.com/developers#page:database,header:database-release-stats":{"url":"https:\/\/www.discogs.com\/developers#page:database,header:database-release-stats","titleInlineContent":[{"type":"text","text":"documentation"}],"title":"documentation","type":"link","identifier":"https:\/\/www.discogs.com\/developers#page:database,header:database-release-stats"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats":{"type":"topic","navigatorTitle":[{"text":"GetReleaseStats","kind":"identifier"}],"title":"Operations.GetReleaseStats","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseStats","kind":"identifier"}],"abstract":[{"text":"Get information about statistics of release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Operations","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"text":" in the OpenAPI document.","type":"text"}],"url":"\/documentation\/discogsservice\/operations"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/Output":{"type":"topic","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetReleaseStats.Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/Output/Ok-swift.struct":{"type":"topic","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"title":"Operations.GetReleaseStats.Output.Ok","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/Ok-swift.struct","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/Output/ok(_:)":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok(_:)","abstract":[{"type":"text","text":"Successfully retrieved release rating details by a given user."}],"title":"Operations.GetReleaseStats.Output.ok(_:)","type":"topic","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/ok(_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetReleaseStats","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2OkV","kind":"typeIdentifier"},{"text":")","kind":"text"}]}}} |