rock-n-code/discogs-service
1
0
Fork 0
Code Pull Requests Releases 8 Activity
Files
d01b60e6dd16d15055a60dc75ebeac2da9e134f4
discogs-service/docs/data/documentation/discogsservice/operations/getreleaseratingbyuser/input/path-swift.struct/releaseid.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
8.4 KiB
JSON
Raw Blame History

{"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Path-swift.struct"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Path-swift.struct\/releaseId"},"sections":[],"abstract":[{"type":"text","text":"An identifier of a release."}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/path-swift.struct\/releaseid"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"patch":0,"major":0,"minor":3},"metadata":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releaseId","kind":"identifier"},{"text":": ","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO","text":"Components","kind":"typeIdentifier"},{"text":".","kind":"text"},{"preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","text":"Parameters","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"ReleaseId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda"}],"modules":[{"name":"DiscogsService"}],"symbolKind":"property","role":"symbol","roleHeading":"Instance Property","externalID":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV4PathV9releaseIdSivp","title":"releaseId"},"primaryContentSections":[{"kind":"declarations","declarations":[{"tokens":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"kind":"identifier","text":"releaseId"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components","text":"Components"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","text":"Parameters"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId","text":"ReleaseId"}],"languages":["swift"],"platforms":["macOS"]}]},{"content":[{"level":2,"anchor":"discussion","type":"heading","text":"Discussion"},{"name":"Remark","type":"aside","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"type":"codeVoice","code":"#\/paths\/releases\/{release_id}\/rating\/{username}\/GET\/path\/release_id"},{"type":"text","text":"."}]}]}],"kind":"content"}],"kind":"symbol","references":{"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/Components/Parameters":{"title":"Components.Parameters","url":"\/documentation\/discogsservice\/components\/parameters","role":"symbol","abstract":[{"type":"text","text":"Types generated from the "},{"type":"codeVoice","code":"#\/components\/parameters"},{"text":" section of the OpenAPI document.","type":"text"}],"type":"topic","fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Parameters"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters","navigatorTitle":[{"kind":"identifier","text":"Parameters"}],"kind":"symbol"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Path-swift.struct/releaseId":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/path-swift.struct\/releaseid","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Path-swift.struct\/releaseId","role":"symbol","kind":"symbol","title":"releaseId","abstract":[{"type":"text","text":"An identifier of a release."}],"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"releaseId","kind":"identifier"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"ReleaseId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO9ReleaseIda"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Components/Parameters/ReleaseId":{"url":"\/documentation\/discogsservice\/components\/parameters\/releaseid","type":"topic","role":"symbol","abstract":[{"type":"text","text":"An identifier of a release."}],"title":"Components.Parameters.ReleaseId","kind":"symbol","fragments":[{"text":"typealias","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ReleaseId","kind":"identifier"}],"navigatorTitle":[{"text":"ReleaseId","kind":"identifier"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Components\/Parameters\/ReleaseId"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Input"}],"kind":"symbol","title":"Operations.GetReleaseRatingByUser.Input","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Path-swift.struct":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Path-swift.struct","role":"symbol","navigatorTitle":[{"text":"Path","kind":"identifier"}],"abstract":[],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"title":"Operations.GetReleaseRatingByUser.Input.Path","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/path-swift.struct","kind":"symbol","type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"GetReleaseRatingByUser"}],"kind":"symbol","title":"Operations.GetReleaseRatingByUser","abstract":[{"text":"Get information about a rating of release by a user.","type":"text"}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"GetReleaseRatingByUser"}],"type":"topic"},"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"}}}
View Git Blame Copy Permalink