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
6.9 KiB
JSON
1 line
6.9 KiB
JSON
{"sections":[],"metadata":{"roleHeading":"Case","modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO9GetMasterO6OutputO2okyA2G2OkVcAGmF","symbolKind":"case","title":"Operations.GetMaster.Output.ok(_:)","role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO","text":"GetMaster"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO6OutputO2OkV","text":"Ok"},{"kind":"text","text":")"}]},"abstract":[{"text":"Successfully retrieved master release details.","type":"text"}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":"("},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO","text":"GetMaster"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO6OutputO2OkV","text":"Ok"},{"kind":"text","text":")"}],"languages":["swift"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"style":"note","name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/masters\/{master_id}\/get(getMaster)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside"},{"inlineContent":[{"type":"text","text":"HTTP response code: "},{"code":"200 ok","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmaster\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output\/ok(_:)"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetMaster/Output/Ok-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output\/Ok-swift.struct","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/ok-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"title":"Operations.GetMaster.Output.Ok","type":"topic","abstract":[]},"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/Output/ok(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMaster\/Output\/ok(_:)","kind":"symbol","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":"GetMaster","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO9GetMasterO6OutputO2OkV"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/getmaster\/output\/ok(_:)","role":"symbol","title":"Operations.GetMaster.Output.ok(_:)","type":"topic","abstract":[{"text":"Successfully retrieved master release details.","type":"text"}]},"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":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |