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.4 KiB
JSON
1 line
8.4 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"forbidden"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Responses","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotAccessable","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotAccessable","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}]}]},{"content":[{"level":2,"text":"Discussion","type":"heading","anchor":"discussion"},{"name":"Throws","content":[{"inlineContent":[{"type":"text","text":"An error if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is not "},{"code":".forbidden","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"},{"name":"See Also","content":[{"inlineContent":[{"type":"text","text":""},{"code":".forbidden","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output\/forbidden"]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"modules":[{"name":"DiscogsService"}],"title":"forbidden","externalID":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO9forbiddenAA10ComponentsO9ResponsesO13NotAccessableVvp","symbolKind":"property","role":"symbol","roleHeading":"Instance Property","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Responses","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"NotAccessable","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV"}]},"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".forbidden","type":"codeVoice"},{"text":".","type":"text"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output\/forbidden","interfaceLanguage":"swift"},"references":{"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/GetCollectionItemsByRelease/Output/forbidden":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV","text":"NotAccessable","kind":"typeIdentifier"}],"type":"topic","kind":"symbol","role":"symbol","title":"forbidden","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".forbidden","type":"codeVoice"},{"text":".","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output\/forbidden","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output\/forbidden"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Get collection items of a user that contains a given release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease","title":"Operations.GetCollectionItemsByRelease","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionItemsByRelease"}],"navigatorTitle":[{"kind":"identifier","text":"GetCollectionItemsByRelease"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotAccessable":{"navigatorTitle":[{"text":"NotAccessable","kind":"identifier"}],"type":"topic","title":"Components.Responses.NotAccessable","url":"\/documentation\/discogsservice\/components\/responses\/notaccessable","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotAccessable","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NotAccessable","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[]},"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/Operations/GetCollectionItemsByRelease/Output":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output","title":"Operations.GetCollectionItemsByRelease.Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}]},"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/Components/Responses":{"navigatorTitle":[{"text":"Responses","kind":"identifier"}],"type":"topic","title":"Components.Responses","url":"\/documentation\/discogsservice\/components\/responses","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Responses","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/responses","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]}}} |