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
10 KiB
JSON
1 line
10 KiB
JSON
{"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"abstract":[{"type":"text","text":"Get information about a rating of release by a user."}],"variants":[{"paths":["\/documentation\/discogsservice\/client\/getreleaseratingbyuser(_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getReleaseRatingByUser(_:)"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"getReleaseRatingByUser"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"_"},{"text":" ","kind":"text"},{"kind":"internalParam","text":"input"},{"text":": ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations"},{"text":".","kind":"text"},{"kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","text":"GetReleaseRatingByUser","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input"},{"text":") ","kind":"text"},{"text":"async","kind":"keyword"},{"text":" ","kind":"text"},{"text":"throws","kind":"keyword"},{"text":" -> ","kind":"text"},{"text":"Operations","kind":"typeIdentifier","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","text":"GetReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","text":"Output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"kind":"content","content":[{"text":"Discussion","level":2,"type":"heading","anchor":"discussion"},{"inlineContent":[{"type":"text","text":"Retrieves the rating for a given release by a specific user."}],"type":"paragraph"},{"name":"Remark","style":"note","content":[{"inlineContent":[{"type":"text","text":"HTTP "},{"type":"codeVoice","code":"GET \/releases\/{release_id}\/rating\/{username}"},{"type":"text","text":"."}],"type":"paragraph"}],"type":"aside"},{"name":"Remark","style":"note","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/\/releases\/{release_id}\/rating\/{username}\/get(getReleaseRatingByUser)","type":"codeVoice"},{"type":"text","text":"."}]}],"type":"aside"}]}],"metadata":{"modules":[{"name":"DiscogsService"}],"externalID":"s:14DiscogsService6ClientV22getReleaseRatingByUseryAA10OperationsO03GetefgH0O6OutputOAH5InputVYaKF","title":"getReleaseRatingByUser(_:)","role":"symbol","symbolKind":"method","fragments":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"getReleaseRatingByUser","kind":"identifier"},{"text":"(","kind":"text"},{"text":"Operations","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"text":"GetReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO"},{"kind":"text","text":"."},{"text":"Input","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV"},{"text":") ","kind":"text"},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"text":" -> ","kind":"text"},{"text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"GetReleaseRatingByUser","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO"},{"text":".","kind":"text"},{"text":"Output","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO"}],"roleHeading":"Instance Method"},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client"]]},"references":{"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/Client":{"url":"\/documentation\/discogsservice\/client","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Client"}],"kind":"symbol","title":"Client","abstract":[{"text":"The Discogs API v2.0 is a RESTful interface to Discogs data. You can access JSON-formatted information about Database objects such as ","type":"text"},{"inlineContent":[{"type":"text","text":"Artists"}],"type":"emphasis"},{"text":", ","type":"text"},{"inlineContent":[{"type":"text","text":"Releases"}],"type":"emphasis"},{"text":", and ","type":"text"},{"inlineContent":[{"type":"text","text":"Labels"}],"type":"emphasis"},{"text":". Your application can also manage ","type":"text"},{"inlineContent":[{"type":"text","text":"User Collections"}],"type":"emphasis"},{"text":" and ","type":"text"},{"inlineContent":[{"type":"text","text":"Wantlists"}],"type":"emphasis"},{"text":", create ","type":"text"},{"inlineContent":[{"type":"text","text":"Marketplace"}],"type":"emphasis"},{"text":" listings, and more.","type":"text"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Client"}],"type":"topic"},"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/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/Operations/GetReleaseRatingByUser/Output":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","title":"Operations.GetReleaseRatingByUser.Output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"Output"}],"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/Client/getReleaseRatingByUser(_:)":{"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Client\/getReleaseRatingByUser(_:)","kind":"symbol","fragments":[{"kind":"keyword","text":"func"},{"kind":"text","text":" "},{"kind":"identifier","text":"getReleaseRatingByUser"},{"kind":"text","text":"("},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier","text":"GetReleaseRatingByUser"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV","kind":"typeIdentifier","text":"Input"},{"kind":"text","text":") "},{"kind":"keyword","text":"async"},{"kind":"text","text":" "},{"kind":"keyword","text":"throws"},{"kind":"text","text":" -> "},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier","text":"GetReleaseRatingByUser"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO6OutputO","kind":"typeIdentifier","text":"Output"}],"type":"topic","url":"\/documentation\/discogsservice\/client\/getreleaseratingbyuser(_:)","role":"symbol","title":"getReleaseRatingByUser(_:)","abstract":[{"text":"Get information about a rating of release by a user.","type":"text"}]}}} |