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.1 KiB
JSON
1 line
7.1 KiB
JSON
{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetUserProfile","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV"},{"kind":"text","text":")"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/get(getUserProfile)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"style":"note","name":"Remark","type":"aside"},{"inlineContent":[{"text":"HTTP response code: ","type":"text"},{"code":"200 ok","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]}],"metadata":{"roleHeading":"Case","modules":[{"name":"DiscogsService"}],"symbolKind":"case","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO","text":"GetUserProfile","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"externalID":"s:14DiscogsService10OperationsO14GetUserProfileO6OutputO2okyA2G2OkVcAGmF","title":"Operations.GetUserProfile.Output.ok(_:)","role":"symbol"},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok(_:)"]}],"kind":"symbol","schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/ok(_:)"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output"]]},"abstract":[{"text":"Successfully retrieved profile user information by a given username.","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/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"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetUserProfile/Output/ok(_:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetUserProfile\/Output\/ok(_:)","fragments":[{"text":"case","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"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/getuserprofile\/output\/ok(_:)","role":"symbol","title":"Operations.GetUserProfile.Output.ok(_:)","type":"topic","abstract":[{"type":"text","text":"Successfully retrieved profile user information by a given username."}]},"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"}]}}} |