Interface UmbOpenApiConfiguration

Configuration for the OpenAPI (Umbraco) server. This is used to communicate with the Management API. This is useful if you want to configure your Fetch, Axios or other HTTP client to communicate with the Management API. If you use the recommended resource generator openapi-typescript-codegen this can be used to configure the OpenAPI object.

interface UmbOpenApiConfiguration {
    base: string;
    credentials: "include" | "omit" | "same-origin";
    encodePath?: ((value: string) => string);
    token: (() => Promise<string>);
    version: string;
    withCredentials: boolean;
}

Properties

base credentials encodePath? token version withCredentials

Properties

Readonlybase

base: string

The base URL of the OpenAPI (Umbraco) server.

Readonlycredentials

credentials: "include" | "omit" | "same-origin"

The credentials option for the Fetch API.

Optional ReadonlyencodePath

encodePath?: ((value: string) => string)

The encoder to use for the request URLs.

Type declaration

    • (value): string

    • Parameters

      • value: string

      Returns string

      A resolver for the encoder to use for the request URLs.

Readonlytoken

token: (() => Promise<string>)

The token to use for the Authorization header.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

      A resolver for the token to use for the Authorization header.

Readonlyversion

version: string

The configured version of the Management API to use.

ReadonlywithCredentials

withCredentials: boolean

The withCredentials option for the Fetch API.

Settings

Member Visibility

On This Page

Properties
""