Apache Knox · Schema

Descriptor

A Knox simple descriptor

API GatewayAuthenticationHadoopOpen SourceSecuritySSO

Properties

Name	Type	Description
name	string	Descriptor name
discoveryType	string	Service discovery type
discoveryAddress	string	Discovery service address
cluster	string	Cluster name
providerConfig	string	Referenced provider configuration
services	array	Services exposed by this descriptor

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-knox/refs/heads/main/json-schema/admin-api-descriptor-schema.json",
  "title": "Descriptor",
  "description": "A Knox simple descriptor",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Descriptor name",
      "example": "hadoop-cluster"
    },
    "discoveryType": {
      "type": "string",
      "description": "Service discovery type",
      "example": "Ambari"
    },
    "discoveryAddress": {
      "type": "string",
      "description": "Discovery service address",
      "example": "http://ambari:8080"
    },
    "cluster": {
      "type": "string",
      "description": "Cluster name",
      "example": "my-cluster"
    },
    "providerConfig": {
      "type": "string",
      "description": "Referenced provider configuration",
      "example": "my-provider-config"
    },
    "services": {
      "type": "array",
      "description": "Services exposed by this descriptor",
      "items": {
        "type": "object"
      }
    }
  }
}