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":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO","text":"Responses","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV","text":"InternalError","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}]}]},{"kind":"content","content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"name":"Throws","type":"aside","content":[{"inlineContent":[{"text":"An error if ","type":"text"},{"type":"codeVoice","code":"self"},{"text":" is not ","type":"text"},{"type":"codeVoice","code":".internalServerError"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"},{"name":"See Also","type":"aside","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":".internalServerError"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"}]}],"metadata":{"roleHeading":"Instance Property","modules":[{"name":"DiscogsService"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"}],"externalID":"s:14DiscogsService10OperationsO21PostCollectionFoldersO6OutputO19internalServerErrorAA10ComponentsO9ResponsesO08InternalJ0Vvp","title":"internalServerError","role":"symbol"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/internalservererror"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","schemaVersion":{"patch":0,"minor":3,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/internalServerError","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".internalServerError","type":"codeVoice"},{"text":".","type":"text"}],"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/Components/Responses/InternalError":{"abstract":[],"title":"Components.Responses.InternalError","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"InternalError"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Responses\/InternalError","url":"\/documentation\/discogsservice\/components\/responses\/internalerror","navigatorTitle":[{"kind":"identifier","text":"InternalError"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders/Output":{"url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[],"title":"Operations.PostCollectionFolders.Output","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}]},"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"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders/Output/internalServerError":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders\/output\/internalservererror","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders\/Output\/internalServerError","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".internalServerError"},{"type":"text","text":"."}],"title":"internalServerError","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostCollectionFolders":{"navigatorTitle":[{"text":"PostCollectionFolders","kind":"identifier"}],"type":"topic","title":"Operations.PostCollectionFolders","url":"\/documentation\/discogsservice\/operations\/postcollectionfolders","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostCollectionFolders","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostCollectionFolders","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Create a new collection folder for a user.","type":"text"}]}}} |