Documentation ¶
Index ¶
- type APIDefinition
- type APIDefinitionCORS
- type APILimit
- type AccessDefinition
- type AccessRequestType
- type AccessSpec
- type AuthConfig
- type AuthProviderCode
- type AuthProviderMeta
- type AuthTypeEnum
- type AuthorizeRequestType
- type BasicAuth
- type BasicAuthData
- type BundleManifest
- type CacheMeta
- type CacheOptions
- type CheckCommand
- type CircuitBreakerMeta
- type Config
- type Duration
- type EndPointMeta
- type EndpointMethodAction
- type EndpointMethodMeta
- type EventHandlerMetaConfig
- func (m *EventHandlerMetaConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *EventHandlerMetaConfig) MarshalBinary() ([]byte, error)
- func (m *EventHandlerMetaConfig) UnmarshalBinary(b []byte) error
- func (m *EventHandlerMetaConfig) Validate(formats strfmt.Registry) error
- type EventHandlerTriggerConfig
- func (m *EventHandlerTriggerConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *EventHandlerTriggerConfig) MarshalBinary() ([]byte, error)
- func (m *EventHandlerTriggerConfig) UnmarshalBinary(b []byte) error
- func (m *EventHandlerTriggerConfig) Validate(formats strfmt.Registry) error
- type ExtendedPathsSet
- type File
- type FileHeader
- type GlobalRateLimit
- type HReport
- type HardTimeoutMeta
- type HashType
- type HeaderInjectionMeta
- type HookType
- type HostCheckObject
- type IDExtractorSource
- type IDExtractorType
- type InternalMeta
- type JWTData
- type MIMEHeader
- type MW
- type MethodTransformMeta
- type MiddlewareDefinition
- type MiddlewareDriver
- type MiddlewareIDExtractor
- type MiddlewareSection
- type MiniRequestObject
- type Monitor
- type NotificationsManager
- type OIDProviderConfig
- type Oauth2Meta
- type Object
- type OpenIDOptions
- type Paths
- type Payload
- type Plugin
- type Proxy
- type RequestInputType
- type RequestSigningMeta
- type RequestSizeMeta
- type ResponseProcessor
- type ReturnOverrides
- type RoutingTrigger
- type RoutingTriggerOnType
- type RoutingTriggerOptions
- type ServiceDiscoveryConfiguration
- func (m *ServiceDiscoveryConfiguration) ContextValidate(ctx context.Context, formats strfmt.Registry) error
- func (m *ServiceDiscoveryConfiguration) MarshalBinary() ([]byte, error)
- func (m *ServiceDiscoveryConfiguration) UnmarshalBinary(b []byte) error
- func (m *ServiceDiscoveryConfiguration) Validate(formats strfmt.Registry) error
- type SessionProviderCode
- type SessionProviderMeta
- type SessionState
- type SignatureConfig
- type StorageEngineCode
- type StringRegexMap
- type TemplateData
- type TemplateMeta
- type TemplateMode
- type TrackEndpointMeta
- type TransformJQMeta
- type Transport
- type TykEventHandlerName
- type URLRewriteMeta
- type UptimeTests
- type ValidatePathMeta
- type VersionData
- type VersionDefinition
- type VersionInfo
- type VirtualMeta
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APIDefinition ¶
type APIDefinition struct { // API ID APIID string `json:"api_id,omitempty"` // active Active bool `json:"active,omitempty"` // allowed i ps AllowedIPs []string `json:"allowed_ips"` // auth configs AuthConfigs map[string]AuthConfig `json:"auth_configs,omitempty"` // blacklisted i ps BlacklistedIPs []string `json:"blacklisted_ips"` // c o r s CORS *APIDefinitionCORS `json:"CORS,omitempty"` // certificates Certificates []string `json:"certificates"` // client certificates ClientCertificates []string `json:"client_certificates"` // config data ConfigData interface{} `json:"config_data,omitempty"` // custom middleware bundle CustomMiddlewareBundle string `json:"custom_middleware_bundle,omitempty"` // disable quota DisableQuota bool `json:"disable_quota,omitempty"` // disable rate limit DisableRateLimit bool `json:"disable_rate_limit,omitempty"` // do not track DoNotTrack bool `json:"do_not_track,omitempty"` // domain Domain string `json:"domain,omitempty"` // dont set quotas on create DontSetQuotasOnCreate bool `json:"dont_set_quota_on_create,omitempty"` // enable batch request support EnableBatchRequestSupport bool `json:"enable_batch_request_support,omitempty"` // enable co process auth EnableCoProcessAuth bool `json:"enable_coprocess_auth,omitempty"` // enable context vars EnableContextVars bool `json:"enable_context_vars,omitempty"` // enable detailed recording EnableDetailedRecording bool `json:"enable_detailed_recording,omitempty"` // enable Ip blacklisting EnableIPBlacklisting bool `json:"enable_ip_blacklisting,omitempty"` // enable Ip white listing EnableIPWhiteListing bool `json:"enable_ip_whitelisting,omitempty"` // enable j w t EnableJWT bool `json:"enable_jwt,omitempty"` // enable proxy protocol EnableProxyProtocol bool `json:"enable_proxy_protocol,omitempty"` // enable signature checking EnableSignatureChecking bool `json:"enable_signature_checking,omitempty"` // expire analytics after ExpireAnalyticsAfter int64 `json:"expire_analytics_after,omitempty"` // hmac allowed algorithms HmacAllowedAlgorithms []string `json:"hmac_allowed_algorithms"` // hmac allowed clock skew HmacAllowedClockSkew float64 `json:"hmac_allowed_clock_skew,omitempty"` // Id ID string `json:"id,omitempty"` // internal Internal bool `json:"internal,omitempty"` // j w t client ID base field JWTClientIDBaseField string `json:"jwt_client_base_field,omitempty"` // j w t default policies JWTDefaultPolicies []string `json:"jwt_default_policies"` // j w t expires at validation skew JWTExpiresAtValidationSkew uint64 `json:"jwt_expires_at_validation_skew,omitempty"` // j w t identity base field JWTIdentityBaseField string `json:"jwt_identity_base_field,omitempty"` // j w t issued at validation skew JWTIssuedAtValidationSkew uint64 `json:"jwt_issued_at_validation_skew,omitempty"` // j w t not before validation skew JWTNotBeforeValidationSkew uint64 `json:"jwt_not_before_validation_skew,omitempty"` // j w t policy field name JWTPolicyFieldName string `json:"jwt_policy_field_name,omitempty"` // j w t scope claim name JWTScopeClaimName string `json:"jwt_scope_claim_name,omitempty"` // j w t scope to policy mapping JWTScopeToPolicyMapping map[string]string `json:"jwt_scope_to_policy_mapping,omitempty"` // j w t signing method JWTSigningMethod string `json:"jwt_signing_method,omitempty"` // j w t skip kid JWTSkipKid bool `json:"jwt_skip_kid,omitempty"` // j w t source JWTSource string `json:"jwt_source,omitempty"` // listen port ListenPort int64 `json:"listen_port,omitempty"` // name Name string `json:"name,omitempty"` // org ID OrgID string `json:"org_id,omitempty"` // pinned public keys PinnedPublicKeys map[string]string `json:"pinned_public_keys,omitempty"` // protocol Protocol string `json:"protocol,omitempty"` // response processors ResponseProcessors []*ResponseProcessor `json:"response_processors"` // session lifetime SessionLifetime int64 `json:"session_lifetime,omitempty"` // slug Slug string `json:"slug,omitempty"` // strip auth data StripAuthData bool `json:"strip_auth_data,omitempty"` // tag headers TagHeaders []string `json:"tag_headers"` // tags Tags []string `json:"tags"` // upstream certificates UpstreamCertificates map[string]string `json:"upstream_certificates,omitempty"` // use basic auth UseBasicAuth bool `json:"use_basic_auth,omitempty"` // use go plugin auth UseGoPluginAuth bool `json:"use_go_plugin_auth,omitempty"` // use keyless access UseKeylessAccess bool `json:"use_keyless,omitempty"` // use mutual TLS auth UseMutualTLSAuth bool `json:"use_mutual_tls_auth,omitempty"` // use oauth2 UseOauth2 bool `json:"use_oauth2,omitempty"` // use open ID UseOpenID bool `json:"use_openid,omitempty"` // use standard auth UseStandardAuth bool `json:"use_standard_auth,omitempty"` // auth Auth *AuthConfig `json:"auth,omitempty"` // auth provider AuthProvider *AuthProviderMeta `json:"auth_provider,omitempty"` // base identity provided by BaseIdentityProvidedBy AuthTypeEnum `json:"base_identity_provided_by,omitempty"` // basic auth BasicAuth *BasicAuth `json:"basic_auth,omitempty"` // cache options CacheOptions *CacheOptions `json:"cache_options,omitempty"` // custom middleware CustomMiddleware *MiddlewareSection `json:"custom_middleware,omitempty"` // definition Definition *VersionDefinition `json:"definition,omitempty"` // event handlers EventHandlers *EventHandlerMetaConfig `json:"event_handlers,omitempty"` // global rate limit GlobalRateLimit *GlobalRateLimit `json:"global_rate_limit,omitempty"` // notifications Notifications *NotificationsManager `json:"notifications,omitempty"` // oauth meta OauthMeta *Oauth2Meta `json:"oauth_meta,omitempty"` // openid options OpenidOptions *OpenIDOptions `json:"openid_options,omitempty"` // proxy Proxy *Proxy `json:"proxy,omitempty"` // request signing RequestSigning *RequestSigningMeta `json:"request_signing,omitempty"` // session provider SessionProvider *SessionProviderMeta `json:"session_provider,omitempty"` // uptime tests UptimeTests *UptimeTests `json:"uptime_tests,omitempty"` // version data VersionData *VersionData `json:"version_data,omitempty"` }
APIDefinition APIDefinition represents the configuration for a single proxied API and it's versions.
swagger:model APIDefinition
func (*APIDefinition) ContextValidate ¶
ContextValidate validate this API definition based on the context it is used
func (*APIDefinition) MarshalBinary ¶
func (m *APIDefinition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIDefinition) UnmarshalBinary ¶
func (m *APIDefinition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APIDefinitionCORS ¶
type APIDefinitionCORS struct { // allow credentials AllowCredentials bool `json:"allow_credentials,omitempty"` // allowed headers AllowedHeaders []string `json:"allowed_headers"` // allowed methods AllowedMethods []string `json:"allowed_methods"` // allowed origins AllowedOrigins []string `json:"allowed_origins"` // debug Debug bool `json:"debug,omitempty"` // enable Enable bool `json:"enable,omitempty"` // exposed headers ExposedHeaders []string `json:"exposed_headers"` // max age MaxAge int64 `json:"max_age,omitempty"` // options passthrough OptionsPassthrough bool `json:"options_passthrough,omitempty"` }
APIDefinitionCORS API definition c o r s
swagger:model APIDefinitionCORS
func (*APIDefinitionCORS) ContextValidate ¶
ContextValidate validates this API definition c o r s based on context it is used
func (*APIDefinitionCORS) MarshalBinary ¶
func (m *APIDefinitionCORS) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*APIDefinitionCORS) UnmarshalBinary ¶
func (m *APIDefinitionCORS) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type APILimit ¶
type APILimit struct { // per Per float64 `json:"per,omitempty"` // quota max QuotaMax int64 `json:"quota_max,omitempty"` // quota remaining QuotaRemaining int64 `json:"quota_remaining,omitempty"` // quota renewal rate QuotaRenewalRate int64 `json:"quota_renewal_rate,omitempty"` // quota renews QuotaRenews int64 `json:"quota_renews,omitempty"` // rate Rate float64 `json:"rate,omitempty"` // throttle interval ThrottleInterval float64 `json:"throttle_interval,omitempty"` // throttle retry limit ThrottleRetryLimit int64 `json:"throttle_retry_limit,omitempty"` }
APILimit APILimit stores quota and rate limit on ACL level (per API)
swagger:model APILimit
func (*APILimit) ContextValidate ¶
ContextValidate validates this API limit based on context it is used
func (*APILimit) MarshalBinary ¶
MarshalBinary interface implementation
func (*APILimit) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type AccessDefinition ¶
type AccessDefinition struct { // API ID APIID string `json:"api_id,omitempty"` // API name APIName string `json:"api_name,omitempty"` // allowance scope AllowanceScope string `json:"allowance_scope,omitempty"` // allowed u r ls AllowedURLs []*AccessSpec `json:"allowed_urls"` // versions Versions []string `json:"versions"` // limit Limit *APILimit `json:"limit,omitempty"` }
AccessDefinition AccessDefinition defines which versions of an API a key has access to
swagger:model AccessDefinition
func (*AccessDefinition) ContextValidate ¶
ContextValidate validate this access definition based on the context it is used
func (*AccessDefinition) MarshalBinary ¶
func (m *AccessDefinition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccessDefinition) UnmarshalBinary ¶
func (m *AccessDefinition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AccessRequestType ¶
type AccessRequestType string
AccessRequestType AccessRequestType is the type for OAuth param `grant_type`
swagger:model AccessRequestType
func (AccessRequestType) ContextValidate ¶
ContextValidate validates this access request type based on context it is used
type AccessSpec ¶
type AccessSpec struct { // methods Methods []string `json:"methods"` // URL URL string `json:"url,omitempty"` }
AccessSpec AccessSpecs define what URLS a user has access to an what methods are enabled
swagger:model AccessSpec
func (*AccessSpec) ContextValidate ¶
ContextValidate validates this access spec based on context it is used
func (*AccessSpec) MarshalBinary ¶
func (m *AccessSpec) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AccessSpec) UnmarshalBinary ¶
func (m *AccessSpec) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthConfig ¶
type AuthConfig struct { // auth header name AuthHeaderName string `json:"auth_header_name,omitempty"` // cookie name CookieName string `json:"cookie_name,omitempty"` // param name ParamName string `json:"param_name,omitempty"` // use certificate UseCertificate bool `json:"use_certificate,omitempty"` // use cookie UseCookie bool `json:"use_cookie,omitempty"` // use param UseParam bool `json:"use_param,omitempty"` // validate signature ValidateSignature bool `json:"validate_signature,omitempty"` // signature Signature *SignatureConfig `json:"signature,omitempty"` }
AuthConfig auth config
swagger:model AuthConfig
func (*AuthConfig) ContextValidate ¶
ContextValidate validate this auth config based on the context it is used
func (*AuthConfig) MarshalBinary ¶
func (m *AuthConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthConfig) UnmarshalBinary ¶
func (m *AuthConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthProviderCode ¶
type AuthProviderCode string
AuthProviderCode auth provider code
swagger:model AuthProviderCode
func (AuthProviderCode) ContextValidate ¶
ContextValidate validates this auth provider code based on context it is used
type AuthProviderMeta ¶
type AuthProviderMeta struct { // meta Meta interface{} `json:"meta,omitempty"` // name Name AuthProviderCode `json:"name,omitempty"` // storage engine StorageEngine StorageEngineCode `json:"storage_engine,omitempty"` }
AuthProviderMeta auth provider meta
swagger:model AuthProviderMeta
func (*AuthProviderMeta) ContextValidate ¶
ContextValidate validate this auth provider meta based on the context it is used
func (*AuthProviderMeta) MarshalBinary ¶
func (m *AuthProviderMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*AuthProviderMeta) UnmarshalBinary ¶
func (m *AuthProviderMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type AuthTypeEnum ¶
type AuthTypeEnum string
AuthTypeEnum auth type enum
swagger:model AuthTypeEnum
func (AuthTypeEnum) ContextValidate ¶
ContextValidate validates this auth type enum based on context it is used
type AuthorizeRequestType ¶
type AuthorizeRequestType string
AuthorizeRequestType AuthorizeRequestType is the type for OAuth param `response_type`
swagger:model AuthorizeRequestType
func (AuthorizeRequestType) ContextValidate ¶
ContextValidate validates this authorize request type based on context it is used
type BasicAuth ¶
type BasicAuth struct { // body password regexp BodyPasswordRegexp string `json:"body_password_regexp,omitempty"` // body user regexp BodyUserRegexp string `json:"body_user_regexp,omitempty"` // cache TTL CacheTTL int64 `json:"cache_ttl,omitempty"` // disable caching DisableCaching bool `json:"disable_caching,omitempty"` // extract from body ExtractFromBody bool `json:"extract_from_body,omitempty"` }
BasicAuth basic auth
swagger:model BasicAuth
func (*BasicAuth) ContextValidate ¶
ContextValidate validates this basic auth based on context it is used
func (*BasicAuth) MarshalBinary ¶
MarshalBinary interface implementation
func (*BasicAuth) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type BasicAuthData ¶
type BasicAuthData struct { // password Password string `json:"password,omitempty"` // hash type HashType HashType `json:"hash_type,omitempty"` }
BasicAuthData basic auth data
swagger:model BasicAuthData
func (*BasicAuthData) ContextValidate ¶
ContextValidate validate this basic auth data based on the context it is used
func (*BasicAuthData) MarshalBinary ¶
func (m *BasicAuthData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BasicAuthData) UnmarshalBinary ¶
func (m *BasicAuthData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type BundleManifest ¶
type BundleManifest struct { // checksum Checksum string `json:"checksum,omitempty"` // file list FileList []string `json:"file_list"` // signature Signature string `json:"signature,omitempty"` // custom middleware CustomMiddleware *MiddlewareSection `json:"custom_middleware,omitempty"` }
BundleManifest bundle manifest
swagger:model BundleManifest
func (*BundleManifest) ContextValidate ¶
ContextValidate validate this bundle manifest based on the context it is used
func (*BundleManifest) MarshalBinary ¶
func (m *BundleManifest) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*BundleManifest) UnmarshalBinary ¶
func (m *BundleManifest) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CacheMeta ¶
type CacheMeta struct { // cache key regex CacheKeyRegex string `json:"cache_key_regex,omitempty"` // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` }
CacheMeta cache meta
swagger:model CacheMeta
func (*CacheMeta) ContextValidate ¶
ContextValidate validates this cache meta based on context it is used
func (*CacheMeta) MarshalBinary ¶
MarshalBinary interface implementation
func (*CacheMeta) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type CacheOptions ¶
type CacheOptions struct { // cache all safe requests CacheAllSafeRequests bool `json:"cache_all_safe_requests,omitempty"` // cache control TTL header CacheControlTTLHeader string `json:"cache_control_ttl_header,omitempty"` // cache only response codes CacheOnlyResponseCodes []int64 `json:"cache_response_codes"` // cache timeout CacheTimeout int64 `json:"cache_timeout,omitempty"` // enable cache EnableCache bool `json:"enable_cache,omitempty"` // enable upstream cache control EnableUpstreamCacheControl bool `json:"enable_upstream_cache_control,omitempty"` }
CacheOptions cache options
swagger:model CacheOptions
func (*CacheOptions) ContextValidate ¶
ContextValidate validates this cache options based on context it is used
func (*CacheOptions) MarshalBinary ¶
func (m *CacheOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CacheOptions) UnmarshalBinary ¶
func (m *CacheOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CheckCommand ¶
type CheckCommand struct { // message Message string `json:"message,omitempty"` // name Name string `json:"name,omitempty"` }
CheckCommand check command
swagger:model CheckCommand
func (*CheckCommand) ContextValidate ¶
ContextValidate validates this check command based on context it is used
func (*CheckCommand) MarshalBinary ¶
func (m *CheckCommand) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CheckCommand) UnmarshalBinary ¶
func (m *CheckCommand) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CircuitBreakerMeta ¶
type CircuitBreakerMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // return to service after ReturnToServiceAfter int64 `json:"return_to_service_after,omitempty"` // samples Samples int64 `json:"samples,omitempty"` // threshold percent ThresholdPercent float64 `json:"threshold_percent,omitempty"` }
CircuitBreakerMeta circuit breaker meta
swagger:model CircuitBreakerMeta
func (*CircuitBreakerMeta) ContextValidate ¶
ContextValidate validates this circuit breaker meta based on context it is used
func (*CircuitBreakerMeta) MarshalBinary ¶
func (m *CircuitBreakerMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CircuitBreakerMeta) UnmarshalBinary ¶
func (m *CircuitBreakerMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Config ¶
type Config struct { // expire uptime analytics after ExpireUptimeAnalyticsAfter int64 `json:"expire_utime_after,omitempty"` // recheck wait RecheckWait int64 `json:"recheck_wait,omitempty"` // service discovery ServiceDiscovery *ServiceDiscoveryConfiguration `json:"service_discovery,omitempty"` }
Config config
swagger:model Config
func (*Config) ContextValidate ¶
ContextValidate validate this config based on the context it is used
func (*Config) MarshalBinary ¶
MarshalBinary interface implementation
func (*Config) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Duration ¶
type Duration int64
Duration A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.
swagger:model Duration
func (Duration) ContextValidate ¶
ContextValidate validates this duration based on context it is used
type EndPointMeta ¶
type EndPointMeta struct { // ignore case IgnoreCase bool `json:"ignore_case,omitempty"` // method actions MethodActions map[string]EndpointMethodMeta `json:"method_actions,omitempty"` // path Path string `json:"path,omitempty"` }
EndPointMeta end point meta
swagger:model EndPointMeta
func (*EndPointMeta) ContextValidate ¶
ContextValidate validate this end point meta based on the context it is used
func (*EndPointMeta) MarshalBinary ¶
func (m *EndPointMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndPointMeta) UnmarshalBinary ¶
func (m *EndPointMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EndpointMethodAction ¶
type EndpointMethodAction string
EndpointMethodAction endpoint method action
swagger:model EndpointMethodAction
func (EndpointMethodAction) ContextValidate ¶
ContextValidate validates this endpoint method action based on context it is used
type EndpointMethodMeta ¶
type EndpointMethodMeta struct { // code Code int64 `json:"code,omitempty"` // data Data string `json:"data,omitempty"` // headers Headers map[string]string `json:"headers,omitempty"` // action Action EndpointMethodAction `json:"action,omitempty"` }
EndpointMethodMeta endpoint method meta
swagger:model EndpointMethodMeta
func (*EndpointMethodMeta) ContextValidate ¶
ContextValidate validate this endpoint method meta based on the context it is used
func (*EndpointMethodMeta) MarshalBinary ¶
func (m *EndpointMethodMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EndpointMethodMeta) UnmarshalBinary ¶
func (m *EndpointMethodMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EventHandlerMetaConfig ¶
type EventHandlerMetaConfig struct { // events Events map[string][]EventHandlerTriggerConfig `json:"events,omitempty"` }
EventHandlerMetaConfig event handler meta config
swagger:model EventHandlerMetaConfig
func (*EventHandlerMetaConfig) ContextValidate ¶
func (m *EventHandlerMetaConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this event handler meta config based on the context it is used
func (*EventHandlerMetaConfig) MarshalBinary ¶
func (m *EventHandlerMetaConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EventHandlerMetaConfig) UnmarshalBinary ¶
func (m *EventHandlerMetaConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type EventHandlerTriggerConfig ¶
type EventHandlerTriggerConfig struct { // handler meta HandlerMeta interface{} `json:"handler_meta,omitempty"` // handler name HandlerName TykEventHandlerName `json:"handler_name,omitempty"` }
EventHandlerTriggerConfig event handler trigger config
swagger:model EventHandlerTriggerConfig
func (*EventHandlerTriggerConfig) ContextValidate ¶
func (m *EventHandlerTriggerConfig) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validate this event handler trigger config based on the context it is used
func (*EventHandlerTriggerConfig) MarshalBinary ¶
func (m *EventHandlerTriggerConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*EventHandlerTriggerConfig) UnmarshalBinary ¶
func (m *EventHandlerTriggerConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ExtendedPathsSet ¶
type ExtendedPathsSet struct { // advance cache config AdvanceCacheConfig []*CacheMeta `json:"advance_cache_config"` // black list BlackList []*EndPointMeta `json:"black_list"` // cached Cached []string `json:"cache"` // circuit breaker CircuitBreaker []*CircuitBreakerMeta `json:"circuit_breakers"` // do not track endpoints DoNotTrackEndpoints []*TrackEndpointMeta `json:"do_not_track_endpoints"` // hard timeouts HardTimeouts []*HardTimeoutMeta `json:"hard_timeouts"` // ignored Ignored []*EndPointMeta `json:"ignored"` // internal Internal []*InternalMeta `json:"internal"` // method transforms MethodTransforms []*MethodTransformMeta `json:"method_transforms"` // size limit SizeLimit []*RequestSizeMeta `json:"size_limits"` // track endpoints TrackEndpoints []*TrackEndpointMeta `json:"track_endpoints"` // transform Transform []*TemplateMeta `json:"transform"` // transform header TransformHeader []*HeaderInjectionMeta `json:"transform_headers"` // transform j q TransformJQ []*TransformJQMeta `json:"transform_jq"` // transform j q response TransformJQResponse []*TransformJQMeta `json:"transform_jq_response"` // transform response TransformResponse []*TemplateMeta `json:"transform_response"` // transform response header TransformResponseHeader []*HeaderInjectionMeta `json:"transform_response_headers"` // URL rewrite URLRewrite []*URLRewriteMeta `json:"url_rewrites"` // validate JSON ValidateJSON []*ValidatePathMeta `json:"validate_json"` // virtual Virtual []*VirtualMeta `json:"virtual"` // white list WhiteList []*EndPointMeta `json:"white_list"` }
ExtendedPathsSet extended paths set
swagger:model ExtendedPathsSet
func (*ExtendedPathsSet) ContextValidate ¶
ContextValidate validate this extended paths set based on the context it is used
func (*ExtendedPathsSet) MarshalBinary ¶
func (m *ExtendedPathsSet) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ExtendedPathsSet) UnmarshalBinary ¶
func (m *ExtendedPathsSet) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type File ¶
type File struct { // data Data *File `json:"Data,omitempty"` // header Header *FileHeader `json:"Header,omitempty"` }
File File represents an uploaded file.
swagger:model File
func (*File) ContextValidate ¶
ContextValidate validate this file based on the context it is used
func (*File) MarshalBinary ¶
MarshalBinary interface implementation
func (*File) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type FileHeader ¶
type FileHeader struct { // filename Filename string `json:"Filename,omitempty"` // header Header MIMEHeader `json:"Header,omitempty"` // size Size int64 `json:"Size,omitempty"` }
FileHeader A FileHeader describes a file part of a multipart request.
swagger:model FileHeader
func (*FileHeader) ContextValidate ¶
ContextValidate validate this file header based on the context it is used
func (*FileHeader) MarshalBinary ¶
func (m *FileHeader) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*FileHeader) UnmarshalBinary ¶
func (m *FileHeader) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type GlobalRateLimit ¶
type GlobalRateLimit struct { // per Per float64 `json:"per,omitempty"` // rate Rate float64 `json:"rate,omitempty"` }
GlobalRateLimit global rate limit
swagger:model GlobalRateLimit
func (*GlobalRateLimit) ContextValidate ¶
ContextValidate validates this global rate limit based on context it is used
func (*GlobalRateLimit) MarshalBinary ¶
func (m *GlobalRateLimit) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*GlobalRateLimit) UnmarshalBinary ¶
func (m *GlobalRateLimit) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HReport ¶
type HReport struct { // g RPC started GRPCStarted bool `json:"GRPCStarted,omitempty"` // HTTP started HTTPStarted bool `json:"HTTPStarted,omitempty"` }
HReport h report
swagger:model HReport
func (*HReport) ContextValidate ¶
ContextValidate validates this h report based on context it is used
func (*HReport) MarshalBinary ¶
MarshalBinary interface implementation
func (*HReport) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type HardTimeoutMeta ¶
type HardTimeoutMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // time out TimeOut int64 `json:"timeout,omitempty"` }
HardTimeoutMeta hard timeout meta
swagger:model HardTimeoutMeta
func (*HardTimeoutMeta) ContextValidate ¶
ContextValidate validates this hard timeout meta based on context it is used
func (*HardTimeoutMeta) MarshalBinary ¶
func (m *HardTimeoutMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HardTimeoutMeta) UnmarshalBinary ¶
func (m *HardTimeoutMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HashType ¶
type HashType string
HashType hash type
swagger:model HashType
func (HashType) ContextValidate ¶
ContextValidate validates this hash type based on context it is used
type HeaderInjectionMeta ¶
type HeaderInjectionMeta struct { // act on response ActOnResponse bool `json:"act_on,omitempty"` // add headers AddHeaders map[string]string `json:"add_headers,omitempty"` // delete headers DeleteHeaders []string `json:"delete_headers"` // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` }
HeaderInjectionMeta header injection meta
swagger:model HeaderInjectionMeta
func (*HeaderInjectionMeta) ContextValidate ¶
ContextValidate validates this header injection meta based on context it is used
func (*HeaderInjectionMeta) MarshalBinary ¶
func (m *HeaderInjectionMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HeaderInjectionMeta) UnmarshalBinary ¶
func (m *HeaderInjectionMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type HookType ¶
type HookType int32
HookType hook type
swagger:model HookType
func (HookType) ContextValidate ¶
ContextValidate validates this hook type based on context it is used
type HostCheckObject ¶
type HostCheckObject struct { // body Body string `json:"body,omitempty"` // check URL CheckURL string `json:"url,omitempty"` // commands Commands []*CheckCommand `json:"commands"` // enable proxy protocol EnableProxyProtocol bool `json:"enable_proxy_protocol,omitempty"` // headers Headers map[string]string `json:"headers,omitempty"` // method Method string `json:"method,omitempty"` // protocol Protocol string `json:"protocol,omitempty"` // timeout Timeout Duration `json:"timeout,omitempty"` }
HostCheckObject host check object
swagger:model HostCheckObject
func (*HostCheckObject) ContextValidate ¶
ContextValidate validate this host check object based on the context it is used
func (*HostCheckObject) MarshalBinary ¶
func (m *HostCheckObject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*HostCheckObject) UnmarshalBinary ¶
func (m *HostCheckObject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type IDExtractorSource ¶
type IDExtractorSource string
IDExtractorSource Id extractor source
swagger:model IdExtractorSource
func (IDExtractorSource) ContextValidate ¶
ContextValidate validates this Id extractor source based on context it is used
type IDExtractorType ¶
type IDExtractorType string
IDExtractorType Id extractor type
swagger:model IdExtractorType
func (IDExtractorType) ContextValidate ¶
ContextValidate validates this Id extractor type based on context it is used
type InternalMeta ¶
type InternalMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` }
InternalMeta internal meta
swagger:model InternalMeta
func (*InternalMeta) ContextValidate ¶
ContextValidate validates this internal meta based on context it is used
func (*InternalMeta) MarshalBinary ¶
func (m *InternalMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*InternalMeta) UnmarshalBinary ¶
func (m *InternalMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type JWTData ¶
type JWTData struct { // secret Secret string `json:"secret,omitempty"` }
JWTData j w t data
swagger:model JWTData
func (*JWTData) ContextValidate ¶
ContextValidate validates this j w t data based on context it is used
func (*JWTData) MarshalBinary ¶
MarshalBinary interface implementation
func (*JWTData) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MIMEHeader ¶
MIMEHeader A MIMEHeader represents a MIME-style header mapping keys to sets of values.
swagger:model MIMEHeader
func (MIMEHeader) ContextValidate ¶
ContextValidate validates this m i m e header based on context it is used
type MW ¶
type MW struct { // API ID APIID string `json:"APIID,omitempty"` // active Active bool `json:"Active,omitempty"` // added // Format: date-time Added strfmt.DateTime `json:"Added,omitempty"` // bundle ref BundleRef string `json:"BundleRef,omitempty"` // download only DownloadOnly bool `json:"DownloadOnly,omitempty"` // manifest Manifest *BundleManifest `json:"Manifest,omitempty"` // org ID OrgID string `json:"OrgID,omitempty"` // plugins Plugins []*Plugin `json:"Plugins"` // UID UID string `json:"UID,omitempty"` }
MW m w
swagger:model MW
func (*MW) ContextValidate ¶
ContextValidate validate this m w based on the context it is used
func (*MW) MarshalBinary ¶
MarshalBinary interface implementation
func (*MW) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MethodTransformMeta ¶
type MethodTransformMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // to method ToMethod string `json:"to_method,omitempty"` }
MethodTransformMeta method transform meta
swagger:model MethodTransformMeta
func (*MethodTransformMeta) ContextValidate ¶
ContextValidate validates this method transform meta based on context it is used
func (*MethodTransformMeta) MarshalBinary ¶
func (m *MethodTransformMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MethodTransformMeta) UnmarshalBinary ¶
func (m *MethodTransformMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MiddlewareDefinition ¶
type MiddlewareDefinition struct { // name Name string `json:"name,omitempty"` // path Path string `json:"path,omitempty"` // raw body only RawBodyOnly bool `json:"raw_body_only,omitempty"` // require session RequireSession bool `json:"require_session,omitempty"` }
MiddlewareDefinition middleware definition
swagger:model MiddlewareDefinition
func (*MiddlewareDefinition) ContextValidate ¶
ContextValidate validates this middleware definition based on context it is used
func (*MiddlewareDefinition) MarshalBinary ¶
func (m *MiddlewareDefinition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MiddlewareDefinition) UnmarshalBinary ¶
func (m *MiddlewareDefinition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MiddlewareDriver ¶
type MiddlewareDriver string
MiddlewareDriver middleware driver
swagger:model MiddlewareDriver
func (MiddlewareDriver) ContextValidate ¶
ContextValidate validates this middleware driver based on context it is used
type MiddlewareIDExtractor ¶
type MiddlewareIDExtractor struct { // extractor config ExtractorConfig interface{} `json:"extractor_config,omitempty"` // extract from ExtractFrom IDExtractorSource `json:"extract_from,omitempty"` // extract with ExtractWith IDExtractorType `json:"extract_with,omitempty"` }
MiddlewareIDExtractor middleware Id extractor
swagger:model MiddlewareIdExtractor
func (*MiddlewareIDExtractor) ContextValidate ¶
ContextValidate validate this middleware Id extractor based on the context it is used
func (*MiddlewareIDExtractor) MarshalBinary ¶
func (m *MiddlewareIDExtractor) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MiddlewareIDExtractor) UnmarshalBinary ¶
func (m *MiddlewareIDExtractor) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MiddlewareSection ¶
type MiddlewareSection struct { // post Post []*MiddlewareDefinition `json:"post"` // post key auth PostKeyAuth []*MiddlewareDefinition `json:"post_key_auth"` // pre Pre []*MiddlewareDefinition `json:"pre"` // response Response []*MiddlewareDefinition `json:"response"` // auth check AuthCheck *MiddlewareDefinition `json:"auth_check,omitempty"` // driver Driver MiddlewareDriver `json:"driver,omitempty"` // id extractor IDExtractor *MiddlewareIDExtractor `json:"id_extractor,omitempty"` }
MiddlewareSection middleware section
swagger:model MiddlewareSection
func (*MiddlewareSection) ContextValidate ¶
ContextValidate validate this middleware section based on the context it is used
func (*MiddlewareSection) MarshalBinary ¶
func (m *MiddlewareSection) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MiddlewareSection) UnmarshalBinary ¶
func (m *MiddlewareSection) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type MiniRequestObject ¶
type MiniRequestObject struct { // add params AddParams map[string]string `json:"add_params,omitempty"` // body Body string `json:"body,omitempty"` // delete headers DeleteHeaders []string `json:"delete_headers"` // delete params DeleteParams []string `json:"delete_params"` // extended params ExtendedParams map[string]string `json:"extended_params,omitempty"` // headers Headers map[string]string `json:"headers,omitempty"` // method Method string `json:"method,omitempty"` // params Params map[string]string `json:"params,omitempty"` // raw body RawBody []uint8 `json:"raw_body"` // request Uri RequestURI string `json:"request_uri,omitempty"` // scheme Scheme string `json:"scheme,omitempty"` // set headers SetHeaders map[string]string `json:"set_headers,omitempty"` // Url URL string `json:"url,omitempty"` // return overrides ReturnOverrides *ReturnOverrides `json:"return_overrides,omitempty"` }
MiniRequestObject mini request object
swagger:model MiniRequestObject
func (*MiniRequestObject) ContextValidate ¶
ContextValidate validate this mini request object based on the context it is used
func (*MiniRequestObject) MarshalBinary ¶
func (m *MiniRequestObject) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MiniRequestObject) UnmarshalBinary ¶
func (m *MiniRequestObject) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Monitor ¶
type Monitor struct { // trigger limits TriggerLimits []float64 `json:"trigger_limits"` }
Monitor monitor
swagger:model Monitor
func (*Monitor) ContextValidate ¶
ContextValidate validates this monitor based on context it is used
func (*Monitor) MarshalBinary ¶
MarshalBinary interface implementation
func (*Monitor) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type NotificationsManager ¶
type NotificationsManager struct { // o auth key change URL OAuthKeyChangeURL string `json:"oauth_on_keychange_url,omitempty"` SharedSecret string `json:"shared_secret,omitempty"` }
NotificationsManager NotificationsManager handles sending notifications to OAuth endpoints to notify the provider of key changes.
TODO: Make this more generic
swagger:model NotificationsManager
func (*NotificationsManager) ContextValidate ¶
ContextValidate validates this notifications manager based on context it is used
func (*NotificationsManager) MarshalBinary ¶
func (m *NotificationsManager) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*NotificationsManager) UnmarshalBinary ¶
func (m *NotificationsManager) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type OIDProviderConfig ¶
type OIDProviderConfig struct { // client i ds ClientIDs map[string]string `json:"client_ids,omitempty"` // issuer Issuer string `json:"issuer,omitempty"` }
OIDProviderConfig o ID provider config
swagger:model OIDProviderConfig
func (*OIDProviderConfig) ContextValidate ¶
ContextValidate validates this o ID provider config based on context it is used
func (*OIDProviderConfig) MarshalBinary ¶
func (m *OIDProviderConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OIDProviderConfig) UnmarshalBinary ¶
func (m *OIDProviderConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Oauth2Meta ¶
type Oauth2Meta struct { // allowed access types AllowedAccessTypes []AccessRequestType `json:"allowed_access_types"` // allowed authorize types AllowedAuthorizeTypes []AuthorizeRequestType `json:"allowed_authorize_types"` // authorize login redirect AuthorizeLoginRedirect string `json:"auth_login_redirect,omitempty"` }
Oauth2Meta oauth2 meta
swagger:model Oauth2Meta
func (*Oauth2Meta) ContextValidate ¶
ContextValidate validate this oauth2 meta based on the context it is used
func (*Oauth2Meta) MarshalBinary ¶
func (m *Oauth2Meta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Oauth2Meta) UnmarshalBinary ¶
func (m *Oauth2Meta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Object ¶
type Object struct { // hook name HookName string `json:"hook_name,omitempty"` // metadata Metadata map[string]string `json:"metadata,omitempty"` // spec Spec map[string]string `json:"spec,omitempty"` // hook type HookType HookType `json:"hook_type,omitempty"` // request Request *MiniRequestObject `json:"request,omitempty"` // session Session *SessionState `json:"session,omitempty"` }
Object object
swagger:model Object
func (*Object) ContextValidate ¶
ContextValidate validate this object based on the context it is used
func (*Object) MarshalBinary ¶
MarshalBinary interface implementation
func (*Object) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type OpenIDOptions ¶
type OpenIDOptions struct { // providers Providers []*OIDProviderConfig `json:"providers"` // segregate by client SegregateByClient bool `json:"segregate_by_client,omitempty"` }
OpenIDOptions open ID options
swagger:model OpenIDOptions
func (*OpenIDOptions) ContextValidate ¶
ContextValidate validate this open ID options based on the context it is used
func (*OpenIDOptions) MarshalBinary ¶
func (m *OpenIDOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*OpenIDOptions) UnmarshalBinary ¶
func (m *OpenIDOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Paths ¶
type Paths struct { // black list BlackList []string `json:"black_list"` // ignored Ignored []string `json:"ignored"` // white list WhiteList []string `json:"white_list"` }
Paths paths
swagger:model Paths
func (*Paths) ContextValidate ¶
ContextValidate validates this paths based on context it is used
func (*Paths) MarshalBinary ¶
MarshalBinary interface implementation
func (*Paths) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Payload ¶
type Payload struct { // error Error string `json:"Error,omitempty"` // payload Payload interface{} `json:"Payload,omitempty"` // status Status string `json:"Status,omitempty"` }
Payload Payload is the default response
swagger:model Payload
func (*Payload) ContextValidate ¶
ContextValidate validates this payload based on context it is used
func (*Payload) MarshalBinary ¶
MarshalBinary interface implementation
func (*Payload) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Plugin ¶
type Plugin struct { // file name FileName string `json:"FileName,omitempty"` // file ref FileRef string `json:"FileRef,omitempty"` // name Name string `json:"Name,omitempty"` // type Type HookType `json:"Type,omitempty"` // UID UID string `json:"UID,omitempty"` }
Plugin plugin
swagger:model Plugin
func (*Plugin) ContextValidate ¶
ContextValidate validate this plugin based on the context it is used
func (*Plugin) MarshalBinary ¶
MarshalBinary interface implementation
func (*Plugin) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Proxy ¶
type Proxy struct { // check host against uptime tests CheckHostAgainstUptimeTests bool `json:"check_host_against_uptime_tests,omitempty"` // disable strip slash DisableStripSlash bool `json:"disable_strip_slash,omitempty"` // enable load balancing EnableLoadBalancing bool `json:"enable_load_balancing,omitempty"` // listen path ListenPath string `json:"listen_path,omitempty"` // preserve host header PreserveHostHeader bool `json:"preserve_host_header,omitempty"` // strip listen path StripListenPath bool `json:"strip_listen_path,omitempty"` // target URL TargetURL string `json:"target_url,omitempty"` // targets Targets []string `json:"target_list"` // service discovery ServiceDiscovery *ServiceDiscoveryConfiguration `json:"service_discovery,omitempty"` // transport Transport *Transport `json:"transport,omitempty"` }
Proxy proxy
swagger:model Proxy
func (*Proxy) ContextValidate ¶
ContextValidate validate this proxy based on the context it is used
func (*Proxy) MarshalBinary ¶
MarshalBinary interface implementation
func (*Proxy) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RequestInputType ¶
type RequestInputType string
RequestInputType request input type
swagger:model RequestInputType
func (RequestInputType) ContextValidate ¶
ContextValidate validates this request input type based on context it is used
type RequestSigningMeta ¶
type RequestSigningMeta struct { // algorithm Algorithm string `json:"algorithm,omitempty"` // certificate Id CertificateID string `json:"certificate_id,omitempty"` // header list HeaderList []string `json:"header_list"` // is enabled IsEnabled bool `json:"is_enabled,omitempty"` // key Id KeyID string `json:"key_id,omitempty"` // secret Secret string `json:"secret,omitempty"` // signature header SignatureHeader string `json:"signature_header,omitempty"` }
RequestSigningMeta request signing meta
swagger:model RequestSigningMeta
func (*RequestSigningMeta) ContextValidate ¶
ContextValidate validates this request signing meta based on context it is used
func (*RequestSigningMeta) MarshalBinary ¶
func (m *RequestSigningMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestSigningMeta) UnmarshalBinary ¶
func (m *RequestSigningMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RequestSizeMeta ¶
type RequestSizeMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // size limit SizeLimit int64 `json:"size_limit,omitempty"` }
RequestSizeMeta request size meta
swagger:model RequestSizeMeta
func (*RequestSizeMeta) ContextValidate ¶
ContextValidate validates this request size meta based on context it is used
func (*RequestSizeMeta) MarshalBinary ¶
func (m *RequestSizeMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RequestSizeMeta) UnmarshalBinary ¶
func (m *RequestSizeMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ResponseProcessor ¶
type ResponseProcessor struct { // name Name string `json:"name,omitempty"` // options Options interface{} `json:"options,omitempty"` }
ResponseProcessor response processor
swagger:model ResponseProcessor
func (*ResponseProcessor) ContextValidate ¶
ContextValidate validates this response processor based on context it is used
func (*ResponseProcessor) MarshalBinary ¶
func (m *ResponseProcessor) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ResponseProcessor) UnmarshalBinary ¶
func (m *ResponseProcessor) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ReturnOverrides ¶
type ReturnOverrides struct { // headers Headers map[string]string `json:"headers,omitempty"` // response code ResponseCode int32 `json:"response_code,omitempty"` // response error ResponseError string `json:"response_error,omitempty"` }
ReturnOverrides return overrides
swagger:model ReturnOverrides
func (*ReturnOverrides) ContextValidate ¶
ContextValidate validates this return overrides based on context it is used
func (*ReturnOverrides) MarshalBinary ¶
func (m *ReturnOverrides) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ReturnOverrides) UnmarshalBinary ¶
func (m *ReturnOverrides) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RoutingTrigger ¶
type RoutingTrigger struct { // rewrite to RewriteTo string `json:"rewrite_to,omitempty"` // on On RoutingTriggerOnType `json:"on,omitempty"` // options Options *RoutingTriggerOptions `json:"options,omitempty"` }
RoutingTrigger routing trigger
swagger:model RoutingTrigger
func (*RoutingTrigger) ContextValidate ¶
ContextValidate validate this routing trigger based on the context it is used
func (*RoutingTrigger) MarshalBinary ¶
func (m *RoutingTrigger) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoutingTrigger) UnmarshalBinary ¶
func (m *RoutingTrigger) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type RoutingTriggerOnType ¶
type RoutingTriggerOnType string
RoutingTriggerOnType routing trigger on type
swagger:model RoutingTriggerOnType
func (RoutingTriggerOnType) ContextValidate ¶
ContextValidate validates this routing trigger on type based on context it is used
type RoutingTriggerOptions ¶
type RoutingTriggerOptions struct { // header matches HeaderMatches map[string]StringRegexMap `json:"header_matches,omitempty"` // path part matches PathPartMatches map[string]StringRegexMap `json:"path_part_matches,omitempty"` // query val matches QueryValMatches map[string]StringRegexMap `json:"query_val_matches,omitempty"` // request context matches RequestContextMatches map[string]StringRegexMap `json:"request_context_matches,omitempty"` // session meta matches SessionMetaMatches map[string]StringRegexMap `json:"session_meta_matches,omitempty"` // payload matches PayloadMatches *StringRegexMap `json:"payload_matches,omitempty"` }
RoutingTriggerOptions routing trigger options
swagger:model RoutingTriggerOptions
func (*RoutingTriggerOptions) ContextValidate ¶
ContextValidate validate this routing trigger options based on the context it is used
func (*RoutingTriggerOptions) MarshalBinary ¶
func (m *RoutingTriggerOptions) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RoutingTriggerOptions) UnmarshalBinary ¶
func (m *RoutingTriggerOptions) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ServiceDiscoveryConfiguration ¶
type ServiceDiscoveryConfiguration struct { // cache timeout CacheTimeout int64 `json:"cache_timeout,omitempty"` // data path DataPath string `json:"data_path,omitempty"` // endpoint returns list EndpointReturnsList bool `json:"endpoint_returns_list,omitempty"` // parent data path ParentDataPath string `json:"parent_data_path,omitempty"` // port data path PortDataPath string `json:"port_data_path,omitempty"` // query endpoint QueryEndpoint string `json:"query_endpoint,omitempty"` // target path TargetPath string `json:"target_path,omitempty"` // use discovery service UseDiscoveryService bool `json:"use_discovery_service,omitempty"` // use nested query UseNestedQuery bool `json:"use_nested_query,omitempty"` // use target list UseTargetList bool `json:"use_target_list,omitempty"` }
ServiceDiscoveryConfiguration service discovery configuration
swagger:model ServiceDiscoveryConfiguration
func (*ServiceDiscoveryConfiguration) ContextValidate ¶
func (m *ServiceDiscoveryConfiguration) ContextValidate(ctx context.Context, formats strfmt.Registry) error
ContextValidate validates this service discovery configuration based on context it is used
func (*ServiceDiscoveryConfiguration) MarshalBinary ¶
func (m *ServiceDiscoveryConfiguration) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ServiceDiscoveryConfiguration) UnmarshalBinary ¶
func (m *ServiceDiscoveryConfiguration) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SessionProviderCode ¶
type SessionProviderCode string
SessionProviderCode session provider code
swagger:model SessionProviderCode
func (SessionProviderCode) ContextValidate ¶
ContextValidate validates this session provider code based on context it is used
type SessionProviderMeta ¶
type SessionProviderMeta struct { // meta Meta interface{} `json:"meta,omitempty"` // name Name SessionProviderCode `json:"name,omitempty"` // storage engine StorageEngine StorageEngineCode `json:"storage_engine,omitempty"` }
SessionProviderMeta session provider meta
swagger:model SessionProviderMeta
func (*SessionProviderMeta) ContextValidate ¶
ContextValidate validate this session provider meta based on the context it is used
func (*SessionProviderMeta) MarshalBinary ¶
func (m *SessionProviderMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SessionProviderMeta) UnmarshalBinary ¶
func (m *SessionProviderMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SessionState ¶
type SessionState struct { // access rights AccessRights map[string]AccessDefinition `json:"access_rights,omitempty"` // alias Alias string `json:"alias,omitempty"` // allowance Allowance float64 `json:"allowance,omitempty"` // apply policies ApplyPolicies []string `json:"apply_policies"` // apply policy ID ApplyPolicyID string `json:"apply_policy_id,omitempty"` // certificate Certificate string `json:"certificate,omitempty"` // data expires DataExpires int64 `json:"data_expires,omitempty"` // date created // Format: date-time DateCreated strfmt.DateTime `json:"date_created,omitempty"` // enable detailed recording EnableDetailedRecording bool `json:"enable_detail_recording,omitempty"` // enable HTTP signature validation EnableHTTPSignatureValidation bool `json:"enable_http_signature_validation,omitempty"` // expires Expires int64 `json:"expires,omitempty"` // h m a c enabled HMACEnabled bool `json:"hmac_enabled,omitempty"` // hmac secret HmacSecret string `json:"hmac_string,omitempty"` // Id extractor deadline IDExtractorDeadline int64 `json:"id_extractor_deadline,omitempty"` // is inactive IsInactive bool `json:"is_inactive,omitempty"` // last check LastCheck int64 `json:"last_check,omitempty"` // last updated LastUpdated string `json:"last_updated,omitempty"` // meta data MetaData interface{} `json:"meta_data,omitempty"` // oauth client ID OauthClientID string `json:"oauth_client_id,omitempty"` // oauth keys OauthKeys map[string]string `json:"oauth_keys,omitempty"` // org ID OrgID string `json:"org_id,omitempty"` // per Per float64 `json:"per,omitempty"` // quota max QuotaMax int64 `json:"quota_max,omitempty"` // quota remaining QuotaRemaining int64 `json:"quota_remaining,omitempty"` // quota renewal rate QuotaRenewalRate int64 `json:"quota_renewal_rate,omitempty"` // quota renews QuotaRenews int64 `json:"quota_renews,omitempty"` // r s a certificate Id RSACertificateID string `json:"rsa_certificate_id,omitempty"` // rate Rate float64 `json:"rate,omitempty"` // session lifetime SessionLifetime int64 `json:"session_lifetime,omitempty"` // tags Tags []string `json:"tags"` // throttle interval ThrottleInterval float64 `json:"throttle_interval,omitempty"` // throttle retry limit ThrottleRetryLimit int64 `json:"throttle_retry_limit,omitempty"` // basic auth data BasicAuthData *BasicAuthData `json:"basic_auth_data,omitempty"` // jwt data JwtData *JWTData `json:"jwt_data,omitempty"` // monitor Monitor *Monitor `json:"monitor,omitempty"` }
SessionState SessionState objects represent a current API session, mainly used for rate limiting.
There's a data structure that's based on this and it's used for Protocol Buffer support, make sure to update "coprocess/proto/coprocess_session_state.proto" and generate the bindings using: cd coprocess/proto && ./update_bindings.sh
swagger:model SessionState
func (*SessionState) ContextValidate ¶
ContextValidate validate this session state based on the context it is used
func (*SessionState) MarshalBinary ¶
func (m *SessionState) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SessionState) UnmarshalBinary ¶
func (m *SessionState) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SignatureConfig ¶
type SignatureConfig struct { // algorithm Algorithm string `json:"algorithm,omitempty"` // allowed clock skew AllowedClockSkew int64 `json:"allowed_clock_skew,omitempty"` // error code ErrorCode int64 `json:"error_code,omitempty"` // error message ErrorMessage string `json:"error_message,omitempty"` // header Header string `json:"header,omitempty"` // secret Secret string `json:"secret,omitempty"` }
SignatureConfig signature config
swagger:model SignatureConfig
func (*SignatureConfig) ContextValidate ¶
ContextValidate validates this signature config based on context it is used
func (*SignatureConfig) MarshalBinary ¶
func (m *SignatureConfig) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SignatureConfig) UnmarshalBinary ¶
func (m *SignatureConfig) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StorageEngineCode ¶
type StorageEngineCode string
StorageEngineCode storage engine code
swagger:model StorageEngineCode
func (StorageEngineCode) ContextValidate ¶
ContextValidate validates this storage engine code based on context it is used
type StringRegexMap ¶
type StringRegexMap struct { // match pattern MatchPattern string `json:"match_rx,omitempty"` // reverse Reverse bool `json:"reverse,omitempty"` }
StringRegexMap string regex map
swagger:model StringRegexMap
func (*StringRegexMap) ContextValidate ¶
ContextValidate validates this string regex map based on context it is used
func (*StringRegexMap) MarshalBinary ¶
func (m *StringRegexMap) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StringRegexMap) UnmarshalBinary ¶
func (m *StringRegexMap) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TemplateData ¶
type TemplateData struct { // enable session EnableSession bool `json:"enable_session,omitempty"` // template source TemplateSource string `json:"template_source,omitempty"` // input type InputType RequestInputType `json:"input_type,omitempty"` // template mode TemplateMode TemplateMode `json:"template_mode,omitempty"` }
TemplateData template data
swagger:model TemplateData
func (*TemplateData) ContextValidate ¶
ContextValidate validate this template data based on the context it is used
func (*TemplateData) MarshalBinary ¶
func (m *TemplateData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TemplateData) UnmarshalBinary ¶
func (m *TemplateData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TemplateMeta ¶
type TemplateMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // template data TemplateData *TemplateData `json:"template_data,omitempty"` }
TemplateMeta template meta
swagger:model TemplateMeta
func (*TemplateMeta) ContextValidate ¶
ContextValidate validate this template meta based on the context it is used
func (*TemplateMeta) MarshalBinary ¶
func (m *TemplateMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TemplateMeta) UnmarshalBinary ¶
func (m *TemplateMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TemplateMode ¶
type TemplateMode string
TemplateMode template mode
swagger:model TemplateMode
func (TemplateMode) ContextValidate ¶
ContextValidate validates this template mode based on context it is used
type TrackEndpointMeta ¶
type TrackEndpointMeta struct { // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` }
TrackEndpointMeta track endpoint meta
swagger:model TrackEndpointMeta
func (*TrackEndpointMeta) ContextValidate ¶
ContextValidate validates this track endpoint meta based on context it is used
func (*TrackEndpointMeta) MarshalBinary ¶
func (m *TrackEndpointMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TrackEndpointMeta) UnmarshalBinary ¶
func (m *TrackEndpointMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TransformJQMeta ¶
type TransformJQMeta struct { // filter Filter string `json:"filter,omitempty"` // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` }
TransformJQMeta transform j q meta
swagger:model TransformJQMeta
func (*TransformJQMeta) ContextValidate ¶
ContextValidate validates this transform j q meta based on context it is used
func (*TransformJQMeta) MarshalBinary ¶
func (m *TransformJQMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*TransformJQMeta) UnmarshalBinary ¶
func (m *TransformJQMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Transport ¶
type Transport struct { // proxy URL ProxyURL string `json:"proxy_url,omitempty"` // s s l cipher suites SSLCipherSuites []string `json:"ssl_ciphers"` // s s l force common name check SSLForceCommonNameCheck bool `json:"ssl_force_common_name_check,omitempty"` // s s l insecure skip verify SSLInsecureSkipVerify bool `json:"ssl_insecure_skip_verify,omitempty"` // s s l min version SSLMinVersion uint16 `json:"ssl_min_version,omitempty"` }
Transport transport
swagger:model Transport
func (*Transport) ContextValidate ¶
ContextValidate validates this transport based on context it is used
func (*Transport) MarshalBinary ¶
MarshalBinary interface implementation
func (*Transport) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type TykEventHandlerName ¶
type TykEventHandlerName string
TykEventHandlerName tyk event handler name
swagger:model TykEventHandlerName
func (TykEventHandlerName) ContextValidate ¶
ContextValidate validates this tyk event handler name based on context it is used
type URLRewriteMeta ¶
type URLRewriteMeta struct { // match pattern MatchPattern string `json:"match_pattern,omitempty"` // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // rewrite to RewriteTo string `json:"rewrite_to,omitempty"` // triggers Triggers []*RoutingTrigger `json:"triggers"` }
URLRewriteMeta URL rewrite meta
swagger:model URLRewriteMeta
func (*URLRewriteMeta) ContextValidate ¶
ContextValidate validate this URL rewrite meta based on the context it is used
func (*URLRewriteMeta) MarshalBinary ¶
func (m *URLRewriteMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*URLRewriteMeta) UnmarshalBinary ¶
func (m *URLRewriteMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type UptimeTests ¶
type UptimeTests struct { // check list CheckList []*HostCheckObject `json:"check_list"` // config Config *Config `json:"config,omitempty"` }
UptimeTests uptime tests
swagger:model UptimeTests
func (*UptimeTests) ContextValidate ¶
ContextValidate validate this uptime tests based on the context it is used
func (*UptimeTests) MarshalBinary ¶
func (m *UptimeTests) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*UptimeTests) UnmarshalBinary ¶
func (m *UptimeTests) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type ValidatePathMeta ¶
type ValidatePathMeta struct { // Allows override of default 422 Unprocessible Entity response code for validation errors. ErrorResponseCode int64 `json:"error_response_code,omitempty"` // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // schema Schema interface{} `json:"schema,omitempty"` // schema b64 SchemaB64 string `json:"schema_b64,omitempty"` }
ValidatePathMeta validate path meta
swagger:model ValidatePathMeta
func (*ValidatePathMeta) ContextValidate ¶
ContextValidate validates this validate path meta based on context it is used
func (*ValidatePathMeta) MarshalBinary ¶
func (m *ValidatePathMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ValidatePathMeta) UnmarshalBinary ¶
func (m *ValidatePathMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VersionData ¶
type VersionData struct { // default version DefaultVersion string `json:"default_version,omitempty"` // not versioned NotVersioned bool `json:"not_versioned,omitempty"` // versions Versions map[string]VersionInfo `json:"versions,omitempty"` }
VersionData version data
swagger:model VersionData
func (*VersionData) ContextValidate ¶
ContextValidate validate this version data based on the context it is used
func (*VersionData) MarshalBinary ¶
func (m *VersionData) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VersionData) UnmarshalBinary ¶
func (m *VersionData) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VersionDefinition ¶
type VersionDefinition struct { // key Key string `json:"key,omitempty"` // location Location string `json:"location,omitempty"` // strip path StripPath bool `json:"strip_path,omitempty"` }
VersionDefinition version definition
swagger:model VersionDefinition
func (*VersionDefinition) ContextValidate ¶
ContextValidate validates this version definition based on context it is used
func (*VersionDefinition) MarshalBinary ¶
func (m *VersionDefinition) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VersionDefinition) UnmarshalBinary ¶
func (m *VersionDefinition) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VersionInfo ¶
type VersionInfo struct { // expires Expires string `json:"expires,omitempty"` // global headers GlobalHeaders map[string]string `json:"global_headers,omitempty"` // global headers remove GlobalHeadersRemove []string `json:"global_headers_remove"` // global size limit GlobalSizeLimit int64 `json:"global_size_limit,omitempty"` // name Name string `json:"name,omitempty"` // override target OverrideTarget string `json:"override_target,omitempty"` // use extended paths UseExtendedPaths bool `json:"use_extended_paths,omitempty"` // extended paths ExtendedPaths *ExtendedPathsSet `json:"extended_paths,omitempty"` // paths Paths *Paths `json:"paths,omitempty"` }
VersionInfo version info
swagger:model VersionInfo
func (*VersionInfo) ContextValidate ¶
ContextValidate validate this version info based on the context it is used
func (*VersionInfo) MarshalBinary ¶
func (m *VersionInfo) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VersionInfo) UnmarshalBinary ¶
func (m *VersionInfo) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type VirtualMeta ¶
type VirtualMeta struct { // function source type FunctionSourceType string `json:"function_source_type,omitempty"` // function source URI FunctionSourceURI string `json:"function_source_uri,omitempty"` // method Method string `json:"method,omitempty"` // path Path string `json:"path,omitempty"` // proxy on error ProxyOnError bool `json:"proxy_on_error,omitempty"` // response function name ResponseFunctionName string `json:"response_function_name,omitempty"` // use session UseSession bool `json:"use_session,omitempty"` }
VirtualMeta virtual meta
swagger:model VirtualMeta
func (*VirtualMeta) ContextValidate ¶
ContextValidate validates this virtual meta based on context it is used
func (*VirtualMeta) MarshalBinary ¶
func (m *VirtualMeta) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*VirtualMeta) UnmarshalBinary ¶
func (m *VirtualMeta) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
Source Files ¶
- access_definition.go
- access_request_type.go
- access_spec.go
- api_definition.go
- api_limit.go
- auth_config.go
- auth_provider_code.go
- auth_provider_meta.go
- auth_type_enum.go
- authorize_request_type.go
- bundle_manifest.go
- cache_meta.go
- cache_options.go
- check_command.go
- circuit_breaker_meta.go
- duration.go
- end_point_meta.go
- endpoint_method_action.go
- endpoint_method_meta.go
- event_handler_meta_config.go
- event_handler_trigger_config.go
- extended_paths_set.go
- file.go
- file_header.go
- global_rate_limit.go
- h_report.go
- hard_timeout_meta.go
- hash_type.go
- header_injection_meta.go
- hook_type.go
- host_check_object.go
- id_extractor_source.go
- id_extractor_type.go
- internal_meta.go
- m_i_m_e_header.go
- m_w.go
- method_transform_meta.go
- middleware_definition.go
- middleware_driver.go
- middleware_id_extractor.go
- middleware_section.go
- mini_request_object.go
- notifications_manager.go
- o_id_provider_config.go
- object.go
- open_id_options.go
- payload.go
- plugin.go
- request_input_type.go
- request_signing_meta.go
- request_size_meta.go
- response_processor.go
- return_overrides.go
- routing_trigger.go
- routing_trigger_on_type.go
- routing_trigger_options.go
- service_discovery_configuration.go
- session_provider_code.go
- session_provider_meta.go
- session_state.go
- signature_config.go
- storage_engine_code.go
- string_regex_map.go
- template_data.go
- template_meta.go
- template_mode.go
- track_endpoint_meta.go
- transform_j_q_meta.go
- tyk_event_handler_name.go
- url_rewrite_meta.go
- validate_path_meta.go
- version_info.go
- virtual_meta.go