Implemented the missing Database endpoints (#8)

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>
This commit was merged in pull request #8.
This commit is contained in:
2025-10-13 15:20:20 +00:00
committed by Javier Cicchelli
parent d01b60e6dd
commit de5b4ff5d0
2291 changed files with 2450 additions and 2032 deletions
@@ -1 +1 @@
{"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"metadata":{"platforms":[{"unavailable":false,"beta":false,"deprecated":true,"renamed":"Servers.Server1.url"}],"role":"symbol","roleHeading":"Type Method","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"server1","kind":"identifier"},{"kind":"text","text":"() "},{"text":"throws","kind":"keyword"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"externalID":"s:14DiscogsService7ServersO7server110Foundation3URLVyKFZ","symbolKind":"method","title":"server1()"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"server1"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","text":"URL","preciseIdentifier":"s:10Foundation3URLV"}],"languages":["swift"],"platforms":["macOS"]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1()"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"Live Server"}],"references":{"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Servers/server1()":{"kind":"symbol","role":"symbol","deprecated":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()","fragments":[{"text":"static","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"server1"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier","text":"URL"}],"type":"topic","url":"\/documentation\/discogsservice\/servers\/server1()","title":"server1()","abstract":[{"type":"text","text":"Live Server"}]},"doc://DiscogsService/documentation/DiscogsService/Servers":{"title":"Servers","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Servers"}],"type":"topic","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Servers"}],"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"}}}
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"server1","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1()"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"text":"Live Server","type":"text"}],"metadata":{"role":"symbol","title":"server1()","platforms":[{"beta":false,"renamed":"Servers.Server1.url","deprecated":true,"unavailable":false}],"externalID":"s:14DiscogsService7ServersO7server110Foundation3URLVyKFZ","modules":[{"name":"DiscogsService"}],"roleHeading":"Type Method","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"server1","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"symbolKind":"method"},"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Servers":{"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"title":"Servers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService/Servers/server1()":{"url":"\/documentation\/discogsservice\/servers\/server1()","role":"symbol","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"server1","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"deprecated":true,"title":"server1()","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/server1()","abstract":[{"type":"text","text":"Live Server"}],"kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}}
@@ -1 +1 @@
{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"type":"text","text":"Live Server"}],"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"platforms":["macOS"],"languages":["swift"]}]}],"metadata":{"roleHeading":"Enumeration","symbolKind":"enum","externalID":"s:14DiscogsService7ServersO7Server1O","modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"kind":"identifier","text":"Server1"}],"role":"symbol","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"title":"Servers.Server1"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"topicSections":[{"title":"Type Methods","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"],"generated":true,"anchor":"Type-Methods"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"url":"\/documentation\/discogsservice\/servers\/server1","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Server1"}],"kind":"symbol","title":"Servers.Server1","abstract":[{"type":"text","text":"Live Server"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","abstract":[{"text":"Live Server","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"title":"url()","url":"\/documentation\/discogsservice\/servers\/server1\/url()"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"title":"Servers","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Servers"}],"type":"topic","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Servers"}],"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"}}}
{"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/servers\/server1"]}],"kind":"symbol","metadata":{"role":"symbol","navigatorTitle":[{"text":"Server1","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"roleHeading":"Enumeration","title":"Servers.Server1","symbolKind":"enum","externalID":"s:14DiscogsService7ServersO7Server1O","modules":[{"name":"DiscogsService"}]},"schemaVersion":{"patch":0,"major":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"]]},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"Server1"}]}]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"],"anchor":"Type-Methods","generated":true,"title":"Type Methods"}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","interfaceLanguage":"swift"},"sections":[],"abstract":[{"text":"Live Server","type":"text"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"type":"topic","title":"Servers.Server1","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","abstract":[{"type":"text","text":"Live Server"}],"navigatorTitle":[{"text":"Server1","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/servers\/server1","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}]},"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/Servers":{"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"title":"Servers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"abstract":[{"type":"text","text":"Live Server"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"title":"url()","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers\/server1\/url()","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"}}}
@@ -1 +1 @@
{"primaryContentSections":[{"declarations":[{"tokens":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"kind":"symbol","identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","interfaceLanguage":"swift"},"metadata":{"role":"symbol","externalID":"s:14DiscogsService7ServersO7Server1O3url10Foundation3URLVyKFZ","roleHeading":"Type Method","title":"url()","symbolKind":"method","modules":[{"name":"DiscogsService"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"preciseIdentifier":"s:10Foundation3URLV","text":"URL","kind":"typeIdentifier"}]},"abstract":[{"text":"Live Server","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"]]},"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/servers\/server1\/url()"]}],"references":{"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"url":"\/documentation\/discogsservice\/servers\/server1","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Server1"}],"kind":"symbol","title":"Servers.Server1","abstract":[{"type":"text","text":"Live Server"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Server1"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Servers":{"title":"Servers","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Servers"}],"type":"topic","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Servers"}],"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()","abstract":[{"text":"Live Server","type":"text"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"}],"title":"url()","url":"\/documentation\/discogsservice\/servers\/server1\/url()"}}}
{"variants":[{"paths":["\/documentation\/discogsservice\/servers\/server1\/url()"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}]}]}],"metadata":{"fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"url"},{"kind":"text","text":"() "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV","text":"URL"}],"title":"url()","role":"symbol","externalID":"s:14DiscogsService7ServersO7Server1O3url10Foundation3URLVyKFZ","roleHeading":"Type Method","modules":[{"name":"DiscogsService"}],"symbolKind":"method"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"kind":"symbol","abstract":[{"type":"text","text":"Live Server"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"},"sections":[],"references":{"doc://DiscogsService/documentation/DiscogsService/Servers":{"abstract":[{"type":"text","text":"Server URLs defined in the OpenAPI document."}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Servers","kind":"identifier"}],"title":"Servers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers","role":"symbol","navigatorTitle":[{"text":"Servers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1":{"type":"topic","title":"Servers.Server1","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1","abstract":[{"type":"text","text":"Live Server"}],"navigatorTitle":[{"text":"Server1","kind":"identifier"}],"kind":"symbol","url":"\/documentation\/discogsservice\/servers\/server1","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Server1","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Servers/Server1/url()":{"abstract":[{"type":"text","text":"Live Server"}],"fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"url","kind":"identifier"},{"text":"() ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"}],"title":"url()","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/servers\/server1\/url()","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1\/url()"},"doc://DiscogsService/documentation/DiscogsService":{"type":"topic","title":"DiscogsService","url":"\/documentation\/discogsservice","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}}