Files
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
8.3 KiB
JSON

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct"]]},"metadata":{"title":"page","modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"page","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Page","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Pagea"},{"text":"?","kind":"text"}],"symbolKind":"property","roleHeading":"Instance Property","externalID":"s:14DiscogsService10OperationsO16GetLabelReleasesO5InputV5QueryV4pageSiSgvp"},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct\/page"},"kind":"symbol","abstract":[{"text":"A number of page of results to return.","type":"text"}],"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"page","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"Page","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Pagea"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"content":[{"text":"Discussion","type":"heading","level":2,"anchor":"discussion"},{"type":"aside","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"text":"Generated from ","type":"text"},{"code":"#\/paths\/labels\/{label_id}\/releases\/GET\/query\/page","type":"codeVoice"},{"text":".","type":"text"}]}],"style":"note"}],"kind":"content"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct\/page"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"references":{"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/Operations/GetLabelReleases/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct","abstract":[],"type":"topic","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct","title":"Operations.GetLabelReleases.Input.Query"},"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/Components/Parameters":{"title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","role":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"text":" section of the OpenAPI document.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","navigatorTitle":[{"kind":"identifier","text":"Parameters"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Page":{"type":"topic","url":"\/documentation\/discogsservice\/components\/parameters\/page","abstract":[{"type":"text","text":"A number of page of results to return."}],"title":"Components.Parameters.Page","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Page","kind":"symbol","role":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Page","kind":"identifier"}],"navigatorTitle":[{"text":"Page","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases":{"abstract":[{"text":"Get information about the releases of a label.","type":"text"}],"kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetLabelReleases","kind":"identifier"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getlabelreleases","role":"symbol","navigatorTitle":[{"text":"GetLabelReleases","kind":"identifier"}],"title":"Operations.GetLabelReleases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases"},"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/GetLabelReleases/Input":{"url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input","abstract":[],"type":"topic","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input","title":"Operations.GetLabelReleases.Input"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetLabelReleases/Input/Query-swift.struct/page":{"type":"topic","title":"page","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetLabelReleases\/Input\/Query-swift.struct\/page","kind":"symbol","url":"\/documentation\/discogsservice\/operations\/getlabelreleases\/input\/query-swift.struct\/page","abstract":[{"text":"A number of page of results to return.","type":"text"}],"role":"symbol","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"page"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO4Pagea","text":"Page"},{"kind":"text","text":"?"}]}}}