@scalar/api-client
Version:
the open source API testing client
10 lines • 699 B
TypeScript
import type { ExampleObject, ParameterObject, RequestBodyObject } from '@scalar/workspace-store/schemas/v3.1/strict/openapi-document';
/**
* Resolve an example value for a parameter or requestBody from either `examples` or `content.*.examples`.
* Or the [deprecated] `example` field.
* If no exampleKey is provided it will fallback to the first example in the examples object then the [deprecated]
* `example` field.
* Used both for send-request and generating code snippets.
*/
export declare const getExample: (param: ParameterObject | RequestBodyObject, exampleKey: string | undefined, contentType: string | undefined) => ExampleObject | undefined;
//# sourceMappingURL=get-example.d.ts.map