Kong · Schema

ApplicationRegistration

A application's registration for a specific version of an API.

API GatewayAI GatewayAI ConnectivityAgent GatewayEvent GatewayMCP RegistryService MeshLLMKafkaKonnectOpen Source

Properties

Name Type Description
id object
created_at object
updated_at object
status object
api object Details about the API the application is registered to.
application object Details about the application the registration is part of.
View JSON Schema on GitHub

JSON Schema

kong-applicationregistration-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ApplicationRegistration",
  "title": "ApplicationRegistration",
  "description": "A application's registration for a specific version of an API.",
  "type": "object",
  "properties": {
    "id": {
      "$ref": "#/components/schemas/UUID"
    },
    "created_at": {
      "$ref": "#/components/schemas/CreatedAt"
    },
    "updated_at": {
      "$ref": "#/components/schemas/UpdatedAt"
    },
    "status": {
      "$ref": "#/components/schemas/ApplicationRegistrationStatus"
    },
    "api": {
      "description": "Details about the API the application is registered to.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        },
        "name": {
          "description": "The name of the API the application is registered to.",
          "type": "string"
        },
        "version": {
          "description": "The version of the API the application is registered to.",
          "type": "string",
          "nullable": true
        },
        "entity_type": {
          "$ref": "#/components/schemas/EntityType"
        }
      },
      "required": [
        "id",
        "name",
        "version",
        "entity_type"
      ]
    },
    "application": {
      "description": "Details about the application the registration is part of.",
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "id": {
          "$ref": "#/components/schemas/UUID"
        },
        "name": {
          "description": "The name of the application the registration is part of.",
          "type": "string"
        }
      },
      "required": [
        "id",
        "name"
      ]
    }
  },
  "example": {
    "id": "c300cc33-2d33-4754-b086-a98e0fcd36fb",
    "status": "approved",
    "application": {
      "id": "c15e2460-ba40-431d-9df0-4957fcff7cda",
      "name": "App 1"
    },
    "api": {
      "id": "86f637b7-cd95-478b-9b02-d770618f641c",
      "name": "Great Stuff",
      "version": "v1",
      "entity_type": "api"
    },
    "created_at": "2022-12-22T20:13:07.305Z",
    "updated_at": "2022-12-22T20:13:36.710Z"
  },
  "additionalProperties": false,
  "required": [
    "id",
    "created_at",
    "updated_at",
    "status",
    "api",
    "application"
  ]
}