rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
d01b60e6dd16d15055a60dc75ebeac2da9e134f4
discogs-service/docs/data/documentation/discogsservice/components/schemas/service/statisticspayload.json
T
javier d01b60e6dd Added the Rate Limiting headers (#7) 
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>
2025-10-13 13:09:10 +00:00

1 line
12 KiB
JSON
Raw Blame History

{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload"},"metadata":{"navigatorTitle":[{"text":"StatisticsPayload","kind":"identifier"}],"role":"symbol","externalID":"s:14DiscogsService10ComponentsO7SchemasO0B0V17StatisticsPayloadV","title":"Components.Schemas.Service.StatisticsPayload","symbolKind":"struct","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatisticsPayload"}],"roleHeading":"Structure"},"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/DiscogsService\/Se","doc:\/\/DiscogsService\/SE","doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"type":"conformsTo","title":"Conforms To"}],"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"StatisticsPayload"}],"languages":["swift"],"platforms":["macOS"]}]},{"kind":"content","content":[{"level":2,"anchor":"overview","type":"heading","text":"Overview"},{"name":"Remark","type":"aside","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/components\/schemas\/Service\/statistics"},{"type":"text","text":"."}]}],"style":"note"}]}],"kind":"symbol","variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload"]}],"abstract":[{"type":"text","text":"A type that encapsulates statistical data about the service."}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service"]]},"schemaVersion":{"major":0,"patch":0,"minor":3},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/init(artists:labels:releases:)","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/init(from:)"],"generated":true,"title":"Initializers","anchor":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/artists","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/labels","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/releases"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/CodingKeys"],"generated":true,"title":"Enumerations","anchor":"Enumerations"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/Equatable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload/releases":{"url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/releases","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/releases","role":"symbol","kind":"symbol","title":"releases","abstract":[{"type":"text","text":"A total number of releases registered in the service."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"releases"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload":{"url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload","title":"Components.Schemas.Service.StatisticsPayload","role":"symbol","abstract":[{"type":"text","text":"A type that encapsulates statistical data about the service."}],"type":"topic","fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"StatisticsPayload","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload","navigatorTitle":[{"text":"StatisticsPayload","kind":"identifier"}],"kind":"symbol"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"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/Service":{"url":"\/documentation\/discogsservice\/components\/schemas\/service","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Service"}],"kind":"symbol","title":"Components.Schemas.Service","abstract":[{"text":"A type that encapsulates any available information about the service.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Service"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload/CodingKeys":{"role":"symbol","abstract":[],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/codingkeys","kind":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"kind":"identifier","text":"CodingKeys"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/CodingKeys","navigatorTitle":[{"kind":"identifier","text":"CodingKeys"}],"title":"Components.Schemas.Service.StatisticsPayload.CodingKeys"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP","title":"Swift.SendableMetatype"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload/Equatable-Implementations":{"url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/equatable-implementations","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/Equatable-Implementations","role":"collectionGroup","kind":"article","title":"Equatable Implementations","abstract":[],"type":"topic"},"doc://DiscogsService/Se":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/Se","title":"Swift.Decodable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload/labels":{"url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/labels","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/labels","role":"symbol","kind":"symbol","title":"labels","abstract":[{"type":"text","text":"A total number of labels registered in the service."}],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"labels"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"}],"type":"topic"},"doc://DiscogsService/SH":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SH","title":"Swift.Hashable"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload/init(artists:labels:releases:)":{"abstract":[{"type":"text","text":"Creates a new "},{"type":"codeVoice","code":"StatisticsPayload"},{"type":"text","text":"."}],"role":"symbol","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"artists"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"labels"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":", "},{"kind":"externalParam","text":"releases"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Si","text":"Int"},{"kind":"text","text":")"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/init(artists:labels:releases:)","type":"topic","kind":"symbol","url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/init(artists:labels:releases:)","title":"init(artists:labels:releases:)"},"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/Service/StatisticsPayload/init(from:)":{"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/init(from:)","fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"from"},{"kind":"text","text":": any "},{"kind":"typeIdentifier","preciseIdentifier":"s:s7DecoderP","text":"Decoder"},{"kind":"text","text":") "},{"text":"throws","kind":"keyword"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/init(from:)","role":"symbol","title":"init(from:)","abstract":[]},"doc://DiscogsService/documentation/DiscogsService/Components/Schemas/Service/StatisticsPayload/artists":{"abstract":[{"text":"A total number of artists registered in the service.","type":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Schemas\/Service\/StatisticsPayload\/artists","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"artists","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:Si","text":"Int","kind":"typeIdentifier"}],"type":"topic","url":"\/documentation\/discogsservice\/components\/schemas\/service\/statisticspayload\/artists","role":"symbol","title":"artists","kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/SE":{"type":"unresolvable","title":"Swift.Encodable","identifier":"doc:\/\/DiscogsService\/SE"}}}
View Git Blame Copy Permalink