apisixroute_v2.json

{
  "type": "object",
  "properties": {
    "spec": {
      "type": "object",
      "anyOf": [
        {
          "required": [
            "http"
          ]
        },
        {
          "required": [
            "stream"
          ]
        }
      ],
      "properties": {
        "http": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "anyOf": [
              {
                "required": [
                  "name",
                  "match",
                  "backends"
                ]
              },
              {
                "required": [
                  "name",
                  "match",
                  "upstreams"
                ]
              }
            ],
            "properties": {
              "name": {
                "type": "string",
                "minLength": 1
              },
              "priority": {
                "type": "integer"
              },
              "timeout": {
                "type": "object",
                "properties": {
                  "connect": {
                    "type": "string"
                  },
                  "send": {
                    "type": "string"
                  },
                  "read": {
                    "type": "string"
                  }
                },
                "additionalProperties": false
              },
              "match": {
                "type": "object",
                "required": [
                  "paths"
                ],
                "properties": {
                  "paths": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "string",
                      "pattern": "^/[a-zA-Z0-9\\-._~%!$&'()+,;=:@/]*\\*?$"
                    }
                  },
                  "hosts": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "string",
                      "pattern": "^\\*?[0-9a-zA-Z-._]+$"
                    }
                  },
                  "methods": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "string",
                      "enum": [
                        "CONNECT",
                        "DELETE",
                        "GET",
                        "HEAD",
                        "OPTIONS",
                        "PATCH",
                        "POST",
                        "PUT",
                        "TRACE"
                      ]
                    }
                  },
                  "remoteAddrs": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "string"
                    }
                  },
                  "exprs": {
                    "type": "array",
                    "minItems": 1,
                    "items": {
                      "type": "object",
                      "properties": {
                        "subject": {
                          "type": "object",
                          "properties": {
                            "scope": {
                              "type": "string",
                              "enum": [
                                "Cookie",
                                "Header",
                                "Path",
                                "Query",
                                "Variable"
                              ]
                            },
                            "name": {
                              "type": "string",
                              "minLength": 1
                            }
                          },
                          "required": [
                            "scope"
                          ],
                          "additionalProperties": false
                        },
                        "op": {
                          "type": "string",
                          "enum": [
                            "Equal",
                            "NotEqual",
                            "GreaterThan",
                            "GreaterThanEqual",
                            "LessThan",
                            "LessThanEqual",
                            "In",
                            "NotIn",
                            "RegexMatch",
                            "RegexNotMatch",
                            "RegexMatchCaseInsensitive",
                            "RegexNotMatchCaseInsensitive"
                          ]
                        },
                        "value": {
                          "type": "string"
                        },
                        "set": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      },
                      "oneOf": [
                        {
                          "required": [
                            "subject",
                            "op",
                            "value"
                          ]
                        },
                        {
                          "required": [
                            "subject",
                            "op",
                            "set"
                          ]
                        }
                      ],
                      "additionalProperties": false
                    }
                  }
                },
                "additionalProperties": false
              },
              "websocket": {
                "type": "boolean"
              },
              "plugin_config_name": {
                "type": "string",
                "minLength": 1
              },
              "upstreams": {
                "description": "Upstreams refer to ApisixUpstream CRD",
                "type": "array",
                "items": {
                  "description": "ApisixRouteUpstreamReference contains a ApisixUpstream CRD reference",
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "weight": {
                      "type": "integer"
                    }
                  },
                  "additionalProperties": false
                }
              },
              "backends": {
                "type": "array",
                "minItems": 1,
                "items": {
                  "type": "object",
                  "properties": {
                    "serviceName": {
                      "type": "string",
                      "minLength": 1
                    },
                    "servicePort": {
                      "anyOf": [
                        {
                          "type": "integer"
                        },
                        {
                          "type": "string"
                        }
                      ],
                      "x-kubernetes-int-or-string": true
                    },
                    "resolveGranularity": {
                      "type": "string",
                      "enum": [
                        "endpoint",
                        "service"
                      ]
                    },
                    "weight": {
                      "type": "integer",
                      "minimum": 0
                    },
                    "subset": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "required": [
                  "serviceName",
                  "servicePort"
                ]
              },
              "plugins": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1
                    },
                    "enable": {
                      "type": "boolean"
                    },
                    "config": {
                      "type": "object",
                      "x-kubernetes-preserve-unknown-fields": true
                    },
                    "secretRef": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "required": [
                  "name",
                  "enable"
                ]
              },
              "authentication": {
                "type": "object",
                "properties": {
                  "enable": {
                    "type": "boolean"
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "basicAuth",
                      "keyAuth",
                      "jwtAuth",
                      "wolfRBAC",
                      "hmacAuth"
                    ]
                  },
                  "keyAuth": {
                    "type": "object",
                    "properties": {
                      "header": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  },
                  "jwtAuth": {
                    "type": "object",
                    "properties": {
                      "header": {
                        "type": "string"
                      },
                      "query": {
                        "type": "string"
                      },
                      "cookie": {
                        "type": "string"
                      }
                    },
                    "additionalProperties": false
                  }
                },
                "required": [
                  "enable"
                ],
                "additionalProperties": false
              }
            },
            "additionalProperties": false
          }
        },
        "stream": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "object",
            "required": [
              "name",
              "match",
              "backend",
              "protocol"
            ],
            "properties": {
              "protocol": {
                "type": "string",
                "enum": [
                  "TCP",
                  "UDP"
                ]
              },
              "name": {
                "type": "string",
                "minLength": 1
              },
              "match": {
                "type": "object",
                "properties": {
                  "host": {
                    "type": "string"
                  },
                  "ingressPort": {
                    "type": "integer",
                    "minimum": 1,
                    "maximum": 65535
                  }
                },
                "required": [
                  "ingressPort"
                ],
                "additionalProperties": false
              },
              "backend": {
                "type": "object",
                "properties": {
                  "serviceName": {
                    "type": "string",
                    "minLength": 1
                  },
                  "servicePort": {
                    "anyOf": [
                      {
                        "type": "integer"
                      },
                      {
                        "type": "string"
                      }
                    ],
                    "x-kubernetes-int-or-string": true
                  },
                  "resolveGranularity": {
                    "type": "string",
                    "enum": [
                      "endpoint",
                      "service"
                    ]
                  },
                  "subset": {
                    "type": "string"
                  }
                },
                "required": [
                  "serviceName",
                  "servicePort"
                ],
                "additionalProperties": false
              },
              "plugins": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string",
                      "minLength": 1
                    },
                    "enable": {
                      "type": "boolean"
                    },
                    "config": {
                      "type": "object",
                      "x-kubernetes-preserve-unknown-fields": true
                    },
                    "secretRef": {
                      "type": "string"
                    }
                  },
                  "additionalProperties": false
                },
                "required": [
                  "name",
                  "enable"
                ]
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    },
    "status": {
      "type": "object",
      "properties": {
        "conditions": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "type": {
                "type": "string"
              },
              "reason": {
                "type": "string"
              },
              "status": {
                "type": "string"
              },
              "message": {
                "type": "string"
              },
              "observedGeneration": {
                "type": "integer"
              }
            },
            "additionalProperties": false
          }
        }
      },
      "additionalProperties": false
    }
  }
}