constants

Documentation

Index

• Constants

Constants

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

sub-property keys mentioned under x-wso2-production-endpoints

const (
	XWso2ProdEndpoints                string = "x-wso2-production-endpoints"
	XWso2SandbxEndpoints              string = "x-wso2-sandbox-endpoints"
	XWso2endpoints                    string = "x-wso2-endpoints"
	XWso2BasePath                     string = "x-wso2-basePath"
	XWso2Label                        string = "x-wso2-label"
	XWso2Cors                         string = "x-wso2-cors"
	XWso2HTTP2BackendEnabled          string = "x-wso2-http2-backend-enabled"
	XThrottlingTier                   string = "x-throttling-tier"
	XAmznResourceName                 string = "x-amzn-resource-name"
	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 (
	SandClustersConfigNamePrefix    string = "clusterSand"
	ProdClustersConfigNamePrefix    string = "clusterProd"
	XWso2EPClustersConfigNamePrefix string = "xwso2cluster"
)

cluster name prefixes

const (
	APIMAPIKeyType                       string = "api_key"
	APIKeyNameWithApim                   string = "apikey"
	APIKeyTypeInOAS                      string = "apiKey"
	APIMOauth2Type                       string = "oauth2"
	APIMDefaultOauth2Security            string = "default"
	APIKeyInHeaderOAS                    string = "header"
	APIKeyInQueryOAS                     string = "query"
	APIMAPIKeyInHeader                   string = "api_key_header"
	APIMAPIKeyInQuery                    string = "api_key_query"
	APIMMutualSSLType                    string = "mutualssl"
	APIMMutualSSLMandatoryType           string = "mutualssl_mandatory"
	APIOauthBasicAuthAPIKeyMandatoryType string = "oauth_basic_auth_api_key_mandatory"
)

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"

	RewritePathResourcePath    string = "resourcePath"
	InterceptorServiceURL      string = "interceptorServiceURL"
	InterceptorServiceIncludes string = "includes"
	IncludeQueryParams         string = "includeQueryParams"
	HeaderName                 string = "headerName"
	HeaderValue                string = "headerValue"
	CurrentMethod              string = "currentMethod"
	UpdatedMethod              string = "updatedMethod"
)

operational policy field names

const (
	HTTP                  string = "HTTP"
	SOAP                  string = "SOAP"
	WS                    string = "WS"
	GRAPHQL               string = "GRAPHQL"
	WEBHOOK               string = "WEBHOOK"
	SSE                   string = "SSE"
	Prototyped            string = "prototyped"
	MockedOASEndpointType string = "MOCKED_OAS"
	AwsLambda             string = "awslambda"
	TemplateEndpointType  string = "TEMPLATE"
	InlineEndpointType    string = "INLINE"
)

Constants that occur as values in api.yaml

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