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

{"metadata":{"navigatorTitle":[{"text":"AuthTransport","kind":"identifier"}],"role":"symbol","modules":[{"name":"DiscogsService"}],"roleHeading":"Enumeration","title":"AuthTransport","symbolKind":"enum","externalID":"s:14DiscogsService13AuthTransportO","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthTransport"}]},"abstract":[{"type":"text","text":"A representation of the available transport options to send credentials in authenticated requests."}],"seeAlsoSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMiddleware","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthMethod"],"title":"Authentication","anchor":"Authentication","generated":true}],"relationshipsSections":[{"identifiers":["doc:\/\/DiscogsService\/s12CaseIterableP","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","type":"conformsTo","kind":"relationships"}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"AuthTransport"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport"},"sections":[],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService"]]},"variants":[{"paths":["\/documentation\/discogsservice\/authtransport"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport\/onHeader","doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport\/onQuery"],"title":"Enumeration Cases","anchor":"Enumeration-Cases","generated":true},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport\/Equatable-Implementations"],"title":"Default Implementations","anchor":"Default-Implementations","generated":true}],"references":{"doc://DiscogsService/documentation/DiscogsService/AuthTransport/Equatable-Implementations":{"abstract":[],"role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport\/Equatable-Implementations","type":"topic","kind":"article","url":"\/documentation\/discogsservice\/authtransport\/equatable-implementations","title":"Equatable Implementations"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"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/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"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/s12CaseIterableP":{"type":"unresolvable","title":"Swift.CaseIterable","identifier":"doc:\/\/DiscogsService\/s12CaseIterableP"},"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/AuthTransport/onHeader":{"url":"\/documentation\/discogsservice\/authtransport\/onheader","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport\/onHeader","role":"symbol","kind":"symbol","title":"AuthTransport.onHeader","abstract":[{"text":"Authentication credential are sent in a request as an ","type":"text"},{"code":"Authentication","type":"codeVoice"},{"text":" header.","type":"text"}],"fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onHeader","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/AuthTransport/onQuery":{"abstract":[{"type":"text","text":"Authentication credential are sent in a request as parameters in the query string."}],"role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"onQuery","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/AuthTransport\/onQuery","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/authtransport\/onquery","title":"AuthTransport.onQuery"}}}
View Git Blame Copy Permalink