Open Policy Agent TypeScript Packages
    Preparing search index...

    Type Alias ExecutePolicyWithInputRequest

    type ExecutePolicyWithInputRequest = {
        acceptEncoding?: GzipAcceptEncoding;
        contentEncoding?: GzipContentEncoding;
        explain?: Explain;
        instrument?: boolean;
        metrics?: boolean;
        path?: string;
        pretty?: boolean;
        provenance?: boolean;
        requestBody: ExecutePolicyWithInputRequestBody;
        strictBuiltinErrors?: boolean;
    }
    Index

    Properties

    acceptEncoding? contentEncoding? explain? instrument? metrics? path? pretty? provenance? requestBody strictBuiltinErrors?

    Properties

    acceptEncoding?: GzipAcceptEncoding

    Indicates the server should respond with a gzip encoded body. The server will send the compressed response only if its length is above server.encoding.gzip.min_length value. See the configuration section

    contentEncoding?: GzipContentEncoding

    Indicates that the request body is gzip encoded

    explain?: Explain

    Return query explanation in addition to result.

    instrument?: boolean

    Instrument query evaluation and return a superset of performance metrics in addition to result.

    metrics?: boolean

    Return query performance metrics in addition to result.

    path?: string

    The path separator is used to access values inside object and array documents. If the path indexes into an array, the server will attempt to convert the array index to an integer. If the path element cannot be converted to an integer, the server will respond with 404.

    pretty?: boolean

    If parameter is true, response will formatted for humans.

    provenance?: boolean

    If parameter is true, response will include build/version info in addition to the result.

    requestBody: ExecutePolicyWithInputRequestBody

    The input document

    strictBuiltinErrors?: boolean

    Treat built-in function call errors as fatal and return an error immediately.

    Settings

    Member Visibility

    On This Page

    Properties