OAS Validation Configuration Examples

Configuration Examples

Enable on a service

Enable on a route

Enable on a consumer

Enable globally

The following examples provide some typical configurations for enabling the oas-validation plugin on a service.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/services/SERVICE_NAME|SERVICE_ID/plugins \
    --data "name=oas-validation"  \
    --data "config.api_spec=openapi: 3.0.0
info:
  version: \"2.19.3\"
  title: Xero Finance API
  description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
  termsOfService: \"https://developer.xero.com/xero-developer-platform-terms-conditions/\"
  contact:
    name: \"Xero Platform Team\"
    email: \"api@xero.com\"
    url: \"https://developer.xero.com\"
  license:
    name: MIT
    url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
servers:
  - description: Xero API servers
    url: https://api.xero.com/finance.xro/1.0
paths:
  /CashValidation:
    get:
      security:
        - OAuth2: [finance.cashvalidation.read]
      tags:
        - Finance
      summary: Get cash validation
      operationId: getCashValidation
      description: Summarizes the total cash position for each account for an org
"

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: oas-validation-example
plugin: oas-validation
config:
  api_spec: |
    openapi: 3.0.0
    info:
      version: "2.19.3"
      title: Xero Finance API
      description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
      termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
      contact:
        name: "Xero Platform Team"
        email: "api@xero.com"
        url: "https://developer.xero.com"
      license:
        name: MIT
        url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
    servers:
      - description: Xero API servers
        url: https://api.xero.com/finance.xro/1.0
    paths:
      /CashValidation:
        get:
          security:
            - OAuth2: [finance.cashvalidation.read]
          tags:
            - Finance
          summary: Get cash validation
          operationId: getCashValidation
          description: Summarizes the total cash position for each account for an org
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the service as follows:

kubectl annotate service SERVICE_NAME konghq.com/plugins=oas-validation-example

Replace SERVICE_NAME with the name of the service that this plugin configuration will target. You can see your available ingresses by running kubectl get service.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: oas-validation
  service: SERVICE_NAME|SERVICE_ID
  config:
    api_spec: |
      openapi: 3.0.0
      info:
        version: "2.19.3"
        title: Xero Finance API
        description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
        termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
        contact:
          name: "Xero Platform Team"
          email: "api@xero.com"
          url: "https://developer.xero.com"
        license:
          name: MIT
          url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
      servers:
        - description: Xero API servers
          url: https://api.xero.com/finance.xro/1.0
      paths:
        /CashValidation:
          get:
            security:
              - OAuth2: [finance.cashvalidation.read]
            tags:
              - Finance
            summary: Get cash validation
            operationId: getCashValidation
            description: Summarizes the total cash position for each account for an org

Replace SERVICE_NAME|SERVICE_ID with the id or name of the service that this plugin configuration will target.

The following examples provide some typical configurations for enabling the oas-validation plugin on a route.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/routes/ROUTE_NAME|ROUTE_ID/plugins \
    --data "name=oas-validation"  \
    --data "config.api_spec=openapi: 3.0.0
info:
  version: \"2.19.3\"
  title: Xero Finance API
  description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
  termsOfService: \"https://developer.xero.com/xero-developer-platform-terms-conditions/\"
  contact:
    name: \"Xero Platform Team\"
    email: \"api@xero.com\"
    url: \"https://developer.xero.com\"
  license:
    name: MIT
    url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
servers:
  - description: Xero API servers
    url: https://api.xero.com/finance.xro/1.0
paths:
  /CashValidation:
    get:
      security:
        - OAuth2: [finance.cashvalidation.read]
      tags:
        - Finance
      summary: Get cash validation
      operationId: getCashValidation
      description: Summarizes the total cash position for each account for an org
"

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: oas-validation-example
plugin: oas-validation
config:
  api_spec: |
    openapi: 3.0.0
    info:
      version: "2.19.3"
      title: Xero Finance API
      description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
      termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
      contact:
        name: "Xero Platform Team"
        email: "api@xero.com"
        url: "https://developer.xero.com"
      license:
        name: MIT
        url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
    servers:
      - description: Xero API servers
        url: https://api.xero.com/finance.xro/1.0
    paths:
      /CashValidation:
        get:
          security:
            - OAuth2: [finance.cashvalidation.read]
          tags:
            - Finance
          summary: Get cash validation
          operationId: getCashValidation
          description: Summarizes the total cash position for each account for an org
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the ingress as follows:

kubectl annotate ingress INGRESS_NAME konghq.com/plugins=oas-validation-example

Replace INGRESS_NAME with the name of the ingress that this plugin configuration will target. You can see your available ingresses by running kubectl get ingress.

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: oas-validation
  route: ROUTE_NAME|ROUTE_ID
  config:
    api_spec: |
      openapi: 3.0.0
      info:
        version: "2.19.3"
        title: Xero Finance API
        description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
        termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
        contact:
          name: "Xero Platform Team"
          email: "api@xero.com"
          url: "https://developer.xero.com"
        license:
          name: MIT
          url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
      servers:
        - description: Xero API servers
          url: https://api.xero.com/finance.xro/1.0
      paths:
        /CashValidation:
          get:
            security:
              - OAuth2: [finance.cashvalidation.read]
            tags:
              - Finance
            summary: Get cash validation
            operationId: getCashValidation
            description: Summarizes the total cash position for each account for an org

Replace ROUTE_NAME|ROUTE_ID with the id or name of the route that this plugin configuration will target.

The following examples provide some typical configurations for enabling the oas-validation plugin on a consumer.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/consumers/CONSUMER_NAME|CONSUMER_ID/plugins \
    --data "name=oas-validation"  \
    --data "config.api_spec=openapi: 3.0.0
info:
  version: \"2.19.3\"
  title: Xero Finance API
  description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
  termsOfService: \"https://developer.xero.com/xero-developer-platform-terms-conditions/\"
  contact:
    name: \"Xero Platform Team\"
    email: \"api@xero.com\"
    url: \"https://developer.xero.com\"
  license:
    name: MIT
    url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
servers:
  - description: Xero API servers
    url: https://api.xero.com/finance.xro/1.0
paths:
  /CashValidation:
    get:
      security:
        - OAuth2: [finance.cashvalidation.read]
      tags:
        - Finance
      summary: Get cash validation
      operationId: getCashValidation
      description: Summarizes the total cash position for each account for an org
"

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

in the same request, to further narrow the scope of the plugin.

First, create a KongPlugin resource:

echo "
apiVersion: configuration.konghq.com/v1
kind: KongPlugin
metadata:
  name: oas-validation-example
plugin: oas-validation
config:
  api_spec: |
    openapi: 3.0.0
    info:
      version: "2.19.3"
      title: Xero Finance API
      description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
      termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
      contact:
        name: "Xero Platform Team"
        email: "api@xero.com"
        url: "https://developer.xero.com"
      license:
        name: MIT
        url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
    servers:
      - description: Xero API servers
        url: https://api.xero.com/finance.xro/1.0
    paths:
      /CashValidation:
        get:
          security:
            - OAuth2: [finance.cashvalidation.read]
          tags:
            - Finance
          summary: Get cash validation
          operationId: getCashValidation
          description: Summarizes the total cash position for each account for an org
" | kubectl apply -f -

Next, apply the KongPlugin resource to an ingress by annotating the KongConsumer object as follows:

kubectl annotate KongConsumer CONSUMER_NAME konghq.com/plugins=oas-validation-example

Replace CONSUMER_NAME with the name of the consumer that this plugin configuration will target. You can see your available consumers by running kubectl get KongConsumer.

To learn more about KongConsumer objects, see Provisioning Consumers and Credentials .

Note: The KongPlugin resource only needs to be defined once and can be applied to any service, consumer, or route in the namespace. If you want the plugin to be available cluster-wide, create the resource as a KongClusterPlugin instead of KongPlugin.

Add this section to your declarative configuration file:

plugins:
- name: oas-validation
  consumer: CONSUMER_NAME|CONSUMER_ID
  config:
    api_spec: |
      openapi: 3.0.0
      info:
        version: "2.19.3"
        title: Xero Finance API
        description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
        termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
        contact:
          name: "Xero Platform Team"
          email: "api@xero.com"
          url: "https://developer.xero.com"
        license:
          name: MIT
          url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
      servers:
        - description: Xero API servers
          url: https://api.xero.com/finance.xro/1.0
      paths:
        /CashValidation:
          get:
            security:
              - OAuth2: [finance.cashvalidation.read]
            tags:
              - Finance
            summary: Get cash validation
            operationId: getCashValidation
            description: Summarizes the total cash position for each account for an org

Replace CONSUMER_NAME|CONSUMER_ID with the id or name of the consumer that this plugin configuration will target.

A plugin which is not associated to any service, route, or consumer is considered global, and will be run on every request. Read the Plugin Reference and the Plugin Precedence sections for more information.

The following examples provide some typical configurations for enabling the OAS Validation plugin globally.

Admin API

Kubernetes

Declarative (YAML)

Make the following request:

curl -X POST http://localhost:8001/plugins/ \
    --data "name=oas-validation"  \
    --data "config.api_spec=openapi: 3.0.0
info:
  version: \"2.19.3\"
  title: Xero Finance API
  description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
  termsOfService: \"https://developer.xero.com/xero-developer-platform-terms-conditions/\"
  contact:
    name: \"Xero Platform Team\"
    email: \"api@xero.com\"
    url: \"https://developer.xero.com\"
  license:
    name: MIT
    url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
servers:
  - description: Xero API servers
    url: https://api.xero.com/finance.xro/1.0
paths:
  /CashValidation:
    get:
      security:
        - OAuth2: [finance.cashvalidation.read]
      tags:
        - Finance
      summary: Get cash validation
      operationId: getCashValidation
      description: Summarizes the total cash position for each account for an org
"

Create a KongClusterPlugin resource and label it as global:

apiVersion: configuration.konghq.com/v1
kind: KongClusterPlugin
metadata:
  name: <global-oas-validation>
  annotations:
    kubernetes.io/ingress.class: kong
  labels:
    global: "true"
config:
  api_spec: |
    openapi: 3.0.0
    info:
      version: "2.19.3"
      title: Xero Finance API
      description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
      termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
      contact:
        name: "Xero Platform Team"
        email: "api@xero.com"
        url: "https://developer.xero.com"
      license:
        name: MIT
        url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
    servers:
      - description: Xero API servers
        url: https://api.xero.com/finance.xro/1.0
    paths:
      /CashValidation:
        get:
          security:
            - OAuth2: [finance.cashvalidation.read]
          tags:
            - Finance
          summary: Get cash validation
          operationId: getCashValidation
          description: Summarizes the total cash position for each account for an org
plugin: oas-validation

Add a plugins entry in the declarative configuration file:

plugins:
- name: oas-validation
  config:
    api_spec: |
      openapi: 3.0.0
      info:
        version: "2.19.3"
        title: Xero Finance API
        description: The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
        termsOfService: "https://developer.xero.com/xero-developer-platform-terms-conditions/"
        contact:
          name: "Xero Platform Team"
          email: "api@xero.com"
          url: "https://developer.xero.com"
        license:
          name: MIT
          url: 'https://github.com/XeroAPI/Xero-OpenAPI/blob/master/LICENSE'
      servers:
        - description: Xero API servers
          url: https://api.xero.com/finance.xro/1.0
      paths:
        /CashValidation:
          get:
            security:
              - OAuth2: [finance.cashvalidation.read]
            tags:
              - Finance
            summary: Get cash validation
            operationId: getCashValidation
            description: Summarizes the total cash position for each account for an org

Previous OAS Validation Configuration