javier
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
5.3 KiB
JSON
1 line
5.3 KiB
JSON
{"sections":[],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output\/undocumented(statusCode:_:)"},"schemaVersion":{"minor":3,"patch":0,"major":0},"hierarchy":{"paths":[["doc:\/\/DiscogsService\/documentation\/DiscogsService","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output"]]},"metadata":{"role":"symbol","fragments":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"kind":"text","text":")"}],"symbolKind":"case","externalID":"s:14DiscogsService10OperationsO14SearchDatabaseO6OutputO12undocumentedyAGSi_14OpenAPIRuntime19UndocumentedPayloadVtcAGmF","modules":[{"name":"DiscogsService"}],"roleHeading":"Case","title":"Operations.SearchDatabase.Output.undocumented(statusCode:_:)"},"abstract":[{"type":"text","text":"Undocumented response."}],"kind":"symbol","variants":[{"paths":["\/documentation\/discogsservice\/operations\/searchdatabase\/output\/undocumented(statuscode:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"kind":"identifier","text":"undocumented"},{"kind":"text","text":"("},{"kind":"externalParam","text":"statusCode"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"Int","preciseIdentifier":"s:Si"},{"kind":"text","text":", "},{"kind":"typeIdentifier","text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV"},{"kind":"text","text":")"}],"platforms":["macOS"]}],"kind":"declarations"},{"content":[{"text":"Discussion","anchor":"discussion","type":"heading","level":2},{"inlineContent":[{"type":"text","text":"A response with a code that is not documented in the OpenAPI document."}],"type":"paragraph"}],"kind":"content"}],"references":{"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":{"title":"DiscogsService","url":"\/documentation\/discogsservice","type":"topic","role":"collection","abstract":[],"kind":"symbol","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Output":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase\/output","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"Output"}],"kind":"symbol","title":"Operations.SearchDatabase.Output","abstract":[],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"text":"Output","kind":"identifier"}],"type":"topic"},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase/Output/undocumented(statusCode:_:)":{"role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"undocumented","kind":"identifier"},{"text":"(","kind":"text"},{"text":"statusCode","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Int","preciseIdentifier":"s:Si","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"UndocumentedPayload","preciseIdentifier":"s:14OpenAPIRuntime19UndocumentedPayloadV","kind":"typeIdentifier"},{"text":")","kind":"text"}],"type":"topic","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase\/Output\/undocumented(statusCode:_:)","url":"\/documentation\/discogsservice\/operations\/searchdatabase\/output\/undocumented(statuscode:_:)","kind":"symbol","title":"Operations.SearchDatabase.Output.undocumented(statusCode:_:)","abstract":[{"type":"text","text":"Undocumented response."}]},"doc://DiscogsService/documentation/DiscogsService/Operations/SearchDatabase":{"url":"\/documentation\/discogsservice\/operations\/searchdatabase","identifier":"doc:\/\/DiscogsService\/documentation\/DiscogsService\/Operations\/SearchDatabase","role":"symbol","navigatorTitle":[{"kind":"identifier","text":"SearchDatabase"}],"kind":"symbol","title":"Operations.SearchDatabase","abstract":[{"type":"text","text":"Search any information from the database."}],"fragments":[{"kind":"keyword","text":"enum"},{"kind":"text","text":" "},{"kind":"identifier","text":"SearchDatabase"}],"type":"topic"}}} |