rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
d01b60e6dd16d15055a60dc75ebeac2da9e134f4
discogs-service/docs/data/documentation/discogsservice.json
T
javier d01b60e6dd Added the Rate Limiting headers (#7) 
This PR contains the work done to define the `RateLimit`, `RateLimitRemaining` and the `RateLimitUsed` heades into the Open API specification document, as well as including these headers as part of the response for every existing endpoint declared in the mentioned document.

In addition, the `openapi-generator-config` files was also changed to have a different naming strategy.

Reviewed-on: #7
Co-authored-by: Javier Cicchelli <javier@rock-n-code.com>
Co-committed-by: Javier Cicchelli <javier@rock-n-code.com>
2025-10-13 13:09:10 +00:00

1 line
9.6 KiB
JSON
Raw Blame History

{"sections":[],"hierarchy":{"paths":[[]]},"metadata":{"symbolKind":"module","roleHeading":"Framework","modules":[{"name":"DiscogsService"}],"role":"collection","title":"DiscogsService","externalID":"DiscogsService"},"kind":"symbol","primaryContentSections":[{"content":[{"anchor":"Overview","text":"Overview","level":2,"type":"heading"}],"kind":"content"}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"],"anchor":"Clients","title":"Clients"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers\/Server1"],"anchor":"Servers","title":"Servers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"],"anchor":"Authentication","title":"Authentication"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product"],"anchor":"User-Agent","title":"User Agent"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers"],"anchor":"Types","title":"Types"},{"title":"Errors","anchor":"Errors","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError"]},{"title":"Protocols","anchor":"Protocols","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice"]}],"schemaVersion":{"minor":3,"patch":0,"major":0},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"references":{"doc://DiscogsService/documentation/DiscogsService/APIProtocol":{"kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"APIProtocol"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/APIProtocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"APIProtocol"}],"url":"\/documentation\/discogsservice\/apiprotocol","type":"topic","title":"APIProtocol","abstract":[{"type":"text","text":"A type that performs HTTP operations defined by the OpenAPI document."}]},"doc://DiscogsService/documentation/DiscogsService/Components":{"url":"\/documentation\/discogsservice\/components","title":"Components","role":"symbol","abstract":[{"type":"text","text":"Types generated from the components section of the OpenAPI document."}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Components","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","navigatorTitle":[{"kind":"identifier","text":"Components"}],"kind":"symbol"},"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/AuthMethod":{"abstract":[{"type":"text","text":"A representation of the available authentication methods at the Discogs service."}],"role":"symbol","navigatorTitle":[{"text":"AuthMethod","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthMethod","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authmethod","title":"AuthMethod"},"doc://DiscogsService/documentation/DiscogsService/AuthTransport":{"abstract":[{"text":"A representation of the available transport options to send credentials in authenticated requests.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"AuthTransport","kind":"identifier"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"AuthTransport","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authtransport","title":"AuthTransport"},"doc://DiscogsService/documentation/DiscogsService/Client":{"url":"\/documentation\/discogsservice\/client","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"kind":"symbol","title":"Client","abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"type":"text","text":"Artists"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"Releases"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"type":"text","text":"Wantlists"}],"type":"emphasis"},{"text":", create ","type":"text"},{"inlineContent":[{"type":"text","text":"Marketplace"}],"type":"emphasis"},{"text":" listings, and more.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic"},"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/AuthMiddleware":{"abstract":[{"text":"A middleware that attaches any defined authentication credentials into the requests to the service.","type":"text"}],"role":"symbol","navigatorTitle":[{"text":"AuthMiddleware","kind":"identifier"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AuthMiddleware"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authmiddleware","title":"AuthMiddleware"},"doc://DiscogsService/documentation/DiscogsService/Operations":{"kind":"symbol","abstract":[{"type":"text","text":"API operations, with input and output types, generated from "},{"code":"#\/paths","type":"codeVoice"},{"type":"text","text":" in the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Operations"}],"type":"topic","url":"\/documentation\/discogsservice\/operations","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Operations"}],"title":"Operations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},"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/UserAgentMiddleware":{"role":"symbol","abstract":[{"text":"A middleware that attaches the user agent header into the requests to the service.","type":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/useragentmiddleware","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"UserAgentMiddleware","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware","navigatorTitle":[{"text":"UserAgentMiddleware","kind":"identifier"}],"title":"UserAgentMiddleware"},"doc://DiscogsService/documentation/DiscogsService/Product":{"role":"symbol","abstract":[{"text":"A type that represents a product that uses the ","type":"text"},{"isActive":true,"type":"reference","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"},{"text":" client.","type":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/product","kind":"symbol","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Product","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product","navigatorTitle":[{"text":"Product","kind":"identifier"}],"title":"Product"},"doc://DiscogsService/documentation/DiscogsService/InputValidationError":{"navigatorTitle":[{"text":"InputValidationError","kind":"identifier"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"InputValidationError","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/InputValidationError","url":"\/documentation\/discogsservice\/inputvalidationerror","role":"symbol","type":"topic","abstract":[{"type":"text","text":"A representation of all the possible validation error that could be thrown while validating an input."}],"title":"InputValidationError"}}}
View Git Blame Copy Permalink