wiremock-rest-client/dist/model/request-pattern.model.d.ts

Lightweight REST client to interact with a running WireMock server

/**
 * This file was automatically generated. DO NOT MODIFY IT BY HAND.
 */
export interface RequestPattern {
    /**
     * The HTTP request method e.g. GET
     */
    method?: string;
    /**
     * The path and query to match exactly against. Only one of url, urlPattern, urlPath or
     * urlPathPattern may be specified.
     */
    url?: string;
    /**
     * The path to match exactly against. Only one of url, urlPattern, urlPath or urlPathPattern may
     * be specified.
     */
    urlPath?: string;
    /**
     * The path regex to match against. Only one of url, urlPattern, urlPath or urlPathPattern may be
     * specified.
     */
    urlPathPattern?: string;
    /**
     * The path and query regex to match against. Only one of url, urlPattern, urlPath or
     * urlPathPattern may be specified.
     */
    urlPattern?: string;
    /**
     * Query parameter patterns to match against in the <key>: { "<predicate>": "<value>" } form
     */
    queryParameters?: {
        [k: string]: any;
    };
    /**
     * Header patterns to match against in the <key>: { "<predicate>": "<value>" } form
     */
    headers?: {
        [k: string]: any;
    };
    /**
     * Pre-emptive basic auth credentials to match against
     */
    basicAuthCredentials?: {
        password: string;
        username: string;
        [k: string]: any;
    };
    /**
     * Cookie patterns to match against in the <key>: { "<predicate>": "<value>" } form
     */
    cookies?: {
        [k: string]: any;
    };
    /**
     * Request body patterns to match against in the <key>: { "<predicate>": "<value>" } form
     */
    bodyPatterns?: {
        [k: string]: any;
    }[];
    [k: string]: any;
}