openapi-asyncapi proxy

The openapi-asyncapi proxy binding for adapting openapi operations to asyncapi operations.

openapi_asyncapi_proxy:
  type: openapi-asyncapi
  kind: proxy
  options:
    specs:
      openapi:
        my-openapi-spec:
          catalog:
            my_catalog:
              subject: petstore
              version: latest
      asyncapi:
        my-asyncapi-spec:
          catalog:
              my_catalog:
                subject: petstore
                version: latest
  routes:
    - when:
        - api-id: my-openapi-spec
      exit: asyncapi_client
      with:
        api-id: my-asyncapi-spec

Configuration (* required)

options

object

The openapi-asyncapi specific options.

options:
  specs:
    openapi:
      my-openapi-spec:
        catalog:
          my_catalog:
            subject: petstore
            version: latest
    asyncapi:
      my-asyncapi-spec:
        catalog:
            my_catalog:
              subject: petstore
              version: latest

options.specs

object

OpenAPI and AsyncAPI specs definition.

specs.openapi*

object as map of named object properties

Options for each configured OpenAPI spec.

openapi.catalog

object as map of named object properties

The Catalog specific options.

catalog.subject*

string

Subject name used when storing the catalog artifact.

catalog.version

string | Default: latest

Catalog artifact version to use.

specs.asyncapi*

object as map of named object properties

Options for each configured AsyncAPI spec.

asyncapi.catalog

object as map of named object properties

The catalog catalog specific options.

catalog.subject*

string

Subject name used when storing the catalog artifact.

catalog.version

string | Default: latest

Catalog artifact version to use.

routes

array of object

Conditional openapi-asyncapi specific routes.

routes[].guarded

object as map of named array of string

List of roles required by each named guard to authorize this route.

routes:
  - guarded:
      my_guard:
        - read:items

routes[].when

array of object

List of conditions to match this route when adapting openapi request-response streams to asyncapi streams. Read more: When a route matches

when[].api-id

string

OpenAPI spec identifier that matches from the openapi binding request stream.

when[].operation-id

string

OpenAPI OperationId that can be mapped between OpenAPI and AsyncAPI spec

routes[].exit

string

Next binding when following this route.

routes:
  - when:
    ...
    exit: asyncapi_client

routes[].with*

object

Defines the route with the AsyncAPI spec identifier and OperationId.

with:
  api-id: my-asyncapi-spec

with.api-id

string

AsyncAPI spec identifier that the route exits with to the next binding.

with.operation-id

string

AsyncAPI OperationId that the route exits with to the next binding.

exit

string

Default exit binding when no conditional routes are viable.

exit: echo_server

telemetry

object

Defines the desired telemetry for the binding.

telemetry.metrics

array

Telemetry metrics to track

telemetry:
  metrics:
    - stream.*