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
14 KiB
JSON
1 line
14 KiB
JSON
{"schemaVersion":{"major":0,"minor":3,"patch":0},"topicSections":[{"title":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/init(from:)"],"generated":true,"anchor":"Initializers"},{"title":"Instance Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/artist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/format","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/id","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/label","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/resourceUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/role","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/status","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/thumb","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/title","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/year"],"generated":true,"anchor":"Instance-Properties"},{"title":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/CodingKeys"],"generated":true,"anchor":"Enumerations"},{"title":"Default Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/Equatable-Implementations"],"generated":true,"anchor":"Default-Implementations"}],"abstract":[{"type":"text","text":"A type that represents a release of an artist."}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease","interfaceLanguage":"swift"},"metadata":{"title":"Components.Schemas.ArtistRelease","modules":[{"name":"DiscogsService"}],"symbolKind":"struct","externalID":"s:14DiscogsService10ComponentsO7SchemasO13ArtistReleaseV","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ArtistRelease"}],"roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistRelease"}]},"sections":[],"relationshipsSections":[{"kind":"relationships","title":"Conforms To","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ArtistRelease"}],"platforms":["macOS"]}]},{"kind":"content","content":[{"anchor":"overview","type":"heading","level":2,"text":"Overview"},{"style":"note","type":"aside","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/ArtistRelease"},{"type":"text","text":"."}],"type":"paragraph"}],"name":"Remark"}]}],"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/artistrelease"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/role":{"role":"symbol","title":"role","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/role","type":"topic","abstract":[{"text":"A role of a release.","type":"text"}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"role","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","preciseIdentifier":"s:SS","kind":"typeIdentifier"}],"url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/role","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"type":"topic","title":"Components.Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"navigatorTitle":[{"text":"Schemas","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Schemas","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/year":{"type":"topic","abstract":[{"type":"text","text":"A number of year of a release."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/year","title":"year","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/year","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"year"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":"?"}]},"doc://DiscogsService/Se":{"identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"navigatorTitle":[{"text":"Components","kind":"identifier"}],"title":"Components","url":"\/documentation\/discogsservice\/components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","abstract":[{"text":"Types generated from the components section of the OpenAPI document.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/Equatable-Implementations","abstract":[],"kind":"article","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/equatable-implementations","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/init(from:)":{"type":"topic","title":"init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/init(from:)","abstract":[],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/init(from:)","role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"kind":"keyword","text":"throws"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/label":{"type":"topic","title":"label","abstract":[{"text":"A label of a release.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/label","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/label","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"label"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ArtistRelease","kind":"identifier"}],"type":"topic","title":"Components.Schemas.ArtistRelease","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease","role":"symbol","abstract":[{"text":"A type that represents a release of an artist.","type":"text"}],"kind":"symbol","navigatorTitle":[{"text":"ArtistRelease","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/artist":{"abstract":[{"text":"A name for the artist of a release.","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"artist"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"artist","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/artist","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/artist"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/status":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/status","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"status"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"},{"kind":"text","text":"?"}],"title":"status","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/status","kind":"symbol","abstract":[{"type":"text","text":"A status of a release."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/thumb":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/thumb","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"thumb","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"thumb","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/thumb","kind":"symbol","abstract":[{"text":"A URL link to a thumbnail of a release.","type":"text"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/CodingKeys":{"type":"topic","abstract":[],"title":"Components.Schemas.ArtistRelease.CodingKeys","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/codingkeys","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/id":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/id","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"id","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Int","kind":"typeIdentifier","preciseIdentifier":"s:Si"}],"title":"id","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/id","kind":"symbol","abstract":[{"type":"text","text":"An identifier of a release."}],"type":"topic"},"doc://DiscogsService/SH":{"identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable","type":"unresolvable"},"doc://DiscogsService/SE":{"identifier":"doc:\/\/DiscogsService\/SE","title":"Swift.Encodable","type":"unresolvable"},"doc://DiscogsService/SQ":{"identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable","type":"unresolvable"},"doc://DiscogsService/s16SendableMetatypeP":{"identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/title":{"type":"topic","title":"title","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/title","abstract":[{"text":"A title of a release.","type":"text"}],"kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/title","role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"title"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}]},"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/Components/Schemas/ArtistRelease/resourceUrl":{"url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/resourceurl","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"resourceUrl","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"resourceUrl","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/resourceUrl","kind":"symbol","abstract":[{"type":"text","text":"A URI resource of a release."}],"type":"topic"},"doc://DiscogsService/s8SendableP":{"identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable","type":"unresolvable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ArtistRelease/format":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"format","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":"?","kind":"text"}],"title":"format","url":"\/documentation\/discogsservice\/components\/schemas\/artistrelease\/format","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ArtistRelease\/format","abstract":[{"type":"text","text":"A format of a release."}]}}} |