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
17 KiB
JSON
1 line
17 KiB
JSON
{"metadata":{"modules":[{"name":"DiscogsService"}],"extendedModule":"DiscogsService","roleHeading":"Instance Method","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"postUserProfile"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"text":"PostUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV4PathV"},{"kind":"text","text":", "},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV5QueryV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"kind":"text","text":"."},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","text":"PostUserProfile","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO","kind":"typeIdentifier"}],"role":"symbol","title":"postUserProfile(path:query:headers:)","externalID":"s:14DiscogsService11APIProtocolPAAE15postUserProfile4path5query7headersAA10OperationsO04PosteF0O6OutputOAK5InputV4PathV_AO5QueryVAO7HeadersVtYaKF::SYNTHESIZED::s:14DiscogsService6ClientV"},"sections":[],"variants":[{"paths":["\/documentation\/discogsservice\/client\/postuserprofile(path:query:headers:)"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Update information about a user.","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"postUserProfile","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"path"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input","kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV"},{"text":".","kind":"text"},{"text":"Path","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Path-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV4PathV"},{"text":", ","kind":"text"},{"text":"query","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Query-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV5QueryV"},{"text":" = .init(), ","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV","text":"Input","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Headers-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV7HeadersV","kind":"typeIdentifier"},{"text":" = .init()) ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostUserProfile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"text":".","kind":"text"},{"text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO"}],"platforms":["macOS"]}]},{"content":[{"anchor":"discussion","level":2,"text":"Discussion","type":"heading"},{"inlineContent":[{"text":"Edits some user profile information by username.","type":"text"}],"type":"paragraph"},{"inlineContent":[{"text":"This endpoint requires authentication.","type":"text"}],"type":"paragraph"},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"code":"POST \/users\/{username}","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]},{"style":"note","name":"Remark","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/users\/{username}\/post(postUserProfile)","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/postUserProfile(path:query:headers:)","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"kind":"symbol","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/PostUserProfile":{"type":"topic","navigatorTitle":[{"text":"PostUserProfile","kind":"identifier"}],"title":"Operations.PostUserProfile","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostUserProfile","kind":"identifier"}],"abstract":[{"text":"Update information about a user.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","role":"symbol","url":"\/documentation\/discogsservice\/operations\/postuserprofile"},"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/PostUserProfile/Input/Path-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.PostUserProfile.Input.Path","abstract":[],"url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input\/path-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Client/postUserProfile(path:query:headers:)":{"type":"topic","url":"\/documentation\/discogsservice\/client\/postuserprofile(path:query:headers:)","abstract":[{"type":"text","text":"Update information about a user."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/postUserProfile(path:query:headers:)","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"text":"postUserProfile","kind":"identifier"},{"kind":"text","text":"("},{"text":"path","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Path","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV4PathV"},{"kind":"text","text":", "},{"kind":"externalParam","text":"query"},{"kind":"text","text":": "},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"kind":"text","text":"."},{"text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Query","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV5QueryV","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Input","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV7HeadersV","kind":"typeIdentifier"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","text":"PostUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO"},{"kind":"text","text":"."},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15PostUserProfileO6OutputO","kind":"typeIdentifier"}],"role":"symbol","kind":"symbol","title":"postUserProfile(path:query:headers:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Input":{"url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input","kind":"symbol","abstract":[],"type":"topic","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input","navigatorTitle":[{"text":"Input","kind":"identifier"}],"title":"Operations.PostUserProfile.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Input/Query-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Query-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.PostUserProfile.Input.Query","abstract":[],"url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input\/query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Input/Headers-swift.struct":{"kind":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Headers-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"role":"symbol","type":"topic","title":"Operations.PostUserProfile.Input.Headers","abstract":[],"url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input\/headers-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Output":{"type":"topic","navigatorTitle":[{"text":"Output","kind":"identifier"}],"title":"Operations.PostUserProfile.Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Output","role":"symbol","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/output"},"doc://DiscogsService/documentation/DiscogsService/Client":{"type":"topic","navigatorTitle":[{"text":"Client","kind":"identifier"}],"title":"Client","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Client","kind":"identifier"}],"abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"text":"Artists","type":"text"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"text":"Releases","type":"text"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"text":"Labels","type":"text"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"text":"Wantlists","type":"text"}],"type":"emphasis"},{"type":"text","text":", create "},{"type":"emphasis","inlineContent":[{"text":"Marketplace","type":"text"}]},{"type":"text","text":" listings, and more."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","url":"\/documentation\/discogsservice\/client"}}} |