@apistudio/apim-cli/node_modules/@apic/studio-test/dist/schemas/test.schema.d.ts

CLI for API Management Products

/**
 * Copyright IBM Corp. 2024, 2025
 */
import { z } from 'zod';
export declare const PayloadUnionSchema: z.ZodObject<{
    raw: z.ZodOptional<z.ZodObject<{
        json: z.ZodOptional<z.ZodString>;
        js: z.ZodOptional<z.ZodString>;
        html: z.ZodOptional<z.ZodString>;
        xml: z.ZodOptional<z.ZodString>;
    }, z.core.$strict>>;
    urlEncodedFormData: z.ZodOptional<z.ZodArray<z.ZodObject<{
        key: z.ZodString;
        value: z.ZodAny;
        type: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>>;
    formData: z.ZodOptional<z.ZodArray<z.ZodObject<{
        key: z.ZodString;
        value: z.ZodAny;
        type: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>>;
}, z.core.$strip>;
declare const AssertionRefSchema: z.ZodObject<{
    $ref: z.ZodOptional<z.ZodString>;
    assertions: z.ZodOptional<z.ZodArray<z.ZodObject<{
        metadata: z.ZodObject<{
            name: z.ZodString;
            version: z.ZodString;
            tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
            namespace: z.ZodString;
            type: z.ZodOptional<z.ZodString>;
            description: z.ZodOptional<z.ZodString>;
        }, z.core.$strip>;
        kindEnum: z.ZodOptional<z.ZodString>;
        apiVersion: z.ZodOptional<z.ZodString>;
        kind: z.ZodLiteral<"assertion">;
        spec: z.ZodArray<z.ZodObject<{
            name: z.ZodString;
            key: z.ZodString;
            value: z.ZodAny;
            action: z.ZodString;
            if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
            stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
        }, z.core.$strip>>;
    }, z.core.$strip>>>;
}, z.core.$strip>;
export declare const AuthSchema: z.ZodObject<{
    noauth: z.ZodOptional<z.ZodBoolean>;
    bearerToken: z.ZodOptional<z.ZodString>;
    basicAuth: z.ZodOptional<z.ZodObject<{
        username: z.ZodString;
        password: z.ZodString;
    }, z.core.$strip>>;
}, z.core.$strip>;
export declare const TestStepSchema: z.ZodObject<{
    endpoint: z.ZodOptional<z.ZodString>;
    method: z.ZodString;
    if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
    stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
    skipped: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
    resource: z.ZodString;
    headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
        key: z.ZodString;
        value: z.ZodAny;
        description: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>>;
    auth: z.ZodOptional<z.ZodObject<{
        noauth: z.ZodOptional<z.ZodBoolean>;
        bearerToken: z.ZodOptional<z.ZodString>;
        basicAuth: z.ZodOptional<z.ZodObject<{
            username: z.ZodString;
            password: z.ZodString;
        }, z.core.$strip>>;
    }, z.core.$strip>>;
    payload: z.ZodOptional<z.ZodObject<{
        raw: z.ZodOptional<z.ZodObject<{
            json: z.ZodOptional<z.ZodString>;
            js: z.ZodOptional<z.ZodString>;
            html: z.ZodOptional<z.ZodString>;
            xml: z.ZodOptional<z.ZodString>;
        }, z.core.$strict>>;
        urlEncodedFormData: z.ZodOptional<z.ZodArray<z.ZodObject<{
            key: z.ZodString;
            value: z.ZodAny;
            type: z.ZodOptional<z.ZodString>;
        }, z.core.$strip>>>;
        formData: z.ZodOptional<z.ZodArray<z.ZodObject<{
            key: z.ZodString;
            value: z.ZodAny;
            type: z.ZodOptional<z.ZodString>;
        }, z.core.$strip>>>;
    }, z.core.$strip>>;
    settings: z.ZodOptional<z.ZodObject<{
        sslVerification: z.ZodOptional<z.ZodBoolean>;
        encodeURL: z.ZodOptional<z.ZodBoolean>;
    }, z.core.$strip>>;
    parameters: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
        key: z.ZodString;
        value: z.ZodAny;
        type: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>>>>;
    assertions: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodOptional<z.ZodObject<{
        $ref: z.ZodOptional<z.ZodString>;
        assertions: z.ZodOptional<z.ZodArray<z.ZodObject<{
            metadata: z.ZodObject<{
                name: z.ZodString;
                version: z.ZodString;
                tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
                namespace: z.ZodString;
                type: z.ZodOptional<z.ZodString>;
                description: z.ZodOptional<z.ZodString>;
            }, z.core.$strip>;
            kindEnum: z.ZodOptional<z.ZodString>;
            apiVersion: z.ZodOptional<z.ZodString>;
            kind: z.ZodLiteral<"assertion">;
            spec: z.ZodArray<z.ZodObject<{
                name: z.ZodString;
                key: z.ZodString;
                value: z.ZodAny;
                action: z.ZodString;
                if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
                stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
            }, z.core.$strip>>;
        }, z.core.$strip>>>;
    }, z.core.$strip>>>, z.ZodObject<{
        $ref: z.ZodOptional<z.ZodString>;
        assertions: z.ZodOptional<z.ZodArray<z.ZodObject<{
            metadata: z.ZodObject<{
                name: z.ZodString;
                version: z.ZodString;
                tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
                namespace: z.ZodString;
                type: z.ZodOptional<z.ZodString>;
                description: z.ZodOptional<z.ZodString>;
            }, z.core.$strip>;
            kindEnum: z.ZodOptional<z.ZodString>;
            apiVersion: z.ZodOptional<z.ZodString>;
            kind: z.ZodLiteral<"assertion">;
            spec: z.ZodArray<z.ZodObject<{
                name: z.ZodString;
                key: z.ZodString;
                value: z.ZodAny;
                action: z.ZodString;
                if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
                stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
            }, z.core.$strip>>;
        }, z.core.$strip>>>;
    }, z.core.$strip>]>>;
    var: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodObject<{
        key: z.ZodString;
        value: z.ZodString;
    }, z.core.$strip>]>>]>>;
}, z.core.$strip>;
export declare const TestSchema: z.ZodObject<{
    metadata: z.ZodObject<{
        name: z.ZodString;
        version: z.ZodString;
        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
        namespace: z.ZodString;
        type: z.ZodOptional<z.ZodString>;
        description: z.ZodOptional<z.ZodString>;
    }, z.core.$strip>;
    kindEnum: z.ZodOptional<z.ZodString>;
    apiVersion: z.ZodOptional<z.ZodString>;
    kind: z.ZodLiteral<"test">;
    spec: z.ZodObject<{
        api: z.ZodObject<{
            $ref: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodString>]>>;
            $endpoint: z.ZodOptional<z.ZodString>;
        }, z.core.$strip>;
        environment: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodOptional<z.ZodObject<{
            $ref: z.ZodOptional<z.ZodString>;
            variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
                metadata: z.ZodObject<{
                    name: z.ZodString;
                    version: z.ZodString;
                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
                    namespace: z.ZodString;
                    type: z.ZodOptional<z.ZodString>;
                    description: z.ZodOptional<z.ZodString>;
                }, z.core.$strip>;
                kindEnum: z.ZodOptional<z.ZodString>;
                apiVersion: z.ZodOptional<z.ZodString>;
                kind: z.ZodLiteral<"environment">;
                spec: z.ZodObject<{
                    variables: z.ZodArray<z.ZodObject<{
                        key: z.ZodString;
                        value: z.ZodAny;
                        isSecret: z.ZodDefault<z.ZodBoolean>;
                    }, z.core.$strip>>;
                }, z.core.$strip>;
            }, z.core.$strip>>>;
        }, z.core.$strip>>>, z.ZodObject<{
            $ref: z.ZodOptional<z.ZodString>;
            variables: z.ZodOptional<z.ZodArray<z.ZodObject<{
                metadata: z.ZodObject<{
                    name: z.ZodString;
                    version: z.ZodString;
                    tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
                    namespace: z.ZodString;
                    type: z.ZodOptional<z.ZodString>;
                    description: z.ZodOptional<z.ZodString>;
                }, z.core.$strip>;
                kindEnum: z.ZodOptional<z.ZodString>;
                apiVersion: z.ZodOptional<z.ZodString>;
                kind: z.ZodLiteral<"environment">;
                spec: z.ZodObject<{
                    variables: z.ZodArray<z.ZodObject<{
                        key: z.ZodString;
                        value: z.ZodAny;
                        isSecret: z.ZodDefault<z.ZodBoolean>;
                    }, z.core.$strip>>;
                }, z.core.$strip>;
            }, z.core.$strip>>>;
        }, z.core.$strip>]>>;
        request: z.ZodArray<z.ZodObject<{
            endpoint: z.ZodOptional<z.ZodString>;
            method: z.ZodString;
            if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
            stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
            skipped: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
            resource: z.ZodString;
            headers: z.ZodOptional<z.ZodArray<z.ZodObject<{
                key: z.ZodString;
                value: z.ZodAny;
                description: z.ZodOptional<z.ZodString>;
            }, z.core.$strip>>>;
            auth: z.ZodOptional<z.ZodObject<{
                noauth: z.ZodOptional<z.ZodBoolean>;
                bearerToken: z.ZodOptional<z.ZodString>;
                basicAuth: z.ZodOptional<z.ZodObject<{
                    username: z.ZodString;
                    password: z.ZodString;
                }, z.core.$strip>>;
            }, z.core.$strip>>;
            payload: z.ZodOptional<z.ZodObject<{
                raw: z.ZodOptional<z.ZodObject<{
                    json: z.ZodOptional<z.ZodString>;
                    js: z.ZodOptional<z.ZodString>;
                    html: z.ZodOptional<z.ZodString>;
                    xml: z.ZodOptional<z.ZodString>;
                }, z.core.$strict>>;
                urlEncodedFormData: z.ZodOptional<z.ZodArray<z.ZodObject<{
                    key: z.ZodString;
                    value: z.ZodAny;
                    type: z.ZodOptional<z.ZodString>;
                }, z.core.$strip>>>;
                formData: z.ZodOptional<z.ZodArray<z.ZodObject<{
                    key: z.ZodString;
                    value: z.ZodAny;
                    type: z.ZodOptional<z.ZodString>;
                }, z.core.$strip>>>;
            }, z.core.$strip>>;
            settings: z.ZodOptional<z.ZodObject<{
                sslVerification: z.ZodOptional<z.ZodBoolean>;
                encodeURL: z.ZodOptional<z.ZodBoolean>;
            }, z.core.$strip>>;
            parameters: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
                key: z.ZodString;
                value: z.ZodAny;
                type: z.ZodOptional<z.ZodString>;
            }, z.core.$strip>>>>;
            assertions: z.ZodOptional<z.ZodUnion<readonly [z.ZodArray<z.ZodOptional<z.ZodObject<{
                $ref: z.ZodOptional<z.ZodString>;
                assertions: z.ZodOptional<z.ZodArray<z.ZodObject<{
                    metadata: z.ZodObject<{
                        name: z.ZodString;
                        version: z.ZodString;
                        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
                        namespace: z.ZodString;
                        type: z.ZodOptional<z.ZodString>;
                        description: z.ZodOptional<z.ZodString>;
                    }, z.core.$strip>;
                    kindEnum: z.ZodOptional<z.ZodString>;
                    apiVersion: z.ZodOptional<z.ZodString>;
                    kind: z.ZodLiteral<"assertion">;
                    spec: z.ZodArray<z.ZodObject<{
                        name: z.ZodString;
                        key: z.ZodString;
                        value: z.ZodAny;
                        action: z.ZodString;
                        if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
                        stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
                    }, z.core.$strip>>;
                }, z.core.$strip>>>;
            }, z.core.$strip>>>, z.ZodObject<{
                $ref: z.ZodOptional<z.ZodString>;
                assertions: z.ZodOptional<z.ZodArray<z.ZodObject<{
                    metadata: z.ZodObject<{
                        name: z.ZodString;
                        version: z.ZodString;
                        tags: z.ZodOptional<z.ZodArray<z.ZodString>>;
                        namespace: z.ZodString;
                        type: z.ZodOptional<z.ZodString>;
                        description: z.ZodOptional<z.ZodString>;
                    }, z.core.$strip>;
                    kindEnum: z.ZodOptional<z.ZodString>;
                    apiVersion: z.ZodOptional<z.ZodString>;
                    kind: z.ZodLiteral<"assertion">;
                    spec: z.ZodArray<z.ZodObject<{
                        name: z.ZodString;
                        key: z.ZodString;
                        value: z.ZodAny;
                        action: z.ZodString;
                        if: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodString]>>>>;
                        stopOnFail: z.ZodOptional<z.ZodDefault<z.ZodOptional<z.ZodBoolean>>>;
                    }, z.core.$strip>>;
                }, z.core.$strip>>>;
            }, z.core.$strip>]>>;
            var: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodRecord<z.ZodString, z.ZodString>, z.ZodObject<{
                key: z.ZodString;
                value: z.ZodString;
            }, z.core.$strip>]>>]>>;
        }, z.core.$strip>>;
    }, z.core.$strip>;
    vcmId: z.ZodOptional<z.ZodString>;
}, z.core.$strip>;
export type Test = z.infer<typeof TestSchema>;
export type Request = z.infer<typeof TestStepSchema>;
export type Payload = z.infer<typeof PayloadUnionSchema>;
export type AuthOptions = z.infer<typeof AuthSchema>;
export type Assertions = z.infer<typeof AssertionRefSchema>;
export {};
//# sourceMappingURL=test.schema.d.ts.map