OMomni
Models

Delete a YAML file

Delete a topic, composite topic, or view YAML file from a model. The file must be a YAML file ending in .topic, .composite_topic, or .view.

The following models cannot be edited using this endpoint:

  • Schema models
  • Models using git follower mode
delete/v1/models/{modelId}/yaml

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/models/{modelId}/yaml
  • Auth
    HTTP bearer

Path parameters

modelIdstring uuid required

The ID of the model.

Query parameters

fileNamestring required

The name of the YAML file to delete. Valid values are:

  • <topic_name>.topic - Topic file
  • <composite_topic_name>.composite_topic - Composite topic file
  • <view_name>.view - View file
branchIdstring uuid

Required if git pull requests are required for the model. The ID of the branch to delete from. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

mode'combined' | 'extension' | 'staged' | 'merged' | 'history'

The mode to use when deleting the YAML file.

  • combined - Workbook models must use this mode if there is a branchId.
  • extension
  • staged
  • merged - Requires a branchId on a shared or shared extension model.
  • history
commitMessagestring

Required for git-enabled models. Commit message describing the change.

Response

YAML file deleted successfully

fileNamestring

The name of the file that was deleted.

successboolean

Indicates the request was successful.

Changes

No recorded changes to this operation across all 2 revisions of this API.