tools/json_schema_compiler/test/enums.json

[
  {
    "namespace": "enums",
    "description": "The enums API.",
    "types": [
      {
        "id": "Enumeration",
        "type": "string",
        "enum": ["one", "two", "three"]
      },
      {
        "id": "OtherEnumeration",
        "type": "string",
        "enum": ["spam", "ham", "eggs"]
      },
      {
        "id": "EnumType",
        "type": "object",
        "properties": {
          "type": {
            "$ref": "Enumeration"
          }
        }
      },
      {
        "id": "HasEnumeration",
        "type": "object",
        "properties": {
          "enumeration": {
            "$ref": "Enumeration"
          },
          "optional_enumeration": {
            "$ref": "Enumeration",
            "optional": true
          }
        }
      },
      {
        "id": "ReferenceEnum",
        "type": "object",
        "properties": {
          "reference_enum": {
            "$ref": "Enumeration"
          }
        }
      },
      {
        "id": "OptionalEnumType",
        "type": "object",
        "properties": {
          "type": {
            "$ref": "Enumeration",
            "optional": true
          }
        }
      },
      {
        "id": "EnumNameTransformation",
        "type": "string",
        "enum": ["FIRST_ENTRY_EXAMPLE",
                "second_entry_example",
                "thirdEntryExample",
                "FourthEntryExample",
                "FIFTH_ENTRY_EXAMPLE_1234",
                "sixth-entry-example",
                "Seventh_entry86_64_example",
                "Eighth_entry86_ARCH_example",
                "kNinthEntryExample",
                ""]
      }
    ],
    "functions": [
      {
        "name": "takesEnum",
        "type": "function",
        "description": "Takes an enum as its parameter.",
        "parameters": [
          {
            "name": "state",
            "$ref": "Enumeration"
          }
        ],
        "returns_async": {
          "name": "callback",
          "parameters": []
        }
      },
      {
        "name": "takesEnumArray",
        "type": "function",
        "description": "Takes an enum array as its parameter.",
        "parameters": [
          {
            "name": "values",
            "type": "array",
            "items": {
              "$ref": "Enumeration"
            }
          }
        ],
        "returns_async": {
          "name": "callback",
          "parameters": []
        }
      },
      {
        "name": "takesEnumAsType",
        "type": "function",
        "description": "Takes an enum type as its parameter.",
        "parameters": [
          {
            "name": "enumeration",
            "$ref": "Enumeration"
          }
        ],
        "returns_async": {
          "name": "callback",
          "parameters": []
        }
      },
      {
        "name": "takesEnumArrayAsType",
        "type": "function",
        "description": "Takes an enum type array as its parameter.",
        "parameters": [
          {
            "name": "values",
            "type": "array",
            "items": {
              "$ref": "Enumeration"
            }
          }
        ],
        "returns_async": {
          "name": "callback",
          "parameters": []
        }
      },
      {
        "name": "returnsEnum",
        "type": "function",
        "description": "Returns an enum through the callback",
        "parameters": [],
        "returns_async": {
          "name": "callback",
          "parameters": [
            {
              "name": "state",
              "$ref": "Enumeration"
            }
          ]
        }
      },
      {
        "name": "returnsEnumAsType",
        "type": "function",
        "description": "Returns an enum through the callback",
        "parameters": [],
        "returns_async": {
          "name": "callback",
          "parameters": [
            {
              "name": "enumeration",
              "$ref": "Enumeration"
            }
          ]
        }
      },
      {
        "name": "returnsTwoEnums",
        "type": "function",
        "description": "Returns two enums through the callback",
        "parameters": [],
        "returns_async": {
          "name": "callback",
          "does_not_support_promises": "Multi-parameter callback for test",
          "parameters": [
            {
              "name": "firstState",
              "$ref": "Enumeration"
            },
            {
              "name": "secondState",
              "$ref": "OtherEnumeration"
            }
          ]
        }
      },
      {
        "name": "takesOptionalEnum",
        "type": "function",
        "description": "Takes an enum as its parameter.",
        "parameters": [
          {
            "name": "state",
            "$ref": "Enumeration",
            "optional": true
          }
        ],
        "returns_async": {
          "name": "callback",
          "parameters": []
        }
      },
      {
        "name": "takesMultipleOptionalEnums",
        "type": "function",
        "description": "Takes two enums as parameters.",
        "parameters": [
          {
            "name": "state",
            "$ref": "Enumeration",
            "optional": true
          },
          {
            "name": "type",
            "$ref": "OtherEnumeration",
            "optional": true
          }
        ],
        "returns_async": {
          "name": "callback",
          "parameters": []
        }
      }
    ],
    "events": [
      {
        "name": "onEnumFired",
        "type": "function",
        "description": "Fired when an enum is ready.",
        "parameters": [
          {
            "name": "someEnum",
            "$ref": "Enumeration"
          }
        ]
      },
      {
        "name": "onTwoEnumsFired",
        "type": "function",
        "description": "Fired when two enums are ready.",
        "parameters": [
          {
            "name": "firstEnum",
            "$ref": "Enumeration"
          },
          {
            "name": "secondEnum",
            "$ref": "OtherEnumeration"
          }
        ]
      }
    ]
  }
]