Apiversion v1alpha1 — hub.traefik.io

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

The desired behavior of this APIVersion.

cors object

Cors defines the Cross-Origin Resource Sharing configuration.

addVaryHeader boolean

AddVaryHeader defines whether the Vary header is automatically added/updated when the AllowOriginsList is set.

allowCredentials boolean

AllowCredentials defines whether the request can include user credentials.

allowHeadersList []string

AllowHeadersList defines the Access-Control-Request-Headers values sent in preflight response.

allowMethodsList []string

AllowMethodsList defines the Access-Control-Request-Method values sent in preflight response.

allowOriginListRegex []string

AllowOriginListRegex is a list of allowable origins written following the Regular Expression syntax (https://golang.org/pkg/regexp/).

allowOriginsList []string

AllowOriginsList is a list of allowable origins. Can also be a wildcard origin "*".

exposeHeadersList []string

ExposeHeadersList defines the Access-Control-Expose-Headers values sent in preflight response.

maxAge integer

MaxAge defines the time that a preflight request may be cached.

format: int64

description string

Description explains what the APIVersion does.

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 APICatalogItems or ManagedSubscriptions.

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 APICatalogItems or ManagedSubscriptions.

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.

validateRequestMethodAndPath boolean

ValidateRequestMethodAndPath validates that the path and method matches an operation defined in the OpenAPI specification. This option overrides the default behavior configured in the static configuration.

release string required

Release is the version number of the API. This value must follow the SemVer format: https://semver.org/

maxLength: 100

title string

Title is the public facing name of the APIVersion.

status object

The current status of this APIVersion.

conditions []object

lastTransitionTime string required

lastTransitionTime is the last time the condition transitioned from one status to another. This 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

message string required

message is a human readable message indicating details about the transition. This may be an empty string.

maxLength: 32768

observedGeneration integer

observedGeneration represents the .metadata.generation that the condition was set based upon. For instance, if .metadata.generation is currently 12, but the .status.conditions[x].observedGeneration is 9, the condition is out of date with respect to the current state of the instance.

format: int64

minimum: 0

reason string required

reason contains a programmatic identifier indicating the reason for the condition's last transition. Producers of specific condition types may define expected values and meanings for this field, and whether the values are considered a guaranteed API. The value should be a CamelCase string. This field may not be empty.

pattern: ^[A-Za-z]([A-Za-z0-9_,:]*[A-Za-z0-9_])?$

minLength: 1

maxLength: 1024

status string required

status of the condition, one of True, False, Unknown.

enum: True, False, Unknown

type string required

type of condition in CamelCase or in foo.example.com/CamelCase.

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])$

maxLength: 316

hash string

Hash is a hash representing the APIVersion.

syncedAt string

format: date-time

version string