Interceptor Service

Package v1alpha1 contains the API Schema definitions for WSO2 APK.

Interceptor Service

InterceptorService is the Schema for the interceptorservices API

Field	Description
metadata Kubernetes meta/v1.ObjectMeta	Refer to the Kubernetes API documentation for the fields of the metadata field.
spec InterceptorServiceSpec	backendRef BackendReference includes []InterceptorInclusion (Optional) Includes defines the types of data which should be included when calling the interceptor service
status InterceptorServiceStatus

BackendReference

(Appears on: InterceptorServiceSpec)

BackendReference refers to a Backend resource as the interceptor service.

Field	Description
name string	Name is the name of the Backend resource.

InterceptorInclusion (string alias)

(Appears on: InterceptorServiceSpec)

InterceptorInclusion defines the type of data which can be included in the interceptor request/response path

Value	Description
"invocation_context"	InterceptorInclusionInvocationContext is the type to include invocation context
"request_body"	InterceptorInclusionRequestBody is the type to include request body
"request_headers"	InterceptorInclusionRequestHeaders is the type to include request headers
"request_trailers"	InterceptorInclusionRequestTrailers is the type to include request trailers
"response_body"	InterceptorInclusionResponseBody is the type to include response body
"response_headers"	InterceptorInclusionResponseHeaders is the type to include response headers
"response_trailers"	InterceptorInclusionResponseTrailers is the type to include response trailers

InterceptorServiceSpec

(Appears on: InterceptorService)

InterceptorServiceSpec defines the desired state of InterceptorService

Field	Description
backendRef BackendReference
includes []InterceptorInclusion	(Optional) Includes defines the types of data which should be included when calling the interceptor service

InterceptorServiceStatus

(Appears on: InterceptorService)

InterceptorServiceStatus defines the observed state of InterceptorService

---

Generated with gen-crd-api-reference-docs.

Interceptor Service Sample

Interceptor Service

The following is a sample Interceptor Service CR.

apiVersion: dp.wso2.com/v1alpha1
kind: InterceptorService
metadata:
  name: request-interceptor-service
spec:
  backendRef:
    name: interceptor-backend
  includes:
    - request_headers
    - request_body
    - invocation_context

Configuration Definition

Configuration	Description	Sample Values
backendRef	Determines the references of Backend resources for interceptor. This includes the resource name.
includes	Determines the types of data which can be included in the interceptor request/response path.	request_headers, request_body, request_trailer, response_headers, response_body, response_trailer, invocation_context