Incomplete OpenAPI data #1700
Labels
bug
Something isn't working
Comments
|
Unfortunately, the OpenAPI has never been working at all. We recently did a ton of fixes (see #1564), but it is still a work in progress. |
5 tasks
|
The source for the demo is #1662 |
imobachgs
added a commit
that referenced
this issue
Nov 13, 2024
The OpenAPI spec is not complete, as reported in #1700. This PR aims to add the missing pieces to the spec. As part of the work, I updated the utoipa dependency to version 5.2 which is much better when it comes to detect omissions and problems. ## Tasks - [x] Add missing `/api` prefix. - [x] Add missing paths. - [x] Add missing components. - [x] Migrate to utoipa 5. - [ ] Add the `issues` spec (postponed).
|
Most of the problems are already fixed by #1564. The |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Use case
I created an online Agama demo at https://agama-online-demo.surge.sh/. I collected the testing data by recording the HTTP responses while clicking around in the browser. But that's inconvenient and fragile (you need to go through all Agama settings, if you miss something then the data is incomplete).
I'd like to automate that, the idea is to get the list of endpoints from the OpenAPI data and query all paths by a script.
But when comparing the current OpenAPI data and the data I got from the browser I found some inconsistencies which block this approach.
Note: In this use case I'm interested only in the GET requests, the same problem or more problems might be with the POST/PUT/... requests.
Missing paths
These paths are missing in the OpenAPI:
Missing /api prefix
Some OpenAPI paths miss the
/apiprefix:The text was updated successfully, but these errors were encountered: