constants

Documentation

Index

• Constants

Constants

const (
	Urls                  string = "urls"
	Type                  string = "type"
	HTTP                  string = "http"
	HTTPS                 string = "https"
	LoadBalance           string = "load_balance"
	FailOver              string = "failover"
	AdvanceEndpointConfig string = "advanceEndpointConfig"
	SecurityConfig        string = "securityConfig"
)

endpoint related constants

const (
	XWso2BasePath                     string = "x-wso2-basePath"
	XWso2HTTP2BackendEnabled          string = "x-wso2-http2-backend-enabled"
	XThrottlingTier                   string = "x-throttling-tier"
	XWso2ThrottlingTier               string = "x-wso2-throttling-tier"
	XAuthHeader                       string = "x-wso2-auth-header"
	XAuthType                         string = "x-auth-type"
	XWso2DisableSecurity              string = "x-wso2-disable-security"
	None                              string = "None"
	DefaultSecurity                   string = "default"
	XMediationScript                  string = "x-mediation-script"
	XScopes                           string = "x-scopes"
	XWso2PassRequestPayloadToEnforcer string = "x-wso2-pass-request-payload-to-enforcer"
	XUriMapping                       string = "x-uri-mapping"
)

Constants for OpenAPI vendor extension keys and values

const (
	AuthorizationHeader  string = "authorization"
	TestConsoleKeyHeader string = "internal-key"
)

sub-property values and keys relevant for x-wso2-application security extension

const (
	XWso2RequestInterceptor   string = "x-wso2-request-interceptor"
	XWso2ResponseInterceptor  string = "x-wso2-response-interceptor"
	ServiceURL                string = "serviceURL"
	ClusterTimeout            string = "clusterTimeout"
	RequestTimeout            string = "requestTimeout"
	Includes                  string = "includes"
	OperationLevelInterceptor string = "operation"
)

sub-property keys mentioned under x-wso2-request-interceptor and x-wso2-response-interceptor

const (
	AlreadyExists string = "ALREADY_EXISTS"
	NotFound      string = "NOT_FOUND"
)

Constants to represent errors

const (
	ActionHeaderAdd          string = "SET_HEADER"
	ActionHeaderRemove       string = "REMOVE_HEADER"
	ActionRewriteMethod      string = "REWRITE_RESOURCE_METHOD"
	ActionInterceptorService string = "CALL_INTERCEPTOR_SERVICE"
	ActionRewritePath        string = "REWRITE_RESOURCE_PATH"
	ActionRedirectRequest    string = "REDIRECT_REQUEST"
	ActionMirrorRequest      string = "MIRROR_REQUEST"

	PolicyRequestInterceptor  string = "PolicyRequestInterceptor"
	PolicyResponseInterceptor string = "PolicyResponseInterceptor"

	RewritePathResourcePath    string = "resourcePath"
	RewritePathType            string = "rewritePathType"
	InterceptorServiceURL      string = "interceptorServiceURL"
	InterceptorEndpoints       string = "interceptorEndpoints"
	InterceptorServiceIncludes string = "includes"
	IncludeQueryParams         string = "includeQueryParams"
	HeaderName                 string = "headerName"
	HeaderValue                string = "headerValue"
	CurrentMethod              string = "currentMethod"
	UpdatedMethod              string = "updatedMethod"
	RedirectScheme             string = "scheme"
	RedirectHostname           string = "hostname"
	RedirectPath               string = "path"
	RedirectPort               string = "port"
	RedirectStatusCode         string = "statusCode"
)

operational policy field names

const (
	REST                  string = "REST"
	SOAP                  string = "SOAP"
	WS                    string = "WS"
	GRAPHQL               string = "GraphQL"
	GRPC                  string = "GRPC"
	WEBHOOK               string = "WEBHOOK"
	SSE                   string = "SSE"
	Prototyped            string = "prototyped"
	MockedOASEndpointType string = "MOCKED_OAS"
	TemplateEndpointType  string = "TEMPLATE"
	InlineEndpointType    string = "INLINE"
)

API Type Constants

const (
	Swagger      string = "swagger"
	OpenAPI      string = "openapi"
	AsyncAPI     string = "asyncapi"
	Swagger2     string = "swagger_2"
	OpenAPI3     string = "openapi_3"
	AsyncAPI2    string = "asyncapi_2"
	NotDefined   string = "not_defined"
	NotSupported string = "not_supported"
)

Constants used for version identification of API definitions

const (
	Mandatory string = "mandatory"
	Optional  string = "optional"
)

Constants used for optionality

const (
	KindAuthentication  = "Authentication"
	KindAPIPolicy       = "APIPolicy"
	KindScope           = "Scope"
	KindRateLimitPolicy = "RateLimitPolicy"
	KindService         = "Service"
	KindBackend         = "Backend"
)

CRD Kinds

const (
	Production = "Production"
	Sandbox    = "Sandbox"
)

API environment types

const (
	OAuth2 string = "OAuth2"
	APIKey string = "APIKey"
)

Security scheme constants