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
8.4 KiB
JSON
1 line
8.4 KiB
JSON
{"schemaVersion":{"major":0,"patch":0,"minor":3},"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct"]]},"abstract":[{"text":"An identifier of a release.","type":"text"}],"metadata":{"title":"releaseId","roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releaseId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"ReleaseId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda"}],"role":"symbol","externalID":"s:14DiscogsService10OperationsO22PutReleaseRatingByUserO5InputV4PathV9releaseIdSivp","modules":[{"name":"DiscogsService"}],"symbolKind":"property"},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/path-swift.struct\/releaseid"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releaseId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"text":".","kind":"text"},{"text":"ReleaseId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"text":"Discussion","anchor":"discussion","type":"heading"},{"style":"note","name":"Remark","content":[{"inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/releases\/{release_id}\/rating\/{username}\/PUT\/path\/release_id","type":"codeVoice"},{"text":".","type":"text"}],"type":"paragraph"}],"type":"aside"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct\/releaseId"},"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input":{"abstract":[],"title":"Operations.PutReleaseRatingByUser.Input","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"type":"topic","kind":"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":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters":{"navigatorTitle":[{"text":"Parameters","kind":"identifier"}],"type":"topic","title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Parameters","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Types generated from the ","type":"text"},{"code":"#\/components\/parameters","type":"codeVoice"},{"text":" section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}],"title":"Components","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Components"}],"role":"symbol","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Path-swift.struct":{"abstract":[],"title":"Operations.PutReleaseRatingByUser.Input.Path","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/path-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser/Input/Path-swift.struct/releaseId":{"abstract":[{"text":"An identifier of a release.","type":"text"}],"title":"releaseId","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"releaseId"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda","text":"ReleaseId"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser\/Input\/Path-swift.struct\/releaseId","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser\/input\/path-swift.struct\/releaseid","type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PutReleaseRatingByUser":{"navigatorTitle":[{"kind":"identifier","text":"PutReleaseRatingByUser"}],"type":"topic","title":"Operations.PutReleaseRatingByUser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PutReleaseRatingByUser","url":"\/documentation\/discogsservice\/operations\/putreleaseratingbyuser","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PutReleaseRatingByUser","kind":"identifier"}],"kind":"symbol","role":"symbol","abstract":[{"text":"Update information about a rating of release by a user.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ReleaseId":{"abstract":[{"text":"An identifier of a release.","type":"text"}],"title":"Components.Parameters.ReleaseId","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseId"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","url":"\/documentation\/discogsservice\/components\/parameters\/releaseid","navigatorTitle":[{"kind":"identifier","text":"ReleaseId"}],"type":"topic","kind":"symbol"}}} |