Files
discogs-service/docs/data/documentation/discogsservice/apiprotocol/getlist(path:headers:).json
T
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
19 KiB
JSON

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