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:
1
{
2
  "type": "object",
3
  "properties": {
4
    "type": {
5
      "description": "Type of ApiRootFolder node",
6
      "const": "ApiRootFolder",
7
      "type": "string"
8
    },
9
    "children": {
10
      "description": "List of children names",
11
      "type": "array",
12
      "items": {
13
        "type": "string"
14
      },
15
      "default": []
16
    },
17
    "variables": {
18
      "$ref": "#/definitions/NodeVariables",
19
      "description": "Node variables dictionary"
20
    },
21
    "name": {
22
      "description": "Node name",
23
      "type": "string"
24
    }
25
  },
26
  "required": [
27
    "children",
28
    "name",
29
    "type",
30
    "variables"
31
  ],
32
  "definitions": {
33
    "NodeVariables": {
34
      "type": "object",
35
      "additionalProperties": {
36
        "type": "string"
37
      }
38
    }
39
  },
40
  "$schema": "http://json-schema.org/draft-07/schema#"
41
}
Copied!

Node Types - Previous

API description

ApiFolder

Last modified 2yr ago

Copy link

Contents

File Representation