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.7 KiB
JSON
1 line
7.7 KiB
JSON
{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output"]]},"abstract":[{"text":"Successfully retrieved a list of collection items that contains a specified release.","type":"text"}],"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output\/ok(_:)","interfaceLanguage":"swift"},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"case","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\/GetCollectionItemsByRelease","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","text":"GetCollectionItemsByRelease","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO","text":"Output","kind":"typeIdentifier"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output\/Ok-swift.struct","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO2OkV","text":"Ok","kind":"typeIdentifier"},{"text":")","kind":"text"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/\/users\/{username}\/collection\/releases\/{release_id}\/get(getCollectionItemsByRelease)\/responses\/200","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}]},{"inlineContent":[{"type":"text","text":"HTTP response code: "},{"code":"200 ok","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output\/ok(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"metadata":{"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:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO","text":"GetCollectionItemsByRelease"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO2OkV","text":"Ok"},{"kind":"text","text":")"}],"title":"Operations.GetCollectionItemsByRelease.Output.ok(_:)","roleHeading":"Case","role":"symbol","symbolKind":"case","externalID":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO2okyA2G2OkVcAGmF","modules":[{"name":"DiscogsService"}]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Output":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output","title":"Operations.GetCollectionItemsByRelease.Output","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"navigatorTitle":[{"kind":"identifier","text":"Output"}]},"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":{"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/GetCollectionItemsByRelease":{"role":"symbol","type":"topic","abstract":[{"type":"text","text":"Get collection items of a user that contains a given release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease","title":"Operations.GetCollectionItemsByRelease","kind":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetCollectionItemsByRelease"}],"navigatorTitle":[{"kind":"identifier","text":"GetCollectionItemsByRelease"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Output/ok(_:)":{"fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetCollectionItemsByRelease","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO27GetCollectionItemsByReleaseO6OutputO2OkV"},{"text":")","kind":"text"}],"title":"Operations.GetCollectionItemsByRelease.Output.ok(_:)","abstract":[{"type":"text","text":"Successfully retrieved a list of collection items that contains a specified release."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output\/ok(_:)","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output\/ok(_:)"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetCollectionItemsByRelease/Output/Ok-swift.struct":{"role":"symbol","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetCollectionItemsByRelease\/Output\/Ok-swift.struct","url":"\/documentation\/discogsservice\/operations\/getcollectionitemsbyrelease\/output\/ok-swift.struct","title":"Operations.GetCollectionItemsByRelease.Output.Ok","kind":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Ok"}],"navigatorTitle":[{"kind":"identifier","text":"Ok"}]}}} |