rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
d01b60e6dd16d15055a60dc75ebeac2da9e134f4
discogs-service/docs/data/documentation/discogsservice/operations/getreleasestats/output/ok-swift.property.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.5 KiB
JSON
Raw Blame History

{"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO","text":"GetReleaseStats"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/Ok-swift.struct","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2OkV","text":"Ok"},{"kind":"text","text":" { "},{"kind":"keyword","text":"get"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" }"}],"platforms":["macOS"],"languages":["swift"]}]},{"kind":"content","content":[{"anchor":"discussion","type":"heading","level":2,"text":"Discussion"},{"name":"Throws","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"An error if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is not "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}]}]},{"name":"See Also","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":""},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}]}]}]}],"sections":[],"kind":"symbol","schemaVersion":{"major":0,"minor":3,"patch":0},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/ok-swift.property","interfaceLanguage":"swift"},"metadata":{"role":"symbol","modules":[{"name":"DiscogsService"}],"symbolKind":"property","title":"ok","roleHeading":"Instance Property","externalID":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2okAG2OkVvp","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"ok"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO","text":"GetReleaseStats"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO","text":"Output"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2OkV","text":"Ok"}]},"abstract":[{"type":"text","text":"The associated value of the enum case if "},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"type":"codeVoice","code":".ok"},{"type":"text","text":"."}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output"]]},"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.property"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"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/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/Operations/GetReleaseStats/Output/Ok-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.struct","title":"Operations.GetReleaseStats.Output.Ok","role":"symbol","abstract":[],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Ok","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/Ok-swift.struct","navigatorTitle":[{"kind":"identifier","text":"Ok"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetReleaseStats"}],"kind":"symbol","title":"Operations.GetReleaseStats","abstract":[{"type":"text","text":"Get information about statistics of release."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetReleaseStats"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/Output":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","title":"Operations.GetReleaseStats.Output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/Output/ok-swift.property":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output\/ok-swift.property","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output\/ok-swift.property","role":"symbol","kind":"symbol","title":"ok","abstract":[{"text":"The associated value of the enum case if ","type":"text"},{"type":"codeVoice","code":"self"},{"type":"text","text":" is "},{"code":".ok","type":"codeVoice"},{"text":".","type":"text"}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"text":"ok","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"GetReleaseStats","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Output","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Ok","preciseIdentifier":"s:14DiscogsService10OperationsO15GetReleaseStatsO6OutputO2OkV"}],"type":"topic"}}}
View Git Blame Copy Permalink