rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
703d65616322792449acdb9012dabf749c21a0a0
discogs-service/docs/data/documentation/discogsservice/useragentmiddleware.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
7.2 KiB
JSON
Raw Blame History

{"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"externalID":"s:14DiscogsService19UserAgentMiddlewareV","modules":[{"name":"DiscogsService"}],"role":"symbol","roleHeading":"Structure","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserAgentMiddleware"}],"symbolKind":"struct","navigatorTitle":[{"text":"UserAgentMiddleware","kind":"identifier"}],"title":"UserAgentMiddleware"},"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/14OpenAPIRuntime16ClientMiddlewareP","doc:\/\/DiscogsService\/s8CopyableP","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"sections":[],"abstract":[{"text":"A middleware that attaches the user agent header into the requests to the service.","type":"text"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"UserAgentMiddleware"}],"languages":["swift"]}]},{"kind":"content","content":[{"text":"Overview","level":2,"type":"heading","anchor":"overview"},{"inlineContent":[{"type":"text","text":"Please refer to the "},{"type":"reference","isActive":true,"identifier":"https:\/\/www.discogs.com\/developers\/#page:home,header:home-general-information"},{"type":"text","text":" for further information."}],"type":"paragraph"}]}],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"topicSections":[{"title":"Initializers","anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware\/init(product:)"],"generated":true},{"title":"Default Implementations","anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware\/ClientMiddleware-Implementations"],"generated":true}],"seeAlsoSections":[{"title":"User Agent","anchor":"User-Agent","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Product"],"generated":true}],"variants":[{"paths":["\/documentation\/discogsservice\/useragentmiddleware"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware"},"references":{"https://www.discogs.com/developers/#page:home,header:home-general-information":{"type":"link","identifier":"https:\/\/www.discogs.com\/developers\/#page:home,header:home-general-information","title":"Discogs documentation","titleInlineContent":[{"text":"Discogs documentation","type":"text"}],"url":"https:\/\/www.discogs.com\/developers\/#page:home,header:home-general-information"},"doc://DiscogsService/s8CopyableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8CopyableP","title":"Swift.Copyable"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"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/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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"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/UserAgentMiddleware/ClientMiddleware-Implementations":{"role":"collectionGroup","abstract":[],"type":"topic","url":"\/documentation\/discogsservice\/useragentmiddleware\/clientmiddleware-implementations","kind":"article","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware\/ClientMiddleware-Implementations","title":"ClientMiddleware Implementations"},"doc://DiscogsService/14OpenAPIRuntime16ClientMiddlewareP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/14OpenAPIRuntime16ClientMiddlewareP","title":"OpenAPIRuntime.ClientMiddleware"},"doc://DiscogsService/documentation/DiscogsService/UserAgentMiddleware/init(product:)":{"role":"symbol","abstract":[{"text":"Initializes this middleware.","type":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/useragentmiddleware\/init(product:)","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"product","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Product","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService7ProductV"},{"text":") ","kind":"text"},{"text":"throws","kind":"keyword"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/UserAgentMiddleware\/init(product:)","title":"init(product:)"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"}}}
View Git Blame Copy Permalink