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
7.9 KiB
JSON
1 line
7.9 KiB
JSON
{"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier","text":"Components"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses","kind":"typeIdentifier","text":"Responses"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound","kind":"typeIdentifier","text":"NotFound"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"anchor":"discussion","level":2,"type":"heading","text":"Discussion"},{"name":"Throws","content":[{"inlineContent":[{"text":"An error if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is not ","type":"text"},{"type":"codeVoice","code":".notFound"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside","style":"note"},{"name":"See Also","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":".notFound"},{"text":".","type":"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\/GetMaster","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output"]]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getmaster\/output\/notfound"]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"metadata":{"symbolKind":"property","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"notFound"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotFound","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"}],"role":"symbol","roleHeading":"Instance Property","title":"notFound","externalID":"s:14DiscogsService10OperationsO9GetMasterO6OutputO8notFoundAA10ComponentsO9ResponsesO03NotH0Vvp"},"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"code":"self","type":"codeVoice"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output\/notFound","interfaceLanguage":"swift"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetMaster/Output":{"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"text":"Output","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetMaster.Output","url":"\/documentation\/discogsservice\/operations\/getmaster\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output","role":"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/GetMaster":{"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"GetMaster","kind":"identifier"}],"navigatorTitle":[{"text":"GetMaster","kind":"identifier"}],"abstract":[{"text":"Get information about a master release.","type":"text"}],"kind":"symbol","type":"topic","title":"Operations.GetMaster","url":"\/documentation\/discogsservice\/operations\/getmaster","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Responses/NotFound":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"NotFound"}],"title":"Components.Responses.NotFound","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/NotFound","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"NotFound"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/responses\/notfound"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMaster/Output/notFound":{"url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/notfound","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","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:14DiscogsService10ComponentsO9ResponsesO8NotFoundV","text":"NotFound","kind":"typeIdentifier"}],"kind":"symbol","title":"notFound","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output\/notFound","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}],"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/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"}]}}} |