Files
javier eaee2b84f0 Documentation update (#17)
This PR contains the work done to update the overall documentation of the package.

Reviewed-on: #17
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2026-03-24 01:54:43 +00:00

1 line
6.2 KiB
JSON

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