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
18 KiB
JSON
1 line
18 KiB
JSON
{"metadata":{"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"roleHeading":"Enumeration","role":"symbol","title":"Operations.PostChangeRatingOfRelease.Output","symbolKind":"enum","navigatorTitle":[{"text":"Output","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO6OutputO"},"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"kind":"attribute","text":"@frozen"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output"},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/NoContent-swift.struct"],"generated":true,"title":"Structures","anchor":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/forbidden(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/noContent(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/undocumented(statusCode:_:)"],"generated":true,"title":"Enumeration Cases","anchor":"Enumeration-Cases"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/forbidden","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/noContent-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/notFound"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/Equatable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output"]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease"]]},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/forbidden":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/forbidden","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/forbidden","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".forbidden","type":"codeVoice"},{"text":".","type":"text"}],"title":"forbidden","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotAccessable","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/internalServerError(_:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/internalservererror(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/internalServerError(_:)","abstract":[{"text":"An Internal Server error was encountered.","type":"text"}],"title":"Operations.PostChangeRatingOfRelease.Output.internalServerError(_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/noContent(_:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/nocontent(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/noContent(_:)","abstract":[{"text":"Successfully updated a rating for a specific release instance inside a collection folder of a user.","type":"text"}],"title":"Operations.PostChangeRatingOfRelease.Output.noContent(_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noContent","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostChangeRatingOfRelease","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO6OutputO"},{"text":".","kind":"text"},{"text":"NoContent","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO6OutputO9NoContentV"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output":{"abstract":[],"title":"Operations.PostChangeRatingOfRelease.Output","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"type":"topic","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/noContent-swift.property":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/nocontent-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/noContent-swift.property","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".noContent","type":"codeVoice"},{"text":".","type":"text"}],"title":"noContent","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"noContent","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"PostChangeRatingOfRelease","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO6OutputO"},{"text":".","kind":"text"},{"text":"NoContent","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25PostChangeRatingOfReleaseO6OutputO9NoContentV"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/NoContent-swift.struct":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/nocontent-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/NoContent-swift.struct","abstract":[],"title":"Operations.PostChangeRatingOfRelease.Output.NoContent","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NoContent","kind":"identifier"}],"navigatorTitle":[{"text":"NoContent","kind":"identifier"}]},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","type":"unresolvable","title":"Swift.Equatable"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/notFound":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/notfound","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/notFound","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".notFound","type":"codeVoice"},{"text":".","type":"text"}],"title":"notFound","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotFound","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"}]},"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/Output/internalServerError":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/internalservererror","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/internalServerError","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"code":"self","type":"codeVoice"},{"text":" is ","type":"text"},{"code":".internalServerError","type":"codeVoice"},{"text":".","type":"text"}],"title":"internalServerError","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"internalServerError","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"InternalError","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13InternalErrorV"}]},"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/PostChangeRatingOfRelease/Output/forbidden(_:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/forbidden(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/forbidden(_:)","abstract":[{"type":"text","text":"A requested resource cannot be accessed due to a lack of permission."}],"title":"Operations.PostChangeRatingOfRelease.Output.forbidden(_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"forbidden","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotAccessable","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO13NotAccessableV"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/Equatable-Implementations":{"role":"collectionGroup","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/Equatable-Implementations","abstract":[],"title":"Equatable Implementations","kind":"article"},"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/SH":{"identifier":"doc:\/\/DiscogsService\/SH","type":"unresolvable","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/undocumented(statusCode:_:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/undocumented(statuscode:_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/undocumented(statusCode:_:)","abstract":[{"type":"text","text":"Undocumented response."}],"title":"Operations.PostChangeRatingOfRelease.Output.undocumented(statusCode:_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"text":")","kind":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/PostChangeRatingOfRelease/Output/notFound(_:)":{"role":"symbol","type":"topic","url":"\/documentation\/discogsservice\/operations\/postchangeratingofrelease\/output\/notfound(_:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/PostChangeRatingOfRelease\/Output\/notFound(_:)","abstract":[{"type":"text","text":"A requested resource cannot be found."}],"title":"Operations.PostChangeRatingOfRelease.Output.notFound(_:)","kind":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"notFound","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Responses","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO"},{"text":".","kind":"text"},{"text":"NotFound","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO8NotFoundV"},{"text":")","kind":"text"}]},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","type":"unresolvable","title":"Swift.Sendable"}}} |