d01b60e6dd
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>
1 line
8.4 KiB
JSON
1 line
8.4 KiB
JSON
{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct"]]},"schemaVersion":{"minor":3,"major":0,"patch":0},"metadata":{"role":"symbol","modules":[{"name":"DiscogsService"}],"roleHeading":"Instance Property","fragments":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"released","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier","text":"Components"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier","text":"Parameters"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Releaseda","kind":"typeIdentifier","text":"Released"},{"text":"?","kind":"text"}],"externalID":"s:14DiscogsService10OperationsO17GetMasterVersionsO5InputV5QueryV8releasedSSSgvp","symbolKind":"property","title":"released"},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct\/released","interfaceLanguage":"swift"},"primaryContentSections":[{"declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"text":"var","kind":"keyword"},{"kind":"text","text":" "},{"text":"released","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","text":"Released","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Releaseda","kind":"typeIdentifier"},{"text":"?","kind":"text"}]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","text":"Discussion","level":2,"anchor":"discussion"},{"style":"note","type":"aside","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/masters\/{master_id}\/versions\/GET\/query\/released","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct\/released"],"traits":[{"interfaceLanguage":"swift"}]}],"abstract":[{"type":"text","text":"A filter by release year."}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/Released":{"kind":"symbol","role":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/Released","abstract":[{"text":"A filter by release year.","type":"text"}],"fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Released","kind":"identifier"}],"title":"Components.Parameters.Released","url":"\/documentation\/discogsservice\/components\/parameters\/released","navigatorTitle":[{"text":"Released","kind":"identifier"}]},"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/GetMasterVersions/Input/Query-swift.struct/released":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct\/released","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"released","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":"Released","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Releaseda"},{"text":"?","kind":"text"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct\/released","title":"released","abstract":[{"text":"A filter by release year.","type":"text"}]},"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/Operations/GetMasterVersions/Input":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","title":"Operations.GetMasterVersions.Input","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions/Input/Query-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions\/input\/query-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions\/Input\/Query-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"kind":"symbol","title":"Operations.GetMasterVersions.Input.Query","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetMasterVersions":{"url":"\/documentation\/discogsservice\/operations\/getmasterversions","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetMasterVersions","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetMasterVersions"}],"kind":"symbol","title":"Operations.GetMasterVersions","abstract":[{"text":"Get information about the versions of a master release.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetMasterVersions"}],"type":"topic"},"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"}}} |