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.4 KiB
JSON
1 line
7.4 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO","text":"GetUserProfile","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO","text":"Output","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV","text":"Ok","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/Ok-swift.struct"},{"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":".ok"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"},{"name":"See Also","type":"aside","content":[{"inlineContent":[{"text":"","type":"text"},{"type":"codeVoice","code":".ok"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note"}]}],"metadata":{"roleHeading":"Instance Property","symbolKind":"property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2okAG2OkVvp","title":"ok","role":"symbol"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok-swift.property"],"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\/GetUserProfile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output"]]},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/ok-swift.property","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"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Output":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output","abstract":[],"title":"Operations.GetUserProfile.Output","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"navigatorTitle":[{"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/Operations/GetUserProfile":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getuserprofile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile","abstract":[{"text":"Get information about a user.","type":"text"}],"title":"Operations.GetUserProfile","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetUserProfile","kind":"identifier"}],"navigatorTitle":[{"text":"GetUserProfile","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Output/ok-swift.property":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetUserProfile","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV"}],"title":"ok","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"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/ok-swift.property","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok-swift.property","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Output/Ok-swift.struct":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/Ok-swift.struct","abstract":[],"title":"Operations.GetUserProfile.Output.Ok","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"navigatorTitle":[{"text":"Ok","kind":"identifier"}]},"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"}}} |