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
12 KiB
JSON
1 line
12 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct"]]},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct\/init(headers:body:)"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV7HeadersV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct\/Headers-swift.struct"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV4BodyO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct\/Body-swift.enum"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"parameters","parameters":[{"content":[{"inlineContent":[{"type":"text","text":"Received HTTP response headers"}],"type":"paragraph"}],"name":"headers"},{"content":[{"inlineContent":[{"type":"text","text":"Received HTTP response body"}],"type":"paragraph"}],"name":"body"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionvalue\/output\/ok-swift.struct\/init(headers:body:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"roleHeading":"Initializer","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Headers","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV7HeadersV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetCollectionValue","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Body","preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV4BodyO","kind":"typeIdentifier"},{"text":")","kind":"text"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV7headers4bodyA2I7HeadersV_AI4BodyOtcfc","title":"init(headers:body:)","role":"symbol"},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Output/Ok-swift.struct":{"navigatorTitle":[{"text":"Ok","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/output\/ok-swift.struct","title":"Operations.GetCollectionValue.Output.Ok","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct","abstract":[],"role":"symbol"},"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/GetCollectionValue/Output/Ok-swift.struct/init(headers:body:)":{"type":"topic","title":"init(headers:body:)","url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/output\/ok-swift.struct\/init(headers:body:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct\/init(headers:body:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"headers","kind":"externalParam"},{"kind":"text","text":": "},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","text":"GetCollectionValue","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV7HeadersV","text":"Headers","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"body","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO","text":"GetCollectionValue","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10OperationsO18GetCollectionValueO6OutputO2OkV4BodyO","text":"Body","kind":"typeIdentifier"},{"kind":"text","text":")"}],"kind":"symbol","role":"symbol","abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"Ok"},{"type":"text","text":"."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Output":{"navigatorTitle":[{"text":"Output","kind":"identifier"}],"type":"topic","title":"Operations.GetCollectionValue.Output","url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue":{"navigatorTitle":[{"text":"GetCollectionValue","kind":"identifier"}],"type":"topic","title":"Operations.GetCollectionValue","url":"\/documentation\/discogsservice\/operations\/getcollectionvalue","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetCollectionValue","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Get the estimated monetary value for a collection of a user.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Output/Ok-swift.struct/Headers-swift.struct":{"fragments":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Headers"}],"navigatorTitle":[{"text":"Headers","kind":"identifier"}],"abstract":[],"kind":"symbol","type":"topic","title":"Operations.GetCollectionValue.Output.Ok.Headers","url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/output\/ok-swift.struct\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct\/Headers-swift.struct","role":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionValue/Output/Ok-swift.struct/Body-swift.enum":{"navigatorTitle":[{"text":"Body","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Body","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionvalue\/output\/ok-swift.struct\/body-swift.enum","title":"Operations.GetCollectionValue.Output.Ok.Body","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionValue\/Output\/Ok-swift.struct\/Body-swift.enum","abstract":[],"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"}}} |