Using OpenAPI Params in an Async API Spec

[jpvajda]

Hi There,

I am trying to reference a parameter that exists in my Open API Specification from my Async API Specification as the same parameter is available in our REST API and our WebSocket. It seems there might be a way but after troubleshooting with some help from Claude, I keep going in circles:

We are using Open API spec 3.1.0 and Async API 3.0.0

Is this possible or am I wasting time here?

Here's some example code:

Open API Spec Parameter: Diarize

name: diarize
in: query
required: false
description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0
schema:
  default: false
  type: boolean
example: true

Async API Spec Param: Diarize

description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0
location: $message.header#/diarize
schema:
  $ref: "../../../components/parameters/listen/diarize.yml#/schema"
examples:
  - "true" 

Build Errors

Errors 
ws_components/parameters/listen/diarize.yml
 1:1  error  asyncapi-document-resolved  Property "schema" is not expected to be here

✖ 1 problems (1 errors, 0 warnings, 0 infos, 0 hints)

Another Attempt: Async API Spec Param: Diarize

description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0
location: $message.payload#/diarize
payload:
  $ref: "../../../components/parameters/listen/diarize.yml#/schema"
examples:
  - "true"

Build Errors

ws_components/parameters/listen/diarize.yml
 1:1  error  asyncapi-document-resolved  Property "payload" is not expected to be here

✖ 1 problem (1 error, 0 warnings, 0 infos, 0 hints)

[jpvajda]

I think I found a way to make this work using the specification extensions feature.

So I'll leave this issue as closed in case anyone is also looking at how to do this:

Using Specification Extensions

description: Recognize speaker changes. Each word in the transcript will be assigned a speaker number starting at 0
location: $message.payload#/diarize
default: "false"
x-schema:
  $ref: "../../../components/parameters/listen/diarize.yml#/schema"
examples:
  - "true"