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
6.8 KiB
JSON
1 line
6.8 KiB
JSON
{"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/init(mainRelease:mainReleaseUrl:versionsUrl:)","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mainRelease"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"mainReleaseUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil, "},{"kind":"externalParam","text":"versionsUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"? = nil)"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"name":"mainRelease","content":[{"type":"paragraph","inlineContent":[{"text":"An identifier of the main release for this master.","type":"text"}]}]},{"name":"mainReleaseUrl","content":[{"type":"paragraph","inlineContent":[{"text":"A URL link of the main release for this master.","type":"text"}]}]},{"name":"versionsUrl","content":[{"type":"paragraph","inlineContent":[{"text":"A URL link to the versions of this master.","type":"text"}]}]}]}],"abstract":[{"text":"Creates a new ","type":"text"},{"code":"Value2Payload","type":"codeVoice"},{"text":".","type":"text"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload"]]},"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/init(mainrelease:mainreleaseurl:versionsurl:)"]}],"metadata":{"role":"symbol","symbolKind":"init","title":"init(mainRelease:mainReleaseUrl:versionsUrl:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mainRelease"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"mainReleaseUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"versionsUrl"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"},{"kind":"text","text":"?)"}],"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService10ComponentsO7SchemasO6MasterV13Value2PayloadV11mainRelease0hI3Url08versionsJ0AISiSg_SSSgANtcfc","roleHeading":"Initializer"},"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload/init(mainRelease:mainReleaseUrl:versionsUrl:)":{"role":"symbol","title":"init(mainRelease:mainReleaseUrl:versionsUrl:)","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Value2Payload","type":"codeVoice"},{"text":".","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"mainRelease"},{"kind":"text","text":": "},{"preciseIdentifier":"s:Si","kind":"typeIdentifier","text":"Int"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"mainReleaseUrl"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?, "},{"kind":"externalParam","text":"versionsUrl"},{"kind":"text","text":": "},{"preciseIdentifier":"s:SS","kind":"typeIdentifier","text":"String"},{"kind":"text","text":"?)"}],"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload\/init(mainrelease:mainreleaseurl:versionsurl:)","kind":"symbol","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload\/init(mainRelease:mainReleaseUrl:versionsUrl:)"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas":{"url":"\/documentation\/discogsservice\/components\/schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Schemas"}],"kind":"symbol","title":"Components.Schemas","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/schemas"},{"type":"text","text":" section of the OpenAPI document."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Schemas"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master/Value2Payload":{"url":"\/documentation\/discogsservice\/components\/schemas\/master\/value2payload","type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master\/Value2Payload","abstract":[],"role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Value2Payload"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Value2Payload"}],"title":"Components.Schemas.Master.Value2Payload","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Master":{"title":"Components.Schemas.Master","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Master"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/master","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Master"}],"kind":"symbol","abstract":[{"type":"text","text":"A type that represents a set of similar releases."}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Master"},"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/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"}}} |