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.1 KiB
JSON
1 line
8.1 KiB
JSON
{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"relationshipsSections":[{"title":"Conforms To","type":"conformsTo","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getrelease\/input\/query-swift.struct"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"type":"heading","anchor":"overview","level":2,"text":"Overview"},{"content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/releases\/{release_id}\/GET\/query"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside","style":"note","name":"Remark"}]}],"metadata":{"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Query","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"struct","role":"symbol","navigatorTitle":[{"text":"Query","kind":"identifier"}],"roleHeading":"Structure","externalID":"s:14DiscogsService10OperationsO10GetReleaseO5InputV5QueryV","title":"Operations.GetRelease.Input.Query"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input"]]},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct\/init(currAbbr:)"],"title":"Initializers","generated":true,"anchor":"Initializers"},{"anchor":"Instance-Properties","title":"Instance Properties","generated":true,"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct\/currAbbr"]},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct\/Equatable-Implementations"],"title":"Default Implementations","generated":true,"anchor":"Default-Implementations"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Input/Query-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct","type":"topic","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"Query"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Query"}],"abstract":[],"title":"Operations.GetRelease.Input.Query","role":"symbol","url":"\/documentation\/discogsservice\/operations\/getrelease\/input\/query-swift.struct"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Input/Query-swift.struct/Equatable-Implementations":{"title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getrelease\/input\/query-swift.struct\/equatable-implementations","type":"topic","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct\/Equatable-Implementations","kind":"article","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Input/Query-swift.struct/init(currAbbr:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct\/init(currAbbr:)","kind":"symbol","fragments":[{"kind":"identifier","text":"init"},{"text":"(","kind":"text"},{"text":"currAbbr","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters"},{"text":".","kind":"text"},{"text":"Currency","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8Currencya"},{"kind":"text","text":"?)"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getrelease\/input\/query-swift.struct\/init(currabbr:)","role":"symbol","title":"init(currAbbr:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Query"},{"type":"text","text":"."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Input":{"url":"\/documentation\/discogsservice\/operations\/getrelease\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input","role":"symbol","navigatorTitle":[{"text":"Input","kind":"identifier"}],"kind":"symbol","title":"Operations.GetRelease.Input","abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Input","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/s16SendableMetatypeP":{"title":"Swift.SendableMetatype","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease":{"kind":"symbol","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetRelease"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetRelease"}],"type":"topic","url":"\/documentation\/discogsservice\/operations\/getrelease","title":"Operations.GetRelease","abstract":[{"text":"Get information about a release","type":"text"}]},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SQ":{"title":"Swift.Equatable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetRelease/Input/Query-swift.struct/currAbbr":{"kind":"symbol","role":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetRelease\/Input\/Query-swift.struct\/currAbbr","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"currAbbr"},{"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:14DiscogsService10ComponentsO10ParametersO8Currencya","text":"Currency"},{"kind":"text","text":"?"}],"url":"\/documentation\/discogsservice\/operations\/getrelease\/input\/query-swift.struct\/currabbr","type":"topic","title":"currAbbr","abstract":[{"type":"text","text":"A currency code in the marketplace."}]},"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/SH":{"title":"Swift.Hashable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/s8SendableP":{"title":"Swift.Sendable","type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP"}}} |