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
8.1 KiB
JSON
1 line
8.1 KiB
JSON
{"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"relationshipsSections":[{"type":"conformsTo","identifiers":["doc:\/\/DiscogsService\/SQ","doc:\/\/DiscogsService\/SH","doc:\/\/DiscogsService\/s8SendableP","doc:\/\/DiscogsService\/s16SendableMetatypeP"],"title":"Conforms To","kind":"relationships"}],"variants":[{"paths":["\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.struct"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct"},"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"platforms":["macOS"],"languages":["swift"]}],"kind":"declarations"},{"content":[{"level":2,"anchor":"overview","type":"heading","text":"Overview"},{"name":"Remark","type":"aside","style":"note","content":[{"inlineContent":[{"type":"text","text":"Generated from "},{"code":"#\/paths\/artists\/{artist_id}\/GET\/path","type":"codeVoice"},{"type":"text","text":"."}],"type":"paragraph"}]}],"kind":"content"}],"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input"]]},"metadata":{"modules":[{"name":"DiscogsService"}],"title":"Operations.GetArtist.Input.Path","externalID":"s:14DiscogsService10OperationsO9GetArtistO5InputV4PathV","role":"symbol","symbolKind":"struct","navigatorTitle":[{"kind":"identifier","text":"Path"}],"fragments":[{"text":"struct","kind":"keyword"},{"text":" ","kind":"text"},{"text":"Path","kind":"identifier"}],"roleHeading":"Structure"},"topicSections":[{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct\/init(artistId:)"],"generated":true,"title":"Initializers","anchor":"Initializers"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct\/artistId"],"generated":true,"title":"Instance Properties","anchor":"Instance-Properties"},{"identifiers":["doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct\/Equatable-Implementations"],"generated":true,"title":"Default Implementations","anchor":"Default-Implementations"}],"references":{"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input/Path-swift.struct":{"title":"Operations.GetArtist.Input.Path","url":"\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.struct","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Path"}],"navigatorTitle":[{"kind":"identifier","text":"Path"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input/Path-swift.struct/artistId":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.struct\/artistid","abstract":[{"type":"text","text":"An identifier of an artist."}],"title":"artistId","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct\/artistId","kind":"symbol","role":"symbol","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"artistId"},{"text":": ","kind":"text"},{"text":"Components","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO"},{"text":".","kind":"text"},{"text":"Parameters","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO"},{"text":".","kind":"text"},{"text":"ArtistId","kind":"typeIdentifier","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8ArtistIda"}]},"doc://DiscogsService/SH":{"type":"unresolvable","title":"Swift.Hashable","identifier":"doc:\/\/DiscogsService\/SH"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input":{"title":"Operations.GetArtist.Input","url":"\/documentation\/discogsservice\/operations\/getartist\/input","abstract":[],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input","kind":"symbol","role":"symbol","fragments":[{"kind":"keyword","text":"struct"},{"kind":"text","text":" "},{"kind":"identifier","text":"Input"}],"navigatorTitle":[{"text":"Input","kind":"identifier"}]},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist/Input/Path-swift.struct/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","url":"\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.struct\/equatable-implementations","abstract":[],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct\/Equatable-Implementations","kind":"article","role":"collectionGroup"},"doc://DiscogsService/documentation/DiscogsService/Operations/GetArtist":{"type":"topic","url":"\/documentation\/discogsservice\/operations\/getartist","abstract":[{"text":"Get information about an artist.","type":"text"}],"title":"Operations.GetArtist","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist","kind":"symbol","role":"symbol","fragments":[{"text":"enum","kind":"keyword"},{"text":" ","kind":"text"},{"text":"GetArtist","kind":"identifier"}],"navigatorTitle":[{"text":"GetArtist","kind":"identifier"}]},"doc://DiscogsService/s16SendableMetatypeP":{"type":"unresolvable","title":"Swift.SendableMetatype","identifier":"doc:\/\/DiscogsService\/s16SendableMetatypeP"},"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/GetArtist/Input/Path-swift.struct/init(artistId:)":{"role":"symbol","abstract":[{"text":"Creates a new ","type":"text"},{"code":"Path","type":"codeVoice"},{"text":".","type":"text"}],"url":"\/documentation\/discogsservice\/operations\/getartist\/input\/path-swift.struct\/init(artistid:)","type":"topic","kind":"symbol","fragments":[{"text":"init","kind":"identifier"},{"text":"(","kind":"text"},{"text":"artistId","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Components","preciseIdentifier":"s:14DiscogsService10ComponentsO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Parameters","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"ArtistId","preciseIdentifier":"s:14DiscogsService10ComponentsO10ParametersO8ArtistIda","kind":"typeIdentifier"},{"text":")","kind":"text"}],"identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/GetArtist\/Input\/Path-swift.struct\/init(artistId:)","title":"init(artistId:)"},"doc://DiscogsService/s8SendableP":{"type":"unresolvable","title":"Swift.Sendable","identifier":"doc:\/\/DiscogsService\/s8SendableP"},"doc://DiscogsService/SQ":{"type":"unresolvable","title":"Swift.Equatable","identifier":"doc:\/\/DiscogsService\/SQ"},"doc://DiscogsService/documentation/DiscogsService":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"}}} |