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

Getting OpenAPI spec of a service? #2678

Open
musjj opened this issue Feb 8, 2025 · 3 comments
Open

Getting OpenAPI spec of a service? #2678

musjj opened this issue Feb 8, 2025 · 3 comments
Labels
question Further information is requested

Comments

@musjj
Copy link

musjj commented Feb 8, 2025

I'm noticing that there's an openapi endpoint:

.route(
"/services/:service/openapi",
get(openapi_handler!(services::get_service_openapi)),
)

But running (with the Tour of Restate example):

$ curl localhost:9070/services/CartObject/openapi

Prints nothing.

@slinkydeveloper
Copy link
Contributor

Hey I'm adding this to the documentation: restatedev/documentation#521 It will be available in Restate 1.2, releasing this week

@slinkydeveloper slinkydeveloper added the question Further information is requested label Feb 10, 2025
@musjj
Copy link
Author

musjj commented Feb 10, 2025

Thank you, can't wait to try it!

the rich input/output JSON schemas are included as well

Can you elaborate what this means? Does this mean that the spec of the input/output schema might not be included?

@slinkydeveloper
Copy link
Contributor

Does this mean that the spec of the input/output schema might not be included?

Yes, that's because we still need to add json schema support in the various SDKs. At the moment only Java and Python have a good support for it, for the other SDKs what you get is just schema: true, which client generators interpret as "any" input/generic json or something alike.

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

No branches or pull requests

2 participants