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
13 KiB
JSON
1 line
13 KiB
JSON
{"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/service"],"traits":[{"interfaceLanguage":"swift"}]}],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"kind":"symbol","metadata":{"modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"text":"Service","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Service","kind":"identifier"}],"roleHeading":"Structure","symbolKind":"struct","title":"Components.Schemas.Service","externalID":"s:14DiscogsService10ComponentsO7SchemasO0B0V","role":"symbol"},"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas"]]},"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Service","kind":"identifier"}],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Overview","type":"heading","level":2,"anchor":"overview"},{"type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/Service"},{"type":"text","text":"."}]}],"name":"Remark"}]}],"topicSections":[{"title":"Structures","generated":true,"anchor":"Structures","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload"]},{"title":"Initializers","generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/init(apiVersion:documentationUrl:hello:statistics:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/init(from:)"]},{"title":"Instance Properties","generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/apiVersion","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/documentationUrl","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/hello","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/statistics"]},{"title":"Enumerations","generated":true,"anchor":"Enumerations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys"]},{"title":"Default Implementations","generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/Equatable-Implementations"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service"},"sections":[],"abstract":[{"text":"A type that encapsulates any available information about the service.","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/CodingKeys":{"url":"\/documentation\/discogsservice\/components\/schemas\/service\/codingkeys","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CodingKeys","kind":"identifier"}],"title":"Components.Schemas.Service.CodingKeys","navigatorTitle":[{"text":"CodingKeys","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/CodingKeys","kind":"symbol","abstract":[],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/Equatable-Implementations":{"type":"topic","role":"collectionGroup","kind":"article","title":"Equatable Implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/Equatable-Implementations","url":"\/documentation\/discogsservice\/components\/schemas\/service\/equatable-implementations","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/documentationUrl":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"documentationUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"documentationUrl","url":"\/documentation\/discogsservice\/components\/schemas\/service\/documentationurl","abstract":[{"text":"A URI link to the Developers’ documentation available online.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/documentationUrl"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/apiVersion":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apiVersion","kind":"identifier"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"}],"title":"apiVersion","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/apiVersion","url":"\/documentation\/discogsservice\/components\/schemas\/service\/apiversion","abstract":[{"text":"A current API version of the service.","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StatisticsPayload","kind":"identifier"}],"navigatorTitle":[{"text":"StatisticsPayload","kind":"identifier"}],"title":"Components.Schemas.Service.StatisticsPayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload","url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload","abstract":[{"text":"A type that encapsulates statistical data about the service.","type":"text"}]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"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/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE"},"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/Service/statistics":{"role":"symbol","title":"statistics","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/statistics","type":"topic","abstract":[{"type":"text","text":"A type that encapsulates statistical data about the service."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"statistics","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Service","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B0V"},{"text":".","kind":"text"},{"text":"StatisticsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B0V17StatisticsPayloadV"}],"url":"\/documentation\/discogsservice\/components\/schemas\/service\/statistics","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/hello":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"hello"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"String","preciseIdentifier":"s:SS"}],"title":"hello","url":"\/documentation\/discogsservice\/components\/schemas\/service\/hello","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/hello","abstract":[{"text":"A welcome message send by the service.","type":"text"}]},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/init(from:)":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"from","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"Decoder","kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"title":"init(from:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/init(from:)","url":"\/documentation\/discogsservice\/components\/schemas\/service\/init(from:)","abstract":[]},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"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/Service/init(apiVersion:documentationUrl:hello:statistics:)":{"type":"topic","role":"symbol","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"apiVersion","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"documentationUrl","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"hello","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"String","kind":"typeIdentifier","preciseIdentifier":"s:SS"},{"text":", ","kind":"text"},{"text":"statistics","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"Service","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B0V"},{"text":".","kind":"text"},{"text":"StatisticsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO0B0V17StatisticsPayloadV"},{"text":")","kind":"text"}],"title":"init(apiVersion:documentationUrl:hello:statistics:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/init(apiVersion:documentationUrl:hello:statistics:)","url":"\/documentation\/discogsservice\/components\/schemas\/service\/init(apiversion:documentationurl:hello:statistics:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Service"},{"text":".","type":"text"}]},"doc://DiscogsService/Se":{"type":"unresolvable","title":"Swift.Decodable","identifier":"doc:\/\/DiscogsService\/Se"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service":{"url":"\/documentation\/discogsservice\/components\/schemas\/service","role":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Service","kind":"identifier"}],"title":"Components.Schemas.Service","navigatorTitle":[{"text":"Service","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service","kind":"symbol","abstract":[{"text":"A type that encapsulates any available information about the service.","type":"text"}],"type":"topic"},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"}}} |