Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginOasValidation
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginOasValidation

Explore with Pulumi AI

konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect

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>
Copy
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]
Copy
func LookupGatewayPluginOasValidation(ctx *Context, args *LookupGatewayPluginOasValidationArgs, opts ...InvokeOption) (*LookupGatewayPluginOasValidationResult, error)
func LookupGatewayPluginOasValidationOutput(ctx *Context, args *LookupGatewayPluginOasValidationOutputArgs, opts ...InvokeOption) LookupGatewayPluginOasValidationResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetGatewayPluginOasValidationResult> getGatewayPluginOasValidation(GetGatewayPluginOasValidationArgs args, InvokeOptions options)
public static Output<GetGatewayPluginOasValidationResult> getGatewayPluginOasValidation(GetGatewayPluginOasValidationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: konnect:index/getGatewayPluginOasValidation:getGatewayPluginOasValidation
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ControlPlaneId This property is required. string
ControlPlaneId This property is required. string
controlPlaneId This property is required. String
controlPlaneId This property is required. string
control_plane_id This property is required. str
controlPlaneId This property is required. String

getGatewayPluginOasValidation Result

The following output properties are available:

Supporting Types

GetGatewayPluginOasValidationConfig

AllowedHeaderParameters This property is required. 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 This property is required. 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 This property is required. bool
Indicates whether the api_spec is URI-Encoded.
CustomBasePath This property is required. string
The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
HeaderParameterCheck This property is required. bool
If set to true, checks if HTTP header parameters in the request exist in the API specification.
IncludeBasePath This property is required. bool
Indicates whether to include the base path when performing path match evaluation.
NotifyOnlyRequestValidationFailure This property is required. bool
If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
NotifyOnlyResponseBodyValidationFailure This property is required. bool
If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
QueryParameterCheck This property is required. bool
If set to true, checks if query parameters in the request exist in the API specification.
ValidateRequestBody This property is required. bool
If set to true, validates the request body content against the API specification.
ValidateRequestHeaderParams This property is required. bool
If set to true, validates HTTP header parameters against the API specification.
ValidateRequestQueryParams This property is required. bool
If set to true, validates query parameters against the API specification.
ValidateRequestUriParams This property is required. bool
If set to true, validates URI parameters in the request against the API specification.
ValidateResponseBody This property is required. 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 This property is required. bool
If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.
AllowedHeaderParameters This property is required. 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 This property is required. 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 This property is required. bool
Indicates whether the api_spec is URI-Encoded.
CustomBasePath This property is required. string
The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
HeaderParameterCheck This property is required. bool
If set to true, checks if HTTP header parameters in the request exist in the API specification.
IncludeBasePath This property is required. bool
Indicates whether to include the base path when performing path match evaluation.
NotifyOnlyRequestValidationFailure This property is required. bool
If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
NotifyOnlyResponseBodyValidationFailure This property is required. bool
If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
QueryParameterCheck This property is required. bool
If set to true, checks if query parameters in the request exist in the API specification.
ValidateRequestBody This property is required. bool
If set to true, validates the request body content against the API specification.
ValidateRequestHeaderParams This property is required. bool
If set to true, validates HTTP header parameters against the API specification.
ValidateRequestQueryParams This property is required. bool
If set to true, validates query parameters against the API specification.
ValidateRequestUriParams This property is required. bool
If set to true, validates URI parameters in the request against the API specification.
ValidateResponseBody This property is required. 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 This property is required. bool
If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.
allowedHeaderParameters This property is required. 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 This property is required. 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 This property is required. Boolean
Indicates whether the api_spec is URI-Encoded.
customBasePath This property is required. String
The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck This property is required. Boolean
If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath This property is required. Boolean
Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure This property is required. Boolean
If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure This property is required. Boolean
If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck This property is required. Boolean
If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody This property is required. Boolean
If set to true, validates the request body content against the API specification.
validateRequestHeaderParams This property is required. Boolean
If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams This property is required. Boolean
If set to true, validates query parameters against the API specification.
validateRequestUriParams This property is required. Boolean
If set to true, validates URI parameters in the request against the API specification.
validateResponseBody This property is required. 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 This property is required. Boolean
If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.
allowedHeaderParameters This property is required. 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 This property is required. 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 This property is required. boolean
Indicates whether the api_spec is URI-Encoded.
customBasePath This property is required. string
The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck This property is required. boolean
If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath This property is required. boolean
Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure This property is required. boolean
If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure This property is required. boolean
If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck This property is required. boolean
If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody This property is required. boolean
If set to true, validates the request body content against the API specification.
validateRequestHeaderParams This property is required. boolean
If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams This property is required. boolean
If set to true, validates query parameters against the API specification.
validateRequestUriParams This property is required. boolean
If set to true, validates URI parameters in the request against the API specification.
validateResponseBody This property is required. 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 This property is required. boolean
If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.
allowed_header_parameters This property is required. 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 This property is required. 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 This property is required. bool
Indicates whether the api_spec is URI-Encoded.
custom_base_path This property is required. 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 This property is required. bool
If set to true, checks if HTTP header parameters in the request exist in the API specification.
include_base_path This property is required. bool
Indicates whether to include the base path when performing path match evaluation.
notify_only_request_validation_failure This property is required. 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 This property is required. bool
If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
query_parameter_check This property is required. bool
If set to true, checks if query parameters in the request exist in the API specification.
validate_request_body This property is required. bool
If set to true, validates the request body content against the API specification.
validate_request_header_params This property is required. bool
If set to true, validates HTTP header parameters against the API specification.
validate_request_query_params This property is required. bool
If set to true, validates query parameters against the API specification.
validate_request_uri_params This property is required. bool
If set to true, validates URI parameters in the request against the API specification.
validate_response_body This property is required. 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 This property is required. bool
If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.
allowedHeaderParameters This property is required. 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 This property is required. 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 This property is required. Boolean
Indicates whether the api_spec is URI-Encoded.
customBasePath This property is required. String
The base path to be used for path match evaluation. This value is ignored if include_base_path is set to false.
headerParameterCheck This property is required. Boolean
If set to true, checks if HTTP header parameters in the request exist in the API specification.
includeBasePath This property is required. Boolean
Indicates whether to include the base path when performing path match evaluation.
notifyOnlyRequestValidationFailure This property is required. Boolean
If set to true, notifications via event hooks are enabled, but request based validation failures don't affect the request flow.
notifyOnlyResponseBodyValidationFailure This property is required. Boolean
If set to true, notifications via event hooks are enabled, but response validation failures don't affect the response flow.
queryParameterCheck This property is required. Boolean
If set to true, checks if query parameters in the request exist in the API specification.
validateRequestBody This property is required. Boolean
If set to true, validates the request body content against the API specification.
validateRequestHeaderParams This property is required. Boolean
If set to true, validates HTTP header parameters against the API specification.
validateRequestQueryParams This property is required. Boolean
If set to true, validates query parameters against the API specification.
validateRequestUriParams This property is required. Boolean
If set to true, validates URI parameters in the request against the API specification.
validateResponseBody This property is required. 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 This property is required. Boolean
If set to true, returns a detailed error message for invalid requests & responses. This is useful while testing.

GetGatewayPluginOasValidationConsumer

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginOasValidationOrdering

after This property is required. Property Map
before This property is required. Property Map

GetGatewayPluginOasValidationOrderingAfter

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginOasValidationOrderingBefore

Accesses This property is required. List<string>
Accesses This property is required. []string
accesses This property is required. List<String>
accesses This property is required. string[]
accesses This property is required. Sequence[str]
accesses This property is required. List<String>

GetGatewayPluginOasValidationRoute

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

GetGatewayPluginOasValidationService

Id This property is required. string
Id This property is required. string
id This property is required. String
id This property is required. string
id This property is required. str
id This property is required. String

Package Details

Repository
konnect kong/terraform-provider-konnect
License
Notes
This Pulumi package is based on the konnect Terraform Provider.
konnect 2.5.0 published on Tuesday, Apr 15, 2025 by kong
kong/terraform-provider-konnect