rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
63118db805e7bff35c338323d2bf8818ffbdfa28
discogs-service/docs/data/documentation/discogsservice/apiprotocol/getlists(_:).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
Raw Blame History

{"sections":[],"kind":"symbol","seeAlsoSections":[{"generated":true,"anchor":"User-Lists","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLists(path:query:headers:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getList(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getList(path:headers:)"],"title":"User Lists"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol\/getLists(_:)"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getLists"},{"kind":"text","text":"("},{"kind":"externalParam","text":"_"},{"kind":"text","text":" "},{"kind":"internalParam","text":"input"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetLists","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetLists","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO8GetListsO6OutputO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLists\/Output"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"inlineContent":[{"text":"Returns a list of lists created by a users.","type":"text"}],"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":"paragraph"},{"style":"note","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"}]}],"kind":"content"}],"metadata":{"required":true,"fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"getLists","kind":"identifier"},{"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":"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"}],"roleHeading":"Instance Method","role":"symbol","title":"getLists(_:)","externalID":"s:14DiscogsService11APIProtocolP8getListsyAA10OperationsO03GetE0O6OutputOAH5InputVYaKF","symbolKind":"method","modules":[{"name":"DiscogsService"}]},"abstract":[{"text":"Get a list of lists of a user.","type":"text"}],"variants":[{"paths":["\/documentation\/discogsservice\/apiprotocol\/getlists(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"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":{"url":"\/documentation\/discogsservice","role":"collection","abstract":[],"title":"DiscogsService","type":"topic","kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"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/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/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"},"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:)"},"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/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/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(_:)"}}}
View Git Blame Copy Permalink