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.8 KiB
JSON
1 line
8.8 KiB
JSON
{"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload"]]},"metadata":{"symbolKind":"init","roleHeading":"Initializer","externalID":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV9communityA2I09CommunityH0VSg_tcfc","modules":[{"name":"DiscogsService"}],"role":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"community","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ReleaseVersion","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV"},{"text":".","kind":"text"},{"text":"StatsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},{"text":".","kind":"text"},{"text":"CommunityPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V"},{"text":"?)","kind":"text"}],"title":"init(community:)"},"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"StatsPayload"},{"type":"text","text":"."}],"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"init","kind":"keyword"},{"text":"(","kind":"text"},{"text":"community","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Schemas","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO"},{"text":".","kind":"text"},{"text":"ReleaseVersion","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV"},{"text":".","kind":"text"},{"text":"StatsPayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},{"text":".","kind":"text"},{"text":"CommunityPayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CommunityPayload","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V"},{"text":"? = nil)","kind":"text"}],"languages":["swift"]}]},{"parameters":[{"name":"community","content":[{"inlineContent":[{"type":"text","text":"A type that represents the relationship between users and a release version."}],"type":"paragraph"}]}],"kind":"parameters"}],"variants":[{"paths":["\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/init(community:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"major":0,"patch":0,"minor":3},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(community:)","interfaceLanguage":"swift"},"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/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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"ReleaseVersion"}],"kind":"symbol","title":"Components.Schemas.ReleaseVersion","abstract":[{"text":"A type that represents a version of a release.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"ReleaseVersion"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/init(community:)":{"title":"init(community:)","url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/init(community:)","role":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"StatsPayload","type":"codeVoice"},{"text":".","type":"text"}],"type":"topic","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"community"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO","text":"Schemas"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV","text":"ReleaseVersion"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"StatsPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV"},{"kind":"text","text":"."},{"text":"CommunityPayload","preciseIdentifier":"s:14DiscogsService10ComponentsO7SchemasO14ReleaseVersionV12StatsPayloadV09CommunityH0V","kind":"typeIdentifier"},{"kind":"text","text":"?)"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/init(community:)","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload/CommunityPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload\/communitypayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload\/CommunityPayload","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"CommunityPayload"}],"kind":"symbol","title":"Components.Schemas.ReleaseVersion.StatsPayload.CommunityPayload","abstract":[{"text":"A type that represents the relationship between users and a release version.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"CommunityPayload"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/ReleaseVersion/StatsPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/releaseversion\/statspayload","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/ReleaseVersion\/StatsPayload","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"StatsPayload"}],"kind":"symbol","title":"Components.Schemas.ReleaseVersion.StatsPayload","abstract":[{"text":"A type contains statictics about a release version.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatsPayload"}],"type":"topic"}}} |