2a7b9746a7
This PR contains the work done to implement the *User Collection* endpoints of the Discogs API into the `OpenAPI` specification document:
* GET `/users/{username}/collection/folders`
* POST `/users/{username}/collection/folders`
* GET `/users/{username}/collection/folders/{folder_id}`
* POST `/users/{username}/collection/folders/{folder_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}`
* GET `/users/{username}/collection/releases/{release_id}`
* GET `/users/{username}/collection/folders/{folder_id}/releases`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* DELETE `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}`
* GET `/users/{username}/collection/fields`
* POST `/users/{username}/collection/folders/{folder_id}/releases/{release_id}/instances/{instance_id}/fields/{field_id}`
* GET `/users/{username}/collection/value`
Reviewed-on: #12
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
8.2 KiB
JSON
1 line
8.2 KiB
JSON
{"metadata":{"role":"symbol","externalID":"s:14DiscogsService10OperationsO15PostUserProfileO5InputV4PathV8usernameAISS_tcfc","title":"init(username:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea","text":"Username","kind":"typeIdentifier"},{"text":")","kind":"text"}],"symbolKind":"init","roleHeading":"Initializer","modules":[{"name":"DiscogsService"}]},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"username"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Username","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea"},{"text":")","kind":"text"}],"languages":["swift"]}],"kind":"declarations"},{"parameters":[{"content":[{"inlineContent":[{"text":"A username of a user.","type":"text"}],"type":"paragraph"}],"name":"username"}],"kind":"parameters"}],"schemaVersion":{"patch":0,"major":0,"minor":3},"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Path","type":"codeVoice"},{"type":"text","text":"."}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Path-swift.struct\/init(username:)"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postuserprofile\/input\/path-swift.struct\/init(username:)"]}],"kind":"symbol","sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Path-swift.struct"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Input":{"url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","title":"Operations.PostUserProfile.Input","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components":{"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"role":"symbol","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"text":" in the OpenAPI document.","type":"text"}],"title":"Operations","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Operations","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","url":"\/documentation\/discogsservice\/operations","navigatorTitle":[{"text":"Operations","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Input/Path-swift.struct/init(username:)":{"fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Username","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea"},{"text":")","kind":"text"}],"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Path"},{"type":"text","text":"."}],"kind":"symbol","type":"topic","title":"init(username:)","url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input\/path-swift.struct\/init(username:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Path-swift.struct\/init(username:)","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Username":{"url":"\/documentation\/discogsservice\/components\/parameters\/username","navigatorTitle":[{"kind":"identifier","text":"Username"}],"type":"topic","abstract":[{"type":"text","text":"A username of a user."}],"kind":"symbol","title":"Components.Parameters.Username","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Username","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"Username"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile":{"navigatorTitle":[{"text":"PostUserProfile","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostUserProfile","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/postuserprofile","title":"Operations.PostUserProfile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile","abstract":[{"text":"Update information about a user.","type":"text"}],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostUserProfile/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/postuserprofile\/input\/path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"navigatorTitle":[{"text":"Path","kind":"identifier"}],"kind":"symbol","title":"Operations.PostUserProfile.Input.Path","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostUserProfile\/Input\/Path-swift.struct","abstract":[],"role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"type":"topic","title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/parameters","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]}}} |