Files
discogs-service/docs/data/documentation/discogsservice/apiprotocol/getlist(_:).json
T
javier 63118db805 Implemented the User Lists endpoints (#14)
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>
2025-10-16 17:33:15 +00:00

1 line
16 KiB
JSON

{"metadata":{"roleHeading":"Instance Method","required":true,"title":"getList(_:)","symbolKind":"method","modules":[{"name":"DiscogsService"}],"role":"symbol","externalID":"s:14DiscogsService11APIProtocolP7getListyAA10OperationsO03GetE0O6OutputOAH5InputVYaKF","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getList","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetList","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV","text":"Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO","text":"GetList","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO6OutputO","text":"Output","kind":"typeIdentifier"}]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/apiprotocol\/getlist(_:)"]}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getList","kind":"identifier"},{"text":"(","kind":"text"},{"text":"_","kind":"externalParam"},{"text":" ","kind":"text"},{"text":"input","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetList","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList\/Input","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetList","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList\/Output","kind":"typeIdentifier"}],"languages":["swift"]}],"kind":"declarations"},{"content":[{"type":"heading","level":2,"text":"Discussion","anchor":"discussion"},{"type":"paragraph","inlineContent":[{"text":"Returns items from a specified list.","type":"text"}]},{"type":"paragraph","inlineContent":[{"text":"Private lists are not shown unless a user is authenticated as an owner.","type":"text"}]},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/lists\/{list_id}"},{"type":"text","text":"."}]}]},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/\/lists\/{list_id}\/get(getList)"},{"text":".","type":"text"}]}],"name":"Remark"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"sections":[],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"type":"text","text":"Get items from a specified list."}],"kind":"symbol","seeAlsoSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLists(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLists(path:query:headers:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getList(path:headers:)"],"title":"User Lists","anchor":"User-Lists","generated":true}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getList(_:)","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getLists(path:query:headers:)":{"type":"topic","title":"getLists(path:query:headers:)","kind":"symbol","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLists","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLists","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLists","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV"},{"text":".","kind":"text"},{"text":"Query","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV5QueryV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLists","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLists","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO6OutputO"}],"abstract":[{"type":"text","text":"Get a list of lists of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLists(path:query:headers:)","role":"symbol","url":"\/documentation\/discogsservice\/apiprotocol\/getlists(path:query:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetList/Input":{"url":"\/documentation\/discogsservice\/operations\/getlist\/input","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.GetList.Input"},"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/GetList/Output":{"url":"\/documentation\/discogsservice\/operations\/getlist\/output","abstract":[],"title":"Operations.GetList.Output","type":"topic","role":"symbol","navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList\/Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetList":{"type":"topic","navigatorTitle":[{"text":"GetList","kind":"identifier"}],"title":"Operations.GetList","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetList","kind":"identifier"}],"abstract":[{"text":"Get items from a specified list.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetList","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getlist"},"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/APIProtocol/getLists(_:)":{"type":"topic","url":"\/documentation\/discogsservice\/apiprotocol\/getlists(_:)","abstract":[{"type":"text","text":"Get a list of lists of a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLists(_:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLists"},{"kind":"text","text":"("},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLists","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetLists","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO6OutputO"}],"role":"symbol","kind":"symbol","title":"getLists(_:)"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getList(_:)":{"type":"topic","url":"\/documentation\/discogsservice\/apiprotocol\/getlist(_:)","abstract":[{"type":"text","text":"Get items from a specified list."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getList(_:)","required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getList","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetList","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetList","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO6OutputO"}],"role":"symbol","kind":"symbol","title":"getList(_:)"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"url":"\/documentation\/discogsservice\/apiprotocol","kind":"symbol","abstract":[{"text":"A type that performs HTTP operations defined by the OpenAPI document.","type":"text"}],"type":"topic","role":"symbol","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"APIProtocol","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","navigatorTitle":[{"text":"APIProtocol","kind":"identifier"}],"title":"APIProtocol"},"doc://DiscogsService/documentation/DiscogsService/APIProtocol/getList(path:headers:)":{"type":"topic","url":"\/documentation\/discogsservice\/apiprotocol\/getlist(path:headers:)","abstract":[{"type":"text","text":"Get items from a specified list."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getList(path:headers:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getList","kind":"identifier"},{"text":"(","kind":"text"},{"text":"path","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetList","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV"},{"text":".","kind":"text"},{"text":"Path","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetList","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV"},{"text":".","kind":"text"},{"text":"Headers","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO5InputV7HeadersV"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetList","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO7GetListO6OutputO"}],"role":"symbol","kind":"symbol","title":"getList(path:headers:)"}}}