Interface ApiConfig

Configuration of an API to send queries to. Used to instantiate the Api class.

interface ApiConfig {
    api?: string;
    authentication?: ApiAuthenticationConfig;
    baseUrl?: string;
    config?: string;
    version?: string;
    workspace?: string;
}

Properties

api? authentication? baseUrl? config? version? workspace?

Properties

Optionalapi

api?: string

Name of the API that is provided by the workspace. The Spinque Desk administrator working on your project knowns this value.

Optionalauthentication

authentication?: ApiAuthenticationConfig

Authentication that should be used when querying the API.

OptionalbaseUrl

baseUrl?: string

URL to the Spinque Query API deployment.

Default

https://rest.spinque.com/

Optionalconfig

config?: string

Name of the configuration of the Spinque workspace that should be used. Usually, this is something like 'production', 'development' or 'default'. The Spinque Desk administrator working on your project knowns this value.

Default

default

Optionalversion

version?: string

Version of the Spinque Query API deployment.

Default

4

Optionalworkspace

workspace?: string

Name of the Spinque workspace that should be addressed. The Spinque Desk administrator working on your project knowns this value.

Settings

Member Visibility

On This Page

Properties