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
9.0 KiB
JSON
1 line
9.0 KiB
JSON
{"sections":[],"kind":"symbol","hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"metadata":{"role":"symbol","roleHeading":"Structure","modules":[{"name":"DiscogsService"}],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"externalID":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO5InputV7HeadersV","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"symbolKind":"struct","title":"Operations.GetReleaseRatingByUser.Input.Headers"},"identifier":{"url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct","interfaceLanguage":"swift"},"relationshipsSections":[{"type":"conformsTo","title":"Conforms To","kind":"relationships","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"]}],"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}]}]},{"kind":"content","content":[{"type":"heading","level":2,"text":"Overview","anchor":"overview"},{"type":"aside","style":"note","name":"Remark","content":[{"type":"paragraph","inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/releases\/{release_id}\/rating\/{username}\/GET\/header","type":"codeVoice"},{"type":"text","text":"."}]}]}]}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/headers-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"topicSections":[{"generated":true,"anchor":"Initializers","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct\/init(accept:)"],"title":"Initializers"},{"generated":true,"anchor":"Instance-Properties","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct\/accept"],"title":"Instance Properties"},{"generated":true,"anchor":"Default-Implementations","identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct\/Equatable-Implementations"],"title":"Default Implementations"}],"references":{"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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"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/Headers-swift.struct":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/headers-swift.struct","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Headers"}],"kind":"symbol","title":"Operations.GetReleaseRatingByUser.Input.Headers","abstract":[],"fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Headers"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Headers-swift.struct/accept":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/headers-swift.struct\/accept","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct\/accept","role":"symbol","kind":"symbol","title":"accept","abstract":[],"fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"accept"},{"kind":"text","text":": ["},{"kind":"typeIdentifier","text":"AcceptHeaderContentType","preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV"},{"kind":"text","text":"<"},{"kind":"typeIdentifier","text":"Operations","preciseIdentifier":"s:14DiscogsService10OperationsO"},{"text":".","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","text":"GetReleaseRatingByUser"},{"kind":"text","text":"."},{"kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO21AcceptableContentTypeO","text":"AcceptableContentType"},{"kind":"text","text":">]"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Headers-swift.struct/init(accept:)":{"url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/headers-swift.struct\/init(accept:)","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct\/init(accept:)","role":"symbol","kind":"symbol","title":"init(accept:)","abstract":[{"text":"Creates a new ","type":"text"},{"type":"codeVoice","code":"Headers"},{"text":".","type":"text"}],"fragments":[{"kind":"identifier","text":"init"},{"kind":"text","text":"("},{"kind":"externalParam","text":"accept"},{"kind":"text","text":": ["},{"preciseIdentifier":"s:14OpenAPIRuntime23AcceptHeaderContentTypeV","kind":"typeIdentifier","text":"AcceptHeaderContentType"},{"kind":"text","text":"<"},{"preciseIdentifier":"s:14DiscogsService10OperationsO","kind":"typeIdentifier","text":"Operations"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO","kind":"typeIdentifier","text":"GetReleaseRatingByUser"},{"kind":"text","text":"."},{"preciseIdentifier":"s:14DiscogsService10OperationsO22GetReleaseRatingByUserO21AcceptableContentTypeO","kind":"typeIdentifier","text":"AcceptableContentType"},{"kind":"text","text":">])"}],"type":"topic"},"doc://DiscogsService/SQ":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/SQ","title":"Swift.Equatable"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","identifier":"doc:\/\/DiscogsService\/s8SendableP","title":"Swift.Sendable"},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetReleaseRatingByUser/Input/Headers-swift.struct/Equatable-Implementations":{"kind":"article","role":"collectionGroup","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetReleaseRatingByUser\/Input\/Headers-swift.struct\/Equatable-Implementations","url":"\/documentation\/discogsservice\/operations\/getreleaseratingbyuser\/input\/headers-swift.struct\/equatable-implementations","type":"topic","title":"Equatable Implementations","abstract":[]},"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/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"}}} |