Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add AsyncAPI spec for Realtime API #347

Open
HavenDV opened this issue Oct 7, 2024 · 3 comments
Open

Add AsyncAPI spec for Realtime API #347

HavenDV opened this issue Oct 7, 2024 · 3 comments

Comments

@HavenDV
Copy link

HavenDV commented Oct 7, 2024

Specification: https://www.asyncapi.com/en
Example: https://github.com/AssemblyAI/assemblyai-api-spec/blob/main/asyncapi.yml

@StephenHodgson
Copy link

added in #356

@StephenHodgson
Copy link

Duplicate of #341

@HavenDV
Copy link
Author

HavenDV commented Oct 17, 2024

Although schemas have been added to OpenAPI spec and that's great, I think it still makes sense because the OpenAPI spec doesn't describe Realtime interactions, while the AsyncAPI spec is aimed at this and fully describes each step, and client code can be generated and maintained automatically as complexity increases.
This is supported by some generators already (e.g. fern - https://buildwithfern.com/), I also plan to support it in my generator - https://github.com/tryAGI/AutoSDK
This may also be a motivator for other generators

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants