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
14 KiB
JSON
1 line
14 KiB
JSON
{"sections":[],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}]}],"kind":"declarations"},{"content":[{"level":2,"text":"Overview","type":"heading","anchor":"overview"},{"name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"type":"codeVoice","code":"#\/paths\/users\/{username}\/collection\/folders\/{folder_id}\/releases\/{release_id}\/instances\/{instance_id}\/POST\/path"},{"text":".","type":"text"}]}],"type":"aside","style":"note"}],"kind":"content"}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To","kind":"relationships"}],"kind":"symbol","metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"role":"symbol","title":"Operations.PostChangeRatingOfRelease.Input.Path","symbolKind":"struct","externalID":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO5InputV4PathV","roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"Path","kind":"identifier"}]},"topicSections":[{"anchor":"Initializers","title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/init(username:folderId:releaseId:instanceId:)"],"generated":true},{"anchor":"Instance-Properties","title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/folderId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/instanceId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/releaseId","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/username"],"generated":true},{"anchor":"Default-Implementations","title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/Equatable-Implementations"],"generated":true}],"schemaVersion":{"patch":0,"minor":3,"major":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input":{"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input","kind":"symbol","abstract":[],"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input","navigatorTitle":[{"kind":"identifier","text":"Input"}],"title":"Operations.PostChangeRatingOfRelease.Input","type":"topic"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/releaseId":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releaseId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda","text":"ReleaseId","kind":"typeIdentifier"}],"title":"releaseId","abstract":[{"text":"An identifier of a release.","type":"text"}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/releaseId","role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/releaseid"},"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/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","type":"unresolvable","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/folderId":{"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/folderid","abstract":[{"text":"An identifier of a collection folder.","type":"text"}],"type":"topic","kind":"symbol","title":"folderId","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/folderId","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"folderId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"FolderId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8FolderIda","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/instanceId":{"fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"instanceId","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"InstanceId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO10InstanceIda"}],"type":"topic","kind":"symbol","role":"symbol","title":"instanceId","abstract":[{"text":"An identifier of a release instance.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/instanceId","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/instanceid"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/username":{"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/username","type":"topic","kind":"symbol","abstract":[{"text":"A username of a user.","type":"text"}],"title":"username","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/username","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"username","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea","text":"Username","kind":"typeIdentifier"}]},"doc://DiscogsService/documentation/DiscogsService":{"url":"\/documentation\/discogsservice","abstract":[],"kind":"symbol","type":"topic","title":"DiscogsService","role":"collection","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease":{"abstract":[{"text":"Update a rating for a specified release instance in a specified collection folder of a user.","type":"text"}],"title":"Operations.PostChangeRatingOfRelease","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease","navigatorTitle":[{"text":"PostChangeRatingOfRelease","kind":"identifier"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/equatable-implementations","type":"topic","kind":"article","abstract":[],"title":"Equatable Implementations","role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/Equatable-Implementations"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct/init(username:folderId:releaseId:instanceId:)":{"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct\/init(username:folderid:releaseid:instanceid:)","type":"topic","kind":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Path"},{"text":".","type":"text"}],"title":"init(username:folderId:releaseId:instanceId:)","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct\/init(username:folderId:releaseId:instanceId:)","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"username","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Usernamea","text":"Username","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"folderId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8FolderIda","text":"FolderId","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"releaseId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda","text":"ReleaseId","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"instanceId","kind":"externalParam"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO10InstanceIda","text":"InstanceId","kind":"typeIdentifier"},{"text":")","kind":"text"}]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Input/Path-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/input\/path-swift.struct","navigatorTitle":[{"text":"Path","kind":"identifier"}],"type":"topic","kind":"symbol","abstract":[],"title":"Operations.PostChangeRatingOfRelease.Input.Path","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Input\/Path-swift.struct","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}]}}} |