webhook_v1alpha1.json

{
  "description": "Webhook connects to a third party API server to handle the secrets generation\nconfiguration parameters in spec.\nYou can specify the server, the token, and additional body parameters.\nSee documentation for the full API specification for requests and responses.",
  "properties": {
    "apiVersion": {
      "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources",
      "type": "string"
    },
    "kind": {
      "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds",
      "type": "string"
    },
    "metadata": {
      "type": "object"
    },
    "spec": {
      "description": "WebhookSpec controls the behavior of the external generator. Any body parameters should be passed to the server through the parameters field.",
      "properties": {
        "body": {
          "description": "Body",
          "type": "string"
        },
        "caBundle": {
          "description": "PEM encoded CA bundle used to validate webhook server certificate. Only used\nif the Server URL is using HTTPS protocol. This parameter is ignored for\nplain HTTP protocol connection. If not set the system root certificates\nare used to validate the TLS connection.",
          "format": "byte",
          "type": "string"
        },
        "caProvider": {
          "description": "The provider for the CA bundle to use to validate webhook server certificate.",
          "properties": {
            "key": {
              "description": "The key the value inside of the provider type to use, only used with \"Secret\" type",
              "type": "string"
            },
            "name": {
              "description": "The name of the object located at the provider type.",
              "type": "string"
            },
            "namespace": {
              "description": "The namespace the Provider type is in.",
              "type": "string"
            },
            "type": {
              "description": "The type of provider to use such as \"Secret\", or \"ConfigMap\".",
              "enum": [
                "Secret",
                "ConfigMap"
              ],
              "type": "string"
            }
          },
          "required": [
            "name",
            "type"
          ],
          "type": "object",
          "additionalProperties": false
        },
        "headers": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "Headers",
          "type": "object"
        },
        "method": {
          "description": "Webhook Method",
          "type": "string"
        },
        "result": {
          "description": "Result formatting",
          "properties": {
            "jsonPath": {
              "description": "Json path of return value",
              "type": "string"
            }
          },
          "type": "object",
          "additionalProperties": false
        },
        "secrets": {
          "description": "Secrets to fill in templates\nThese secrets will be passed to the templating function as key value pairs under the given name",
          "items": {
            "properties": {
              "name": {
                "description": "Name of this secret in templates",
                "type": "string"
              },
              "secretRef": {
                "description": "Secret ref to fill in credentials",
                "properties": {
                  "key": {
                    "description": "The key where the token is found.",
                    "type": "string"
                  },
                  "name": {
                    "description": "The name of the Secret resource being referred to.",
                    "type": "string"
                  }
                },
                "type": "object",
                "additionalProperties": false
              }
            },
            "required": [
              "name",
              "secretRef"
            ],
            "type": "object",
            "additionalProperties": false
          },
          "type": "array"
        },
        "timeout": {
          "description": "Timeout",
          "type": "string"
        },
        "url": {
          "description": "Webhook url to call",
          "type": "string"
        }
      },
      "required": [
        "result",
        "url"
      ],
      "type": "object",
      "additionalProperties": false
    }
  },
  "type": "object"
}