{ "description": "API defines an HTTP interface that is exposed to external clients. It specifies the supported versions\nand provides instructions for accessing its documentation. Once instantiated, an API object is associated\nwith an Ingress, IngressRoute, or HTTPRoute resource, enabling the exposure of the described API to the outside world.", "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", "null" ] }, "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", "null" ] }, "metadata": { "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "APISpec describes the API.", "properties": { "cors": { "additionalProperties": false, "description": "Cors defines the Cross-Origin Resource Sharing configuration.", "properties": { "addVaryHeader": { "description": "AddVaryHeader defines whether the Vary header is automatically added/updated when the AllowOriginsList is set.", "type": [ "boolean", "null" ] }, "allowCredentials": { "description": "AllowCredentials defines whether the request can include user credentials.", "type": [ "boolean", "null" ] }, "allowHeadersList": { "description": "AllowHeadersList defines the Access-Control-Request-Headers values sent in preflight response.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "allowMethodsList": { "description": "AllowMethodsList defines the Access-Control-Request-Method values sent in preflight response.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "allowOriginListRegex": { "description": "AllowOriginListRegex is a list of allowable origins written following the Regular Expression syntax (https://golang.org/pkg/regexp/).", "items": { "type": "string" }, "type": [ "array", "null" ] }, "allowOriginsList": { "description": "AllowOriginsList is a list of allowable origins. Can also be a wildcard origin \"*\".", "items": { "type": "string" }, "type": [ "array", "null" ] }, "exposeHeadersList": { "description": "ExposeHeadersList defines the Access-Control-Expose-Headers values sent in preflight response.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "maxAge": { "description": "MaxAge defines the time that a preflight request may be cached.", "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "description": { "description": "Description explains what the API does.", "type": [ "string", "null" ] }, "openApiSpec": { "additionalProperties": false, "description": "OpenAPISpec defines the API contract as an OpenAPI specification.", "properties": { "operationSets": { "description": "OperationSets defines the sets of operations to be referenced for granular filtering in APICatalogItems or ManagedSubscriptions.", "items": { "additionalProperties": false, "description": "OperationSet gives a name to a set of matching OpenAPI operations.\nThis set of operations can then be referenced for granular filtering in APICatalogItems or ManagedSubscriptions.", "properties": { "matchers": { "description": "Matchers defines a list of alternative rules for matching OpenAPI operations.", "items": { "additionalProperties": false, "description": "OperationMatcher defines criteria for matching an OpenAPI operation.", "minProperties": 1, "properties": { "methods": { "description": "Methods specifies the HTTP methods to be included for selection.", "items": { "type": "string" }, "maxItems": 10, "type": [ "array", "null" ] }, "path": { "description": "Path specifies the exact path of the operations to select.", "maxLength": 255, "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "must start with a '/'", "rule": "self.startsWith('/')" }, { "message": "cannot contains '../'", "rule": "!self.matches(r\"\"\"(\\/\\.\\.\\/)|(\\/\\.\\.$)\"\"\")" } ] }, "pathPrefix": { "description": "PathPrefix specifies the path prefix of the operations to select.", "maxLength": 255, "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "must start with a '/'", "rule": "self.startsWith('/')" }, { "message": "cannot contains '../'", "rule": "!self.matches(r\"\"\"(\\/\\.\\.\\/)|(\\/\\.\\.$)\"\"\")" } ] }, "pathRegex": { "description": "PathRegex specifies a regular expression pattern for matching operations based on their paths.", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-validations": [ { "message": "path, pathPrefix and pathRegex are mutually exclusive", "rule": "[has(self.path), has(self.pathPrefix), has(self.pathRegex)].filter(x, x).size() \u003c= 1" } ] }, "maxItems": 100, "minItems": 1, "type": "array" }, "name": { "description": "Name is the name of the OperationSet to reference in APICatalogItems or ManagedSubscriptions.", "maxLength": 253, "type": "string" } }, "required": [ "matchers", "name" ], "type": "object" }, "maxItems": 100, "type": [ "array", "null" ] }, "override": { "additionalProperties": false, "description": "Override holds data used to override OpenAPI specification.", "properties": { "servers": { "items": { "additionalProperties": false, "properties": { "url": { "type": "string", "x-kubernetes-validations": [ { "message": "must be a valid URL", "rule": "isURL(self)" } ] } }, "required": [ "url" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": "array" } }, "required": [ "servers" ], "type": [ "object", "null" ] }, "path": { "description": "Path specifies the endpoint path within the Kubernetes Service where the OpenAPI specification can be obtained.\nThe Service queried is determined by the associated Ingress, IngressRoute, or HTTPRoute resource to which the API is attached.\nIt's important to note that this option is incompatible if the Ingress or IngressRoute specifies multiple backend services.\nThe Path must be accessible via a GET request method and should serve a YAML or JSON document containing the OpenAPI specification.", "maxLength": 255, "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "must start with a '/'", "rule": "self.startsWith('/')" }, { "message": "cannot contains '../'", "rule": "!self.matches(r\"\"\"(\\/\\.\\.\\/)|(\\/\\.\\.$)\"\"\")" } ] }, "url": { "description": "URL is a Traefik Hub agent accessible URL for obtaining the OpenAPI specification.\nThe URL must be accessible via a GET request method and should serve a YAML or JSON document containing the OpenAPI specification.", "type": [ "string", "null" ], "x-kubernetes-validations": [ { "message": "must be a valid URL", "rule": "isURL(self)" } ] }, "validateRequestMethodAndPath": { "description": "ValidateRequestMethodAndPath validates that the path and method matches an operation defined in the OpenAPI specification.\nThis option overrides the default behavior configured in the static configuration.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-validations": [ { "message": "path or url must be defined", "rule": "has(self.path) || has(self.url)" } ] }, "title": { "description": "Title is the human-readable name of the API that will be used on the portal.", "maxLength": 253, "type": [ "string", "null" ] }, "versions": { "description": "Versions are the different APIVersions available.", "items": { "additionalProperties": false, "description": "APIVersionRef references an APIVersion.", "properties": { "name": { "description": "Name of the APIVersion.", "maxLength": 253, "type": "string" } }, "required": [ "name" ], "type": "object" }, "maxItems": 100, "minItems": 1, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "status": { "additionalProperties": false, "description": "The current status of this API.", "properties": { "conditions": { "items": { "additionalProperties": false, "description": "Condition contains details for one aspect of the current state of this API Resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the last time the condition transitioned from one status to another.\nThis should be when the underlying condition changed. If that is not known, then using the time when the API field changed is acceptable.", "format": "date-time", "type": "string" }, "message": { "description": "message is a human readable message indicating details about the transition.\nThis may be an empty string.", "maxLength": 32768, "type": "string" }, "observedGeneration": { "description": "observedGeneration represents the .metadata.generation that the condition was set based upon.\nFor instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date\nwith respect to the current state of the instance.", "format": "int64", "minimum": 0, "type": [ "integer", "null" ] }, "reason": { "description": "reason contains a programmatic identifier indicating the reason for the condition's last transition.\nProducers of specific condition types may define expected values and meanings for this field,\nand whether the values are considered a guaranteed API.\nThe value should be a CamelCase string.\nThis field may not be empty.", "maxLength": 1024, "minLength": 1, "pattern": "^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$", "type": "string" }, "status": { "description": "status of the condition, one of True, False, Unknown.", "enum": [ "True", "False", "Unknown" ], "type": "string" }, "type": { "description": "type of condition in CamelCase or in foo.example.com/CamelCase.", "maxLength": 316, "pattern": "^([a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*/)?(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9])$", "type": "string" } }, "required": [ "lastTransitionTime", "message", "reason", "status", "type" ], "type": "object" }, "type": [ "array", "null" ] }, "hash": { "description": "Hash is a hash representing the API.", "type": [ "string", "null" ] }, "syncedAt": { "format": "date-time", "type": [ "string", "null" ] }, "version": { "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": "object" }