ApiRootFolder

ApiRootFolder - это корневой узел поддерева описания API. Он, по аналогии с Project узлом, является корневым элементом, и в пределах поддерева описания API может быть может быть только один элемент данного типа. В остальном повторяет функционал ApiFolder узла.

Создать данный узел можно одним из следующих способов

  • Из контекстного меню Project узла

  • Воспользовавшись импортом из форматов описания API

Файловое представление

ApiRootFolder узел представляет из себя папку с названием узла, внутри которой содержится файл index.yml, имеющий следующий формат:

{
"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#"
}