Kong · JSON-LD Context

Kong Context

JSON-LD context defining the semantic vocabulary for Kong from Kong.

2 Classes 7 Properties 3 Namespaces
View Context View on GitHub

Namespaces

kong: https://docs.konghq.com/gateway/latest/admin-api/#
xsd: http://www.w3.org/2001/XMLSchema#
schema: https://schema.org/

Classes

id type

Properties

Property Type Container
Service
Route
Consumer
Plugin
Upstream
Target
Certificate

JSON-LD Document

Raw ↑
{
  "@context": {
    "@version": 1.1,
    "@vocab": "https://schema.org/",
    "kong": "https://docs.konghq.com/gateway/latest/admin-api/#",
    "id": "@id",
    "type": "@type",

    "Service": {
      "@id": "kong:service-object",
      "@context": {
        "name": "schema:name",
        "description": "schema:description",
        "protocol": {
          "@id": "kong:service-protocol",
          "@type": "xsd:string"
        },
        "host": {
          "@id": "kong:service-host",
          "@type": "xsd:string"
        },
        "port": {
          "@id": "kong:service-port",
          "@type": "xsd:integer"
        },
        "path": {
          "@id": "kong:service-path",
          "@type": "xsd:string"
        },
        "retries": {
          "@id": "kong:service-retries",
          "@type": "xsd:integer"
        },
        "connect_timeout": {
          "@id": "kong:service-connect-timeout",
          "@type": "xsd:integer"
        },
        "write_timeout": {
          "@id": "kong:service-write-timeout",
          "@type": "xsd:integer"
        },
        "read_timeout": {
          "@id": "kong:service-read-timeout",
          "@type": "xsd:integer"
        },
        "url": {
          "@id": "schema:url",
          "@type": "@id"
        },
        "enabled": {
          "@id": "kong:service-enabled",
          "@type": "xsd:boolean"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "tls_verify": {
          "@id": "kong:service-tls-verify",
          "@type": "xsd:boolean"
        },
        "tls_verify_depth": {
          "@id": "kong:service-tls-verify-depth",
          "@type": "xsd:integer"
        },
        "ca_certificates": {
          "@id": "kong:service-ca-certificates",
          "@container": "@set"
        },
        "client_certificate": {
          "@id": "kong:service-client-certificate",
          "@type": "@id"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "Route": {
      "@id": "kong:route-object",
      "@context": {
        "name": "schema:name",
        "description": "schema:description",
        "protocols": {
          "@id": "kong:route-protocols",
          "@container": "@set"
        },
        "methods": {
          "@id": "kong:route-methods",
          "@container": "@set"
        },
        "hosts": {
          "@id": "kong:route-hosts",
          "@container": "@set"
        },
        "paths": {
          "@id": "kong:route-paths",
          "@container": "@set"
        },
        "headers": {
          "@id": "kong:route-headers"
        },
        "snis": {
          "@id": "kong:route-snis",
          "@container": "@set"
        },
        "sources": {
          "@id": "kong:route-sources",
          "@container": "@set"
        },
        "destinations": {
          "@id": "kong:route-destinations",
          "@container": "@set"
        },
        "strip_path": {
          "@id": "kong:route-strip-path",
          "@type": "xsd:boolean"
        },
        "preserve_host": {
          "@id": "kong:route-preserve-host",
          "@type": "xsd:boolean"
        },
        "regex_priority": {
          "@id": "kong:route-regex-priority",
          "@type": "xsd:integer"
        },
        "https_redirect_status_code": {
          "@id": "kong:route-https-redirect-status-code",
          "@type": "xsd:integer"
        },
        "path_handling": {
          "@id": "kong:route-path-handling",
          "@type": "xsd:string"
        },
        "request_buffering": {
          "@id": "kong:route-request-buffering",
          "@type": "xsd:boolean"
        },
        "response_buffering": {
          "@id": "kong:route-response-buffering",
          "@type": "xsd:boolean"
        },
        "expression": {
          "@id": "kong:route-expression",
          "@type": "xsd:string"
        },
        "priority": {
          "@id": "kong:route-priority",
          "@type": "xsd:integer"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "service": {
          "@id": "kong:route-service",
          "@type": "@id"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "Consumer": {
      "@id": "kong:consumer-object",
      "@context": {
        "username": {
          "@id": "kong:consumer-username",
          "@type": "xsd:string"
        },
        "custom_id": {
          "@id": "kong:consumer-custom-id",
          "@type": "xsd:string"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "Plugin": {
      "@id": "kong:plugin-object",
      "@context": {
        "name": "schema:name",
        "instance_name": {
          "@id": "kong:plugin-instance-name",
          "@type": "xsd:string"
        },
        "config": {
          "@id": "kong:plugin-config"
        },
        "protocols": {
          "@id": "kong:plugin-protocols",
          "@container": "@set"
        },
        "enabled": {
          "@id": "kong:plugin-enabled",
          "@type": "xsd:boolean"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "ordering": {
          "@id": "kong:plugin-ordering"
        },
        "service": {
          "@id": "kong:plugin-service",
          "@type": "@id"
        },
        "route": {
          "@id": "kong:plugin-route",
          "@type": "@id"
        },
        "consumer": {
          "@id": "kong:plugin-consumer",
          "@type": "@id"
        },
        "consumer_group": {
          "@id": "kong:plugin-consumer-group",
          "@type": "@id"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "Upstream": {
      "@id": "kong:upstream-object",
      "@context": {
        "name": "schema:name",
        "algorithm": {
          "@id": "kong:upstream-algorithm",
          "@type": "xsd:string"
        },
        "hash_on": {
          "@id": "kong:upstream-hash-on",
          "@type": "xsd:string"
        },
        "hash_fallback": {
          "@id": "kong:upstream-hash-fallback",
          "@type": "xsd:string"
        },
        "slots": {
          "@id": "kong:upstream-slots",
          "@type": "xsd:integer"
        },
        "healthchecks": {
          "@id": "kong:upstream-healthchecks"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "Target": {
      "@id": "kong:target-object",
      "@context": {
        "target": {
          "@id": "kong:target-address",
          "@type": "xsd:string"
        },
        "weight": {
          "@id": "kong:target-weight",
          "@type": "xsd:integer"
        },
        "upstream": {
          "@id": "kong:target-upstream",
          "@type": "@id"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "Certificate": {
      "@id": "kong:certificate-object",
      "@context": {
        "cert": {
          "@id": "kong:certificate-cert",
          "@type": "xsd:string"
        },
        "key": {
          "@id": "kong:certificate-key",
          "@type": "xsd:string"
        },
        "snis": {
          "@id": "kong:certificate-snis",
          "@container": "@set"
        },
        "tags": {
          "@id": "schema:keywords",
          "@container": "@set"
        },
        "created_at": {
          "@id": "schema:dateCreated",
          "@type": "xsd:integer"
        },
        "updated_at": {
          "@id": "schema:dateModified",
          "@type": "xsd:integer"
        }
      }
    },

    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "schema": "https://schema.org/"
  }
}