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
6.7 KiB
JSON
1 line
6.7 KiB
JSON
{"sections":[],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"schemaVersion":{"patch":0,"minor":3,"major":0},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetWantlist"}]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","anchor":"overview","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"Returnss the list of releases in a wantlist of a user. Accepts Pagination parameters."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"Basic information about each release is provided, suitable for display in a list. For detailed information, make another API call to fetch the corresponding release."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"If the wantlist has been made private by its owner, you must be authenticated as the owner to view it."}],"type":"paragraph"},{"inlineContent":[{"type":"text","text":"The notes field will be visible if you are authenticated as the wantlist owner."}],"type":"paragraph"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/wants"},{"type":"text","text":"."}]}],"name":"Remark","type":"aside","style":"note"},{"content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/wants\/get(getWantlist)"},{"type":"text","text":"."}]}],"name":"Remark","type":"aside","style":"note"}]}],"metadata":{"navigatorTitle":[{"text":"GetWantlist","kind":"identifier"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetWantlist"}],"roleHeading":"Enumeration","role":"symbol","symbolKind":"enum","externalID":"s:14DiscogsService10OperationsO11GetWantlistO","title":"Operations.GetWantlist","modules":[{"name":"DiscogsService"}]},"topicSections":[{"title":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Input"],"generated":true,"anchor":"Structures"},{"title":"Type Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/id"],"generated":true,"anchor":"Type-Properties"},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Output"],"generated":true,"anchor":"Enumerations"}],"abstract":[{"text":"Get a list of releases in a wantlist of a user.","type":"text"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getwantlist"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist":{"type":"topic","navigatorTitle":[{"text":"GetWantlist","kind":"identifier"}],"title":"Operations.GetWantlist","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetWantlist","kind":"identifier"}],"abstract":[{"type":"text","text":"Get a list of releases in a wantlist of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getwantlist"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"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/GetWantlist/Output":{"type":"topic","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.GetWantlist.Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Output","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getwantlist\/output"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/AcceptableContentType":{"kind":"symbol","navigatorTitle":[{"text":"AcceptableContentType","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/AcceptableContentType","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AcceptableContentType"}],"role":"symbol","type":"topic","title":"Operations.GetWantlist.AcceptableContentType","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getwantlist\/acceptablecontenttype"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/Input":{"type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getwantlist\/input","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","kind":"symbol","title":"Operations.GetWantlist.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetWantlist/id":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetWantlist\/id","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"role":"symbol","type":"topic","title":"id","abstract":[],"url":"\/documentation\/discogsservice\/operations\/getwantlist\/id"}}} |