v1
latestOpenAPI 3.1.02026-07-2618690613.4 KBModels
Delete a YAML file
Delete a topic or view YAML file from a model. The file must be a YAML file ending in .topic or .view.
The following models cannot be edited using this endpoint:
- Schema models
- Models using git follower mode
delete/v1/models/{modelId}/yaml
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
- <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.
Note: Workbook models must use combined mode if there is a branchId.
commitMessagestring
Required for git-enabled models. Commit message describing the change.
Response
YAML file deleted successfully