Skip to search

API

hub.traefik.io / v1alpha1

apiVersion: hub.traefik.io/v1alpha1 kind: API metadata: name: example
View raw schema
apiVersion string
APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
kind string
Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
metadata object
spec object
APISpec describes the API.
openApiSpec object
OpenAPISpec defines the API contract as an OpenAPI specification.
operationSets []object
OperationSets defines the sets of operations to be referenced for granular filtering in APIAccesses.
maxItems: 100
matchers []object required
Matchers defines a list of alternative rules for matching OpenAPI operations.
minItems: 1
maxItems: 100
methods []string
Methods specifies the HTTP methods to be included for selection.
maxItems: 10
path string
Path specifies the exact path of the operations to select.
maxLength: 255
pathPrefix string
PathPrefix specifies the path prefix of the operations to select.
maxLength: 255
pathRegex string
PathRegex specifies a regular expression pattern for matching operations based on their paths.
name string required
Name is the name of the OperationSet to reference in APIAccesses.
maxLength: 253
override object
Override holds data used to override OpenAPI specification.
servers []object required
minItems: 1
maxItems: 100
url string required
path string
Path specifies the endpoint path within the Kubernetes Service where the OpenAPI specification can be obtained. The Service queried is determined by the associated Ingress, IngressRoute, or HTTPRoute resource to which the API is attached. It's important to note that this option is incompatible if the Ingress or IngressRoute specifies multiple backend services. The Path must be accessible via a GET request method and should serve a YAML or JSON document containing the OpenAPI specification.
maxLength: 255
url string
URL is a Traefik Hub agent accessible URL for obtaining the OpenAPI specification. The URL must be accessible via a GET request method and should serve a YAML or JSON document containing the OpenAPI specification.
versions []object
Versions are the different APIVersions available.
minItems: 1
maxItems: 100
name string required
Name of the APIVersion.
maxLength: 253
status object
The current status of this API.
hash string
Hash is a hash representing the API.
syncedAt string
format: date-time
version string

No matches. Try .spec.openApiSpec for an exact path