TestMace
0.0.1-beta.24
Search
⌃K

ApiRootFolder

ApiRootFolder - a root node of the API description subnode. Just like the Project node, it is a root element, and in the subnode there can be only one element of this type. It is functionally identical to an ApiFolder node.
You can create this node by:
  • Adding it from the Project node context menu;
  • Using import from API description format.

File Representation

A ApiRootFolder node is a folder with the node name, containing the index.yml file with the following format:
{
"type": "object",
"properties": {
"type": {
"description": "Type of ApiRootFolder node",
"const": "ApiRootFolder",
"type": "string"
},
"children": {
"description": "List of children names",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"variables": {
"$ref": "#/definitions/NodeVariables",
"description": "Node variables dictionary"
},
"name": {
"description": "Node name",
"type": "string"
}
},
"required": [
"children",
"name",
"type",
"variables"
],
"definitions": {
"NodeVariables": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"$schema": "http://json-schema.org/draft-07/schema#"
}