javier
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.1 KiB
JSON
1 line
6.1 KiB
JSON
{"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/Input"],"generated":true,"title":"Structures","anchor":"Structures"},{"title":"Type Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/id"],"generated":true,"anchor":"Type-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/Output"],"generated":true,"title":"Enumerations","anchor":"Enumerations"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"abstract":[{"text":"Get a list of lists of a user.","type":"text"}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"metadata":{"roleHeading":"Enumeration","externalID":"s:14DiscogsService10OperationsO8GetListsO","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetLists"}],"symbolKind":"enum","navigatorTitle":[{"text":"GetLists","kind":"identifier"}],"role":"symbol","title":"Operations.GetLists","modules":[{"name":"DiscogsService"}]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"GetLists","kind":"identifier"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"anchor":"overview","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Returns a list of lists created by a users."}]},{"type":"paragraph","inlineContent":[{"text":"This endpoints accepts pagination and, to show private lists it is required to be authenticated as a owner.","type":"text"}]},{"type":"aside","name":"Remark","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/users\/{username}\/lists"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"aside","name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/users\/{username}\/lists\/get(getLists)"},{"text":".","type":"text"}]}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getlists"]}],"references":{"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/GetLists/Input":{"type":"topic","navigatorTitle":[{"text":"Input","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getlists\/input","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/Input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"role":"symbol","kind":"symbol","title":"Operations.GetLists.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLists":{"kind":"symbol","navigatorTitle":[{"text":"GetLists","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"GetLists","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.GetLists","abstract":[{"type":"text","text":"Get a list of lists of a user."}],"url":"\/documentation\/discogsservice\/operations\/getlists"},"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/GetLists/id":{"url":"\/documentation\/discogsservice\/operations\/getlists\/id","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"let","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/id","title":"id"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLists/AcceptableContentType":{"url":"\/documentation\/discogsservice\/operations\/getlists\/acceptablecontenttype","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AcceptableContentType"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/AcceptableContentType","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"title":"Operations.GetLists.AcceptableContentType"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLists/Output":{"type":"topic","navigatorTitle":[{"text":"Output","kind":"identifier"}],"url":"\/documentation\/discogsservice\/operations\/getlists\/output","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/Output","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Output"}],"role":"symbol","kind":"symbol","title":"Operations.GetLists.Output"}}} |