cloudflare
Version:
The official TypeScript library for the Cloudflare API
48 lines • 1.72 kB
TypeScript
import { APIResource } from "../../core/resource.js";
import { APIPromise } from "../../core/api-promise.js";
import { RequestOptions } from "../../internal/request-options.js";
export declare class BaseSchemas extends APIResource {
static readonly _key: readonly ['apiGateway', 'schemas'];
/**
* Returns tracked web and API operations and their feature configuration rendered
* as OpenAPI schemas.
*
* @example
* ```ts
* const schemas = await client.apiGateway.schemas.list({
* zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
* });
* ```
*/
list(params: SchemaListParams, options?: RequestOptions): APIPromise<SchemaListResponse>;
}
export declare class Schemas extends BaseSchemas {
}
export interface SchemaListResponse {
schemas?: Array<unknown>;
timestamp?: string;
}
export interface SchemaListParams {
/**
* Path param: Identifier.
*/
zone_id: string;
/**
* Query param: Add feature(s) to the results. The feature name that is given here
* corresponds to the resulting feature object. Have a look at the top-level object
* description for more details on the specific meaning.
*/
feature?: Array<'thresholds' | 'parameter_schemas' | 'schema_info' | 'confidence_intervals'>;
/**
* Query param: Receive schema only for the given host(s).
*/
host?: Array<string>;
/**
* Query param: Schema kinds to include in exported OpenAPI schemas.
*/
include_schema_kind?: Array<'learned'>;
}
export declare namespace Schemas {
export { type SchemaListResponse as SchemaListResponse, type SchemaListParams as SchemaListParams };
}
//# sourceMappingURL=schemas.d.ts.map