← Back to index Esc
Kind
Apicatalogitem
Group
hub.traefik.io
Version
v1alpha1
apiVersion: hub.traefik.io/v1alpha1 kind: Apicatalogitem 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
The desired behavior of this APICatalogItem.
apiBundles []object
APIBundles defines a set of APIBundle that will be visible to the configured audience. Multiple APICatalogItem can select the same APIBundles.
maxItems: 100
name string required
Name of the APIBundle.
maxLength: 253
apiPlan object
APIPlan defines which APIPlan will be available. If multiple APICatalogItem specify the same API with different APIPlan, the API consumer will be able to pick a plan from this list.
name string required
Name of the APIPlan.
maxLength: 253
apiSelector object
APISelector selects the APIs that will be visible to the configured audience. Multiple APICatalogItem can select the same set of APIs. This field is optional and follows standard label selector semantics. An empty APISelector matches any API.
matchExpressions []object
matchExpressions is a list of label selector requirements. The requirements are ANDed.
key string required
key is the label key that the selector applies to.
operator string required
operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist.
values []string
values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch.
matchLabels object
matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed.
apis []object
APIs defines a set of APIs that will be visible to the configured audience. Multiple APICatalogItem can select the same APIs. When combined with APISelector, this set of APIs is appended to the matching APIs.
maxItems: 100
name string required
Name of the API.
maxLength: 253
everyone boolean
Everyone indicates that all users will see these APIs.
groups []string
Groups are the consumer groups that will see the APIs.
operationFilter object
OperationFilter specifies the visible operations on APIs and APIVersions. If not set, all operations are available. An empty OperationFilter prohibits all operations.
include []string
Include defines the names of OperationSets that will be accessible.
maxItems: 100
status object
The current status of this APICatalogItem.
conditions []object
Conditions is the list of status conditions.
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 APICatalogItem.
resolvedApis []object
ResolvedAPIs is the list of APIs that were successfully resolved.
name string required
Name of the API.
syncedAt string
format: date-time
unresolvedApis []object
UnresolvedAPIs is the list of APIs that could not be resolved.
name string required
Name of the API.
version string
Copied!