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.3 KiB
JSON
1 line
6.3 KiB
JSON
{"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats"},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Input"],"generated":true,"title":"Structures","anchor":"Structures"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/id"],"generated":true,"title":"Type Properties","anchor":"Type-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/AcceptableContentType","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output"],"generated":true,"title":"Enumerations","anchor":"Enumerations"}],"abstract":[{"type":"text","text":"Get information about statistics of release."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/operations\/getreleasestats"]}],"metadata":{"role":"symbol","title":"Operations.GetReleaseStats","roleHeading":"Enumeration","symbolKind":"enum","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseStats","kind":"identifier"}],"modules":[{"name":"DiscogsService"}],"navigatorTitle":[{"kind":"identifier","text":"GetReleaseStats"}],"externalID":"s:14DiscogsService10OperationsO15GetReleaseStatsO"},"schemaVersion":{"patch":0,"minor":3,"major":0},"kind":"symbol","primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetReleaseStats","kind":"identifier"}]}]},{"kind":"content","content":[{"type":"heading","anchor":"overview","text":"Overview","level":2},{"inlineContent":[{"text":"Retrieves the total number of “haves” (in the community’s collections) and “wants” (in the community’s wantlists) for a given release.","type":"text"}],"type":"paragraph"},{"type":"aside","style":"note","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/releases\/{release_id}\/stats"},{"type":"text","text":"."}],"type":"paragraph"}]},{"type":"aside","style":"note","name":"Remark","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/\/releases\/{release_id}\/stats\/get(getReleaseStats)"},{"type":"text","text":"."}],"type":"paragraph"}]}]}],"sections":[],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"]]},"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetReleaseStats"}],"kind":"symbol","title":"Operations.GetReleaseStats","abstract":[{"type":"text","text":"Get information about statistics of release."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetReleaseStats"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/id":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/id","title":"id","role":"symbol","abstract":[],"type":"topic","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"let"},{"kind":"text","text":" "},{"kind":"identifier","text":"id"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:SS","text":"String"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/id","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/AcceptableContentType":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/AcceptableContentType","type":"topic","kind":"symbol","navigatorTitle":[{"kind":"identifier","text":"AcceptableContentType"}],"fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"AcceptableContentType"}],"title":"Operations.GetReleaseStats.AcceptableContentType","abstract":[],"role":"symbol","url":"\/documentation\/discogsservice\/operations\/getreleasestats\/acceptablecontenttype"},"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/GetReleaseStats/Output":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseStats\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","title":"Operations.GetReleaseStats.Output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"text":" ","kind":"text"},{"text":"Output","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseStats/Input":{"url":"\/documentation\/discogsservice\/operations\/getreleasestats\/input","abstract":[],"kind":"symbol","type":"topic","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\/GetReleaseStats\/Input","title":"Operations.GetReleaseStats.Input"}}} |