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 documentation about what is expected in request bodies #734

Open
d-perl opened this issue Nov 28, 2024 · 1 comment
Open

Add documentation about what is expected in request bodies #734

d-perl opened this issue Nov 28, 2024 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@d-perl
Copy link
Contributor

d-perl commented Nov 28, 2024

E.g. https://diamondlightsource.github.io/blueapi/main/reference/rest-spec.html#post--tasks would have you believe that no parameters are taken for this rest call, but instead the plan name and params should be supplied in the body

@callumforrester callumforrester added bug Something isn't working documentation Improvements or additions to documentation labels Nov 29, 2024
@callumforrester
Copy link
Contributor

Strange, it looks like it should include this per the docs.

I think this needs investigating, maybe sphinxcontrib-openapi's flavour of openapi is subtly different than fastapi's

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants