rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
de5b4ff5d0506f8354e28ef31060eb09f754aece
discogs-service/docs/data/documentation/discogsservice/components/headers.json
T
javier de5b4ff5d0 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>
2025-10-13 15:20:20 +00:00

1 line
5.6 KiB
JSON
Raw Blame History

{"schemaVersion":{"minor":3,"patch":0,"major":0},"topicSections":[{"generated":true,"title":"Type Aliases","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimit","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitRemaining","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitUsed"],"anchor":"Type-Aliases"}],"abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/headers"},{"text":" section of the OpenAPI document.","type":"text"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers"},"metadata":{"title":"Components.Headers","modules":[{"name":"DiscogsService"}],"symbolKind":"enum","externalID":"s:14DiscogsService10ComponentsO7HeadersO","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"roleHeading":"Enumeration","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"Headers","kind":"identifier"}]},"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/headers"]}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"]]},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"kind":"symbol","references":{"doc://DiscogsService/documentation/DiscogsService/Components/Headers/RateLimitRemaining":{"abstract":[{"text":"A number of remaining requests that can be made in an existing rate limit window.","type":"text"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"RateLimitRemaining","kind":"identifier"}],"title":"Components.Headers.RateLimitRemaining","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/headers\/ratelimitremaining","role":"symbol","navigatorTitle":[{"text":"RateLimitRemaining","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitRemaining"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/RateLimit":{"url":"\/documentation\/discogsservice\/components\/headers\/ratelimit","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"RateLimit"}],"title":"Components.Headers.RateLimit","navigatorTitle":[{"kind":"identifier","text":"RateLimit"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimit","kind":"symbol","abstract":[{"type":"text","text":"A total number of requests that can be made in a minute window."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers/Link":{"abstract":[{"text":"Contains URLs for pagination, compliant with RFC 5988.","type":"text"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Link","kind":"identifier"}],"title":"Components.Headers.Link","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/headers\/link","role":"symbol","navigatorTitle":[{"text":"Link","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/Link"},"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":{"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/Headers/RateLimitUsed":{"url":"\/documentation\/discogsservice\/components\/headers\/ratelimitused","role":"symbol","fragments":[{"kind":"keyword","text":"typealias"},{"kind":"text","text":" "},{"kind":"identifier","text":"RateLimitUsed"}],"title":"Components.Headers.RateLimitUsed","navigatorTitle":[{"kind":"identifier","text":"RateLimitUsed"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers\/RateLimitUsed","kind":"symbol","abstract":[{"type":"text","text":"A number of requests that have been made in an existing rate limit window."}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Headers":{"abstract":[{"text":"Types generated from the ","type":"text"},{"type":"codeVoice","code":"#\/components\/headers"},{"text":" section of the OpenAPI document.","type":"text"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Headers","kind":"identifier"}],"title":"Components.Headers","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/headers","role":"symbol","navigatorTitle":[{"text":"Headers","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Headers"}}}
View Git Blame Copy Permalink