konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.getGatewayPluginOasValidation

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Using getGatewayPluginOasValidation

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getGatewayPluginOasValidation(args: GetGatewayPluginOasValidationArgs, opts?: InvokeOptions): Promise<GetGatewayPluginOasValidationResult>
function getGatewayPluginOasValidationOutput(args: GetGatewayPluginOasValidationOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginOasValidationResult>

def get_gateway_plugin_oas_validation(control_plane_id: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetGatewayPluginOasValidationResult
def get_gateway_plugin_oas_validation_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginOasValidationResult]

func LookupGatewayPluginOasValidation(ctx *Context, args *LookupGatewayPluginOasValidationArgs, opts ...InvokeOption) (*LookupGatewayPluginOasValidationResult, error)
func LookupGatewayPluginOasValidationOutput(ctx *Context, args *LookupGatewayPluginOasValidationOutputArgs, opts ...InvokeOption) LookupGatewayPluginOasValidationResultOutput

> Note: This function is named LookupGatewayPluginOasValidation in the Go SDK.

public static class GetGatewayPluginOasValidation 
{
    public static Task<GetGatewayPluginOasValidationResult> InvokeAsync(GetGatewayPluginOasValidationArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginOasValidationResult> Invoke(GetGatewayPluginOasValidationInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayPluginOasValidationResult> getGatewayPluginOasValidation(GetGatewayPluginOasValidationArgs args, InvokeOptions options)
public static Output<GetGatewayPluginOasValidationResult> getGatewayPluginOasValidation(GetGatewayPluginOasValidationArgs args, InvokeOptions options)

fn::invoke:
  function: konnect:index/getGatewayPluginOasValidation:getGatewayPluginOasValidation
  arguments:
    # arguments dictionary

The following arguments are supported:

ControlPlaneId string

ControlPlaneId string

controlPlaneId String

controlPlaneId string

control_plane_id str

controlPlaneId String

getGatewayPluginOasValidation Result

The following output properties are available:

Config GetGatewayPluginOasValidationConfig
Consumer GetGatewayPluginOasValidationConsumer
ControlPlaneId string
CreatedAt double
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginOasValidationOrdering
Protocols List<string>
Route GetGatewayPluginOasValidationRoute
Service GetGatewayPluginOasValidationService
Tags List<string>
UpdatedAt double

Config GetGatewayPluginOasValidationConfig
Consumer GetGatewayPluginOasValidationConsumer
ControlPlaneId string
CreatedAt float64
Enabled bool
Id string
InstanceName string
Ordering GetGatewayPluginOasValidationOrdering
Protocols []string
Route GetGatewayPluginOasValidationRoute
Service GetGatewayPluginOasValidationService
Tags []string
UpdatedAt float64

config GetGatewayPluginOasValidationConfig
consumer GetGatewayPluginOasValidationConsumer
controlPlaneId String
createdAt Double
enabled Boolean
id String
instanceName String
ordering GetGatewayPluginOasValidationOrdering
protocols List<String>
route GetGatewayPluginOasValidationRoute
service GetGatewayPluginOasValidationService
tags List<String>
updatedAt Double

config GetGatewayPluginOasValidationConfig
consumer GetGatewayPluginOasValidationConsumer
controlPlaneId string
createdAt number
enabled boolean
id string
instanceName string
ordering GetGatewayPluginOasValidationOrdering
protocols string[]
route GetGatewayPluginOasValidationRoute
service GetGatewayPluginOasValidationService
tags string[]
updatedAt number

config GetGatewayPluginOasValidationConfig
consumer GetGatewayPluginOasValidationConsumer
control_plane_id str
created_at float
enabled bool
id str
instance_name str
ordering GetGatewayPluginOasValidationOrdering
protocols Sequence[str]
route GetGatewayPluginOasValidationRoute
service GetGatewayPluginOasValidationService
tags Sequence[str]
updated_at float

config Property Map
consumer Property Map
controlPlaneId String
createdAt Number
enabled Boolean
id String
instanceName String
ordering Property Map
protocols List<String>
route Property Map
service Property Map
tags List<String>
updatedAt Number

Supporting Types

GetGatewayPluginOasValidationConfig

AllowedHeaderParameters string: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
ApiSpec string: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
ApiSpecEncoded bool: Indicates whether the api_spec is URI-Encoded.
CustomBasePath string: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
HeaderParameterCheck bool: If set to true, checks if HTTP header parameters in the request exist in the API specification.
IncludeBasePath bool: Indicates whether to include the base path when performing path match evaluation.
NotifyOnlyRequestValidationFailure bool: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
NotifyOnlyResponseBodyValidationFailure bool: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
QueryParameterCheck bool: If set to true, checks if query parameters in the request exist in the API specification.
ValidateRequestBody bool: If set to true, validates the request body content against the API specification.
ValidateRequestHeaderParams bool: If set to true, validates HTTP header parameters against the API specification.
ValidateRequestQueryParams bool: If set to true, validates query parameters against the API specification.
ValidateRequestUriParams bool: If set to true, validates URI parameters in the request against the API specification.
ValidateResponseBody bool: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
VerboseResponse bool: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

AllowedHeaderParameters string: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
ApiSpec string: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
ApiSpecEncoded bool: Indicates whether the api_spec is URI-Encoded.
CustomBasePath string: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
HeaderParameterCheck bool: If set to true, checks if HTTP header parameters in the request exist in the API specification.
IncludeBasePath bool: Indicates whether to include the base path when performing path match evaluation.
NotifyOnlyRequestValidationFailure bool: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
NotifyOnlyResponseBodyValidationFailure bool: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
QueryParameterCheck bool: If set to true, checks if query parameters in the request exist in the API specification.
ValidateRequestBody bool: If set to true, validates the request body content against the API specification.
ValidateRequestHeaderParams bool: If set to true, validates HTTP header parameters against the API specification.
ValidateRequestQueryParams bool: If set to true, validates query parameters against the API specification.
ValidateRequestUriParams bool: If set to true, validates URI parameters in the request against the API specification.
ValidateResponseBody bool: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
VerboseResponse bool: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowedHeaderParameters String: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
apiSpec String: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
apiSpecEncoded Boolean: Indicates whether the api_spec is URI-Encoded.
customBasePath String: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck Boolean: If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath Boolean: Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck Boolean: If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody Boolean: If set to true, validates the request body content against the API specification.
validateRequestHeaderParams Boolean: If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams Boolean: If set to true, validates query parameters against the API specification.
validateRequestUriParams Boolean: If set to true, validates URI parameters in the request against the API specification.
validateResponseBody Boolean: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verboseResponse Boolean: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowedHeaderParameters string: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
apiSpec string: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
apiSpecEncoded boolean: Indicates whether the api_spec is URI-Encoded.
customBasePath string: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck boolean: If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath boolean: Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure boolean: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure boolean: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck boolean: If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody boolean: If set to true, validates the request body content against the API specification.
validateRequestHeaderParams boolean: If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams boolean: If set to true, validates query parameters against the API specification.
validateRequestUriParams boolean: If set to true, validates URI parameters in the request against the API specification.
validateResponseBody boolean: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verboseResponse boolean: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowed_header_parameters str: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
api_spec str: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
api_spec_encoded bool: Indicates whether the api_spec is URI-Encoded.
custom_base_path str: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
header_parameter_check bool: If set to true, checks if HTTP header parameters in the request exist in the API specification.
include_base_path bool: Indicates whether to include the base path when performing path match evaluation.
notify_only_request_validation_failure bool: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notify_only_response_body_validation_failure bool: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
query_parameter_check bool: If set to true, checks if query parameters in the request exist in the API specification.
validate_request_body bool: If set to true, validates the request body content against the API specification.
validate_request_header_params bool: If set to true, validates HTTP header parameters against the API specification.
validate_request_query_params bool: If set to true, validates query parameters against the API specification.
validate_request_uri_params bool: If set to true, validates URI parameters in the request against the API specification.
validate_response_body bool: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verbose_response bool: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

allowedHeaderParameters String: List of header parameters in the request that will be ignored when performing HTTP header validation. These are additional headers added to an API request beyond those defined in the API specification. For example, you might include the HTTP header User-Agent, which lets servers and network peers identify the application, operating system, vendor, and/or version of the requesting user agent.
apiSpec String: The API specification defined using either Swagger or the OpenAPI. This can be either a JSON or YAML based file. If using a YAML file, the spec needs to be URI-Encoded to preserve the YAML format.
apiSpecEncoded Boolean: Indicates whether the api_spec is URI-Encoded.
customBasePath String: The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck Boolean: If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath Boolean: Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure Boolean: If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck Boolean: If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody Boolean: If set to true, validates the request body content against the API specification.
validateRequestHeaderParams Boolean: If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams Boolean: If set to true, validates query parameters against the API specification.
validateRequestUriParams Boolean: If set to true, validates URI parameters in the request against the API specification.
validateResponseBody Boolean: If set to true, validates the response from the upstream services against the API specification. If validation fails, it results in an HTTP 406 Not Acceptable status code.
verboseResponse Boolean: If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

GetGatewayPluginOasValidationConsumer

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginOasValidationOrdering

After GetGatewayPluginOasValidationOrderingAfter
Before GetGatewayPluginOasValidationOrderingBefore

After GetGatewayPluginOasValidationOrderingAfter
Before GetGatewayPluginOasValidationOrderingBefore

after GetGatewayPluginOasValidationOrderingAfter
before GetGatewayPluginOasValidationOrderingBefore

after GetGatewayPluginOasValidationOrderingAfter
before GetGatewayPluginOasValidationOrderingBefore

after GetGatewayPluginOasValidationOrderingAfter
before GetGatewayPluginOasValidationOrderingBefore

after Property Map
before Property Map

GetGatewayPluginOasValidationOrderingAfter

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginOasValidationOrderingBefore

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GetGatewayPluginOasValidationRoute

Id string

Id string

id String

id string

id str

id String

GetGatewayPluginOasValidationService

Id string

Id string

id String

id string

id str

id String

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.getGatewayPluginOasValidation

On this page

On this page

Using getGatewayPluginOasValidation

getGatewayPluginOasValidation Result

Supporting Types

GetGatewayPluginOasValidationConfig

GetGatewayPluginOasValidationConsumer

GetGatewayPluginOasValidationOrdering

GetGatewayPluginOasValidationOrderingAfter

GetGatewayPluginOasValidationOrderingBefore

GetGatewayPluginOasValidationRoute

GetGatewayPluginOasValidationService

Package Details

On this page

On this page