@dasch-swiss/dsp-js
Version:
JavaScript library that handles API requests to Knora
33 lines (32 loc) • 936 B
TypeScript
import { AdminEndpoint } from "./api/admin/admin-endpoint";
import { SystemEndpoint } from "./api/system/system-endpoint";
import { V2Endpoint } from "./api/v2/v2-endpoint";
import { KnoraApiConfig } from "./knora-api-config";
/**
* Contains endpoints to interact with DSP-API.
*
* @category Config
*/
export declare class KnoraApiConnection {
static readonly PATH_SYSTEM = "";
static readonly PATH_ADMIN = "/admin";
static readonly PATH_V2 = "/v2";
/**
* Holds all endpoints of the system
*/
readonly system: SystemEndpoint;
/**
* Holds all endpoints of the admin route
*/
readonly admin: AdminEndpoint;
/**
* Holds all endpoints of the v2 route
*/
readonly v2: V2Endpoint;
/**
* Sets up all endpoints.
*
* @param knoraApiConfig the configuration for the DSP-API instance to connect to.
*/
constructor(knoraApiConfig: KnoraApiConfig);
}