API nomenclature

For a better understanding of our API, please refer to the terminology we have adopted:

• object - the main elements of the API, on which endpoints operate. For example, user, account, listener, server, etc.
• attribute - a feature of the object. For example, the attributes of the object account include id, name, description, etc.
• property - an attribute property in the object specification. For example, the attribute name properties of the account object are: type, required, ignore_case and unique.

Pattern example:

"object": {
        "attribute": {
            "property0": "value",
            "property1": "value",
            "property2": "value",
            "property3": "value",
        },
}

Partial code example:

"account": {
          "id": {
              "type": "string",
              "readonly": true,
              "grant": "account",
              "unique": true
          },
          "name": {
              "type": "string",
              "required": true,
              "ignore-case": true,
              "unique": true
          },
          "description": {
              "type": "string"
          }
}