de5b4ff5d0
This PR contains the work done to declare the missing, non-GET endpoints of the *Database* section in the [Discogs API documentation](https://www.discogs.com/developers#page:database) into the `OpenAPI` specification document. Furthermore, documentation extensions have been defined for the `APIProtocol` and `Client` types in the `DocC` documentation catalog to match the categories of these endpoint calls to the categories in the Discogs documentation. Reviewed-on: #8 Co-authored-by: Javier Cicchelli <javier@rock-n-code.com> Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
1 line
17 KiB
JSON
1 line
17 KiB
JSON
{"topicSections":[{"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/Ok-swift.struct"],"title":"Structures","generated":true},{"anchor":"Enumeration-Cases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/internalServerError(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/notFound(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/ok(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/unauthorized(_:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/undocumented(statusCode:_:)"],"title":"Enumeration Cases","generated":true},{"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/internalServerError","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/notFound","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/ok-swift.property","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/unauthorized"],"title":"Instance Properties","generated":true},{"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/Equatable-Implementations"],"title":"Default Implementations","generated":true}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output","interfaceLanguage":"swift"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"@frozen","kind":"attribute"},{"kind":"text","text":" "},{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output"]}],"metadata":{"role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"externalID":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO6OutputO","modules":[{"name":"DiscogsService"}],"title":"Operations.DeleteReleaseRatingByUser.Output","navigatorTitle":[{"kind":"identifier","text":"Output"}],"symbolKind":"enum","roleHeading":"Enumeration"},"kind":"symbol","relationshipsSections":[{"type":"conformsTo","kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","title":"Operations","type":"topic","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"type":"codeVoice","code":"#\/paths"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"url":"\/documentation\/discogsservice\/operations","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/internalServerError(_:)":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/internalServerError(_:)","title":"Operations.DeleteReleaseRatingByUser.Output.internalServerError(_:)","type":"topic","abstract":[{"type":"text","text":"An Internal Server error was encountered."}],"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"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/internalservererror(_:)","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/Ok-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/ok-swift.struct","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"title":"Operations.DeleteReleaseRatingByUser.Output.Ok","navigatorTitle":[{"text":"Ok","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/Ok-swift.struct","abstract":[],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/notFound":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/notFound","title":"notFound","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".notFound"},{"type":"text","text":"."}],"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"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/notfound","kind":"symbol"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/Equatable-Implementations":{"role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/Equatable-Implementations","title":"Equatable Implementations","type":"topic","abstract":[],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/equatable-implementations","kind":"article"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/unauthorized(_:)":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/unauthorized(_:)","title":"Operations.DeleteReleaseRatingByUser.Output.unauthorized(_:)","type":"topic","abstract":[{"type":"text","text":"A requested resource cannot be accessed."}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","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":"Unauthorized","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO12UnauthorizedV"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/unauthorized(_:)","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/internalServerError":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/internalServerError","title":"internalServerError","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".internalServerError"},{"type":"text","text":"."}],"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"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/internalservererror","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/unauthorized":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/unauthorized","title":"unauthorized","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".unauthorized"},{"type":"text","text":"."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"unauthorized","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":"Unauthorized","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO9ResponsesO12UnauthorizedV"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/unauthorized","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/notFound(_:)":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/notFound(_:)","title":"Operations.DeleteReleaseRatingByUser.Output.notFound(_:)","type":"topic","abstract":[{"type":"text","text":"A requested resource cannot be found."}],"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"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/notfound(_:)","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output":{"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"title":"Operations.DeleteReleaseRatingByUser.Output","navigatorTitle":[{"text":"Output","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output","kind":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/ok(_:)":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/ok(_:)","title":"Operations.DeleteReleaseRatingByUser.Output.ok(_:)","type":"topic","abstract":[{"type":"text","text":"Successfully deleted a rating for a specific release by a given user."}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO6OutputO2OkV"},{"text":")","kind":"text"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/ok(_:)","kind":"symbol"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/undocumented(statusCode:_:)":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/undocumented(statusCode:_:)","title":"Operations.DeleteReleaseRatingByUser.Output.undocumented(statusCode:_:)","type":"topic","abstract":[{"type":"text","text":"Undocumented response."}],"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"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/undocumented(statuscode:_:)","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser":{"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser","role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"DeleteReleaseRatingByUser"}],"title":"Operations.DeleteReleaseRatingByUser","navigatorTitle":[{"kind":"identifier","text":"DeleteReleaseRatingByUser"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser","abstract":[{"type":"text","text":"Delete information about a rating of release by a user."}],"kind":"symbol","type":"topic"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Operations/DeleteReleaseRatingByUser/Output/ok-swift.property":{"role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/DeleteReleaseRatingByUser\/Output\/ok-swift.property","title":"ok","type":"topic","abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ok","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"DeleteReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO6OutputO"},{"text":".","kind":"text"},{"text":"Ok","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO25DeleteReleaseRatingByUserO6OutputO2OkV"}],"url":"\/documentation\/discogsservice\/operations\/deletereleaseratingbyuser\/output\/ok-swift.property","kind":"symbol"}}} |