# Packages
Package custom defines interfaces to interact with custom entities in Kong.
# Functions
Bool returns a pointer to b.
FillEntityDefaults ingests entities' defaults from their schema.
FillPluginsDefaults ingests plugin's defaults from its schema.
Float64 returns a pointer to f.
HTTPClientWithHeaders returns a client which injects headers before sending any request.
Int returns a pointer to i.
IsNotFoundErr returns true if the error or it's cause is a 404 response from Kong.
MustNewRange creates a new instance of a Version; however it will panic if it cannot be created.
MustNewVersion creates a new instance of a Version; however it will panic if it cannot be created.
No description provided by the author
NewClient returns a Client which talks to Admin API of Kong.
NewRange creates an instance of a Range.
No description provided by the author
NewVersion creates a new instance of a Version.
ParseSemanticVersion creates a semantic version from the version returned by Kong.
RunWhenEnterprise skips a test if the version of Kong running is not enterprise edition.
RunWhenKong skips the current test if the version of Kong doesn't fall in the versionRange.
SkipWhenEnterprise skips a test if the Kong version is an Enterprise version.
String returns pointer to s.
StringSlice converts a slice of string to a slice of *string.
VersionFromInfo retrieves the version from the response of root or /kong endpoints.
# Constants
DefaultTimeout is the timeout used for network connections and requests including TCP, TLS and HTTP layers.
# Structs
ACLGroup represents an ACL group for a consumer in Kong.
ActiveHealthcheck configures active health check probing.
Admin represents an Admin in Kong.
APIError is used for Kong Admin API errors.
BasicAuth represents a basic-auth credential in Kong.
CACertificate represents a CACertificate in Kong.
Certificate represents a Certificate in Kong.
CIDRPort represents a set of CIDR and a port.
Client talks to the Admin API or control plane of a Kong cluster.
Consumer represents a Consumer in Kong.
Developer represents a Developer in Kong.
DeveloperRole represents a Developer Role in Kong.
Healthcheck represents a health-check config of an upstream in Kong.
HealthData represents the health data of a target +k8s:deepcopy-gen=true.
HealthDataAddress represents the health data address of a target +k8s:deepcopy-gen=true.
HealthDataWeight represents the health data weight of a target +k8s:deepcopy-gen=true.
Healthy configures thresholds and HTTP status codes to mark targets healthy for an upstream.
HMACAuth represents a hmac-auth credential in Kong.
Info represents the information concerning Kong.
JWTAuth represents a JWT credential in Kong.
KeyAuth represents a key-auth credential in Kong.
ListOpt aids in paginating through list endpoints.
MTLSAuth represents a MTLS credential in Kong.
Oauth2Credential represents a Oauth2 credential in Kong.
PassiveHealthcheck configures passive checks around passive health checks.
Plugin represents a Plugin in Kong.
KongPluginOrdering contains before or after instructions for plugin execution order +k8s:deepcopy-gen=true.
ProxyListener is a configured listener on the Kong Gateway for L7 routing.
RBACEndpointPermission represents an RBAC Endpoint Permission in Kong Enterprise +k8s:deepcopy-gen=true Note: this type implements a custom JSON marshaler.
RBACEntityPermission represents an RBAC Entity Permission in Kong Enterprise +k8s:deepcopy-gen=true Note: this type implements a custom JSON marshaler.
RBACPermissionsList is a list of permissions, both endpoint and entity, associated with a Role.
RBACRole represents an RBAC Role in Kong.
RBACUser represents an RBAC user in Kong Enterprise +k8s:deepcopy-gen=true.
No description provided by the author
Response is a Kong Admin API response.
Route represents a Route in Kong.
RuntimeConfiguration represents the runtime configuration of Kong.
Service represents a Service in Kong.
SNI represents a SNI in Kong.
Status respresents current status of a Kong node.
StreamListener is a configured listener on the Kong Gateway for L4 routing.
Target represents a Target in Kong.
Unhealthy configures thresholds and HTTP status codes to mark targets unhealthy.
Upstream represents an Upstream in Kong.
UpstreamNodeHealth represents the node health of a upstream +k8s:deepcopy-gen=true.
Vault represents a Vault in Kong.
Version represents a three or four digit version.
Workspace represents a Workspace in Kong.
WorkspaceEntity represents a WorkspaceEntity in Kong +k8s:deepcopy-gen=true.
# Interfaces
AbstractACLService handles consumer ACL groups in Kong.
AbstractAdminService handles Admins in Kong.
AbstractBasicAuthService handles basic-auth credentials in Kong.
AbstractCACertificateService handles Certificates in Kong.
AbstractCertificateService handles Certificates in Kong.
AbstractConsumerService handles Consumers in Kong.
AbstractCustomEntityService handles custom entities in Kong.
AbstractDeveloperRoleService handles Developer Roles in Kong.
AbstractDeveloperService handles Developers in Kong.
AbstractHMACAuthService handles hmac-auth credentials in Kong.
AbstractInfoService handles Kong's Information.
AbstractJWTAuthService handles JWT credentials in Kong.
AbstractKeyAuthService handles key-auth credentials in Kong.
AbstractMTLSAuthService handles MTLS credentials in Kong.
AbstractOauth2Service handles oauth2 credentials in Kong.
AbstractPluginService handles Plugins in Kong.
AbstractRBACEndpointPermissionService handles RBACEndpointPermissions in Kong.
AbstractRBACEntityPermissionService handles RBACEntityPermissions in Kong.
AbstractRBACRoleService handles Roles in Kong.
AbstractRBACUserService handles Users in Kong.
AbstractRouteService handles routes in Kong.
AbstractSchemaService handles schemas in Kong.
AbstractSNIService handles SNIs in Kong.
AbstractSvcService handles services in Kong.
AbstractTagService handles Tags in Kong.
AbstractTargetService handles Targets in Kong.
AbstractUpstreamNodeHealthService handles Upstream Node Healths in Kong.
AbstractUpstreamService handles Upstreams in Kong.
AbstractVaultService handles Vaults in Kong.
AbstractWorkspaceService handles Workspaces in Kong.
# Type aliases
ACLService handles consumer ACL groups in Kong.
AdminService handles Admins in Kong.
BasicAuthService handles basic-auth credentials in Kong.
CACertificateService handles Certificates in Kong.
CertificateService handles Certificates in Kong.
Configuration represents a config of a plugin in Kong.
ConsumerService handles Consumers in Kong.
CustomEntityService handles custom entities in Kong.
DeveloperRoleService handles Developer Roles in Kong.
DeveloperService handles Developers in Kong.
HMACAuthService handles hmac-auth credentials in Kong.
No description provided by the author
JWTAuthService handles JWT credentials in Kong.
KeyAuthService handles key-auth credentials in Kong.
MTLSAuthService handles MTLS credentials in Kong.
Oauth2Service handles oauth2 credentials in Kong.
PluginOrderingPhase indicates which plugins in a phase should affect the target plugin's order +k8s:deepcopy-gen=true.
PluginService handles Plugins in Kong.
Range represents a range of versions which can be used to validate if a Version is valid for a Range.
RBACEndpointPermissionService handles RBACEndpointPermissions in Kong.
RBACEntityPermissionService handles RBACEntityPermissions in Kong.
RBACRoleService handles Roles in Kong.
RBACUserService handles Users in Kong.
RouteService handles routes in Kong.
Schema represents an entity schema in Kong.
SchemaService handles schemas in Kong.
SNIService handles SNIs in Kong.
Svcservice handles services in Kong.
TagService handles Tags in Kong.
TargetService handles Targets in Kong.
UpstreamNodeHealthService handles Upstream Node Healths in Kong.
UpstreamService handles Upstreams in Kong.
VaultService handles Vaults in Kong.
WorkspaceService handles Workspaces in Kong.