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.5 KiB
JSON
1 line
7.5 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields","preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO","text":"GetCustomFields","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":" { ","kind":"text"},{"text":"get","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" }","kind":"text"}],"languages":["swift"]}]},{"content":[{"text":"Discussion","level":2,"anchor":"discussion","type":"heading"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"An error if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is not ","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"Throws","type":"aside"},{"style":"note","content":[{"type":"paragraph","inlineContent":[{"text":"","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}]}],"name":"See Also","type":"aside"}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output"]]},"kind":"symbol","schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output\/ok-swift.property","interfaceLanguage":"swift"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcustomfields\/output\/ok-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"modules":[{"name":"DiscogsService"}],"symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO","text":"GetCustomFields","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO2okAG2OkVvp","title":"ok","roleHeading":"Instance Property"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCustomFields/Output":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"title":"Operations.GetCustomFields.Output","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcustomfields\/output"},"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/GetCustomFields":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCustomFields"}],"title":"Operations.GetCustomFields","abstract":[{"text":"Get a list of custom fields defined by a user.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetCustomFields"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcustomfields"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCustomFields/Output/ok-swift.property":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output\/ok-swift.property","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO","text":"GetCustomFields"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetCustomFieldsO6OutputO2OkV","text":"Ok"}],"url":"\/documentation\/discogsservice\/operations\/getcustomfields\/output\/ok-swift.property","role":"symbol","title":"ok","type":"topic","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCustomFields/Output/Ok-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCustomFields.Output.Ok","url":"\/documentation\/discogsservice\/operations\/getcustomfields\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCustomFields\/Output\/Ok-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |