Skip to content

OpenAPI HTTP specification #438

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

Open
xray-robot opened this issue Apr 24, 2025 · 2 comments
Open

OpenAPI HTTP specification #438

xray-robot opened this issue Apr 24, 2025 · 2 comments

Comments

@xray-robot
Copy link
Contributor

Curious to know if the OpenAPI specification can be updated to the full version, and if you plan to do so (and is it complicated?): https://ogmios.dev/openapi.yaml.

In many serverless environments, such as Cloudflare Workers, you have to pay extra for WebSockets (or you're not allowed to work as a client at all), so it is desirable to have a fully typed HTTP client.

Example

https://github.com/xray-network/cardano-ogmios-client/blob/bf74f4258af282a29dd2fc7251ba8ff490af6563/test/index.spec.ts#L18

Thanks!

@KtorZ
Copy link
Member

KtorZ commented Apr 24, 2025

Honestly, I never quite bothered because the schema is identical to the WebSocket one. So it's, in a way, already documented?

If there anything specific you're missing?

@xray-robot
Copy link
Contributor Author

xray-robot commented Apr 25, 2025

I mean generation of OpenAPI schema from already ready types for WebSocket client — AsyncAPI schema.

UPD. More precisely, generate two of these schemes at once.
UPD2. This will allow you to generate HTTP clients for literally any programming language, without having to manually make edits each time a change is made to the schema.

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