rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
d01b60e6dd16d15055a60dc75ebeac2da9e134f4
discogs-service/docs/data/documentation/discogsservice/client/init(serverurl:configuration:transport:middlewares:).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.1 KiB
JSON
Raw Blame History

{"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"abstract":[{"type":"text","text":"Creates a new client."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/client\/init(serverurl:configuration:transport:middlewares:)"]}],"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/init(serverURL:configuration:transport:middlewares:)","interfaceLanguage":"swift"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"serverURL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"text":"configuration","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Configuration","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV"},{"text":" = .init(), ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"text":", ","kind":"text"},{"text":"middlewares","kind":"externalParam"},{"text":": [any ","kind":"text"},{"text":"ClientMiddleware","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP"},{"text":"] = [])","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"The server URL that the client connects to. Any server","type":"text"},{"text":" ","type":"text"},{"text":"URLs defined in the OpenAPI document are available as static methods","type":"text"},{"text":" ","type":"text"},{"text":"on the ","type":"text"},{"isActive":true,"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Servers","type":"reference"},{"text":" type.","type":"text"}]}],"name":"serverURL"},{"content":[{"type":"paragraph","inlineContent":[{"text":"A set of configuration values for the client.","type":"text"}]}],"name":"configuration"},{"content":[{"type":"paragraph","inlineContent":[{"text":"A transport that performs HTTP operations.","type":"text"}]}],"name":"transport"},{"content":[{"type":"paragraph","inlineContent":[{"text":"A list of middlewares to call before the transport.","type":"text"}]}],"name":"middlewares"}],"kind":"parameters"}],"metadata":{"modules":[{"name":"DiscogsService"}],"title":"init(serverURL:configuration:transport:middlewares:)","externalID":"s:14DiscogsService6ClientV9serverURL13configuration9transport11middlewaresAC10Foundation0E0V_14OpenAPIRuntime13ConfigurationVAK0C9Transport_pSayAK0C10Middleware_pGtcfc","role":"symbol","symbolKind":"init","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"serverURL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","kind":"typeIdentifier","preciseIdentifier":"s:10Foundation3URLV"},{"text":", ","kind":"text"},{"text":"configuration","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Configuration","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV"},{"text":", ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP"},{"text":", ","kind":"text"},{"text":"middlewares","kind":"externalParam"},{"text":": [any ","kind":"text"},{"text":"ClientMiddleware","kind":"typeIdentifier","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP"},{"text":"])","kind":"text"}],"roleHeading":"Initializer"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"references":{"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":{"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"},"doc://DiscogsService/documentation/DiscogsService/Client/init(serverURL:configuration:transport:middlewares:)":{"title":"init(serverURL:configuration:transport:middlewares:)","url":"\/documentation\/discogsservice\/client\/init(serverurl:configuration:transport:middlewares:)","type":"topic","abstract":[{"type":"text","text":"Creates a new client."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/init(serverURL:configuration:transport:middlewares:)","kind":"symbol","role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"serverURL","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"URL","preciseIdentifier":"s:10Foundation3URLV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"configuration","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Configuration","preciseIdentifier":"s:14OpenAPIRuntime13ConfigurationV","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"transport","kind":"externalParam"},{"text":": any ","kind":"text"},{"text":"ClientTransport","preciseIdentifier":"s:14OpenAPIRuntime15ClientTransportP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"middlewares","kind":"externalParam"},{"text":": [any ","kind":"text"},{"text":"ClientMiddleware","preciseIdentifier":"s:14OpenAPIRuntime16ClientMiddlewareP","kind":"typeIdentifier"},{"text":"])","kind":"text"}]}}}
View Git Blame Copy Permalink