@eclipse-emfcloud/modelserver-client
Version:
Typescript rest client to interact with an EMF.cloud modelserver
48 lines • 2.4 kB
TypeScript
/********************************************************************************
* Copyright (c) 2019-2022 EclipseSource and others.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Public License v. 2.0 which is available at
* https://www.eclipse.org/legal/epl-2.0, or the MIT License which is
* available at https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: EPL-2.0 OR MIT
*******************************************************************************/
/**
* Utility collection of all the available endpoint paths of a (default) modelserver.
*/
export declare namespace ModelServerPaths {
/** Endpoint to retrieve the uris of all available models in the workspace */
const MODEL_URIS = "modeluris";
/** Endpoint for executing CRUD model operations or retrieving all available models in the workspace */
const MODEL_CRUD = "models";
/** Endpoint to retrieve a model element by its id */
const MODEL_ELEMENT = "modelelement";
/** Endpoint to retrieve the type schema of a model as JSON schema */
const TYPE_SCHEMA = "typeschema";
/** Endpoint to retrieve the UI schema of a model as JSON schema */
const UI_SCHEMA = "uischema";
/** Endpoint to configure the modelserver */
const SERVER_CONFIGURE = "server/configure";
/** Endpoint to ping the modelserver */
const SERVER_PING = "server/ping";
/** Endpoint to subscribe/unsubscribe for model state notifications. Has to be called with a Websocket-protocol */
const SUBSCRIPTION = "subscribe";
/** Endpoint to edit a model using a command */
const EDIT = "edit";
/** Endpoint to close a model. This unloads the model form the workspace and omits discards any dirty changes */
const CLOSE = "close";
/** Endpoint to save a model */
const SAVE = "save";
/** Endpoint to save all currently loaded models */
const SAVE_ALL = "saveall";
/** Endpoint to undo the last edit command on model */
const UNDO = "undo";
/** Endpoint to redo the last edit command on model */
const REDO = "redo";
/** Endpoint to trigger validation for a model */
const VALIDATION = "validation";
/** Endpoint to get a list of validation constraints of a model */
const VALIDATION_CONSTRAINTS = "validation/constraints";
}
//# sourceMappingURL=model-server-paths.d.ts.map