Comment on Admins: Instnace randomly running extremely slowly? Check for this
mapto@feddit.bg 6 days agoCould you elaborate on this:
it’s not really possible to document and validate that an endpoint needs to have at least one of something
In what sense it is not possible, as I can easily see it done in the code?
freamon@preferred.social 5 days ago
It’s straight-forward enough to do in back-end code, to just reject a query if parameters are missing, but I don’t think there’s a way to define a schema that then gets used to auto-generate the documentation and validate the requests. If the request isn’t validated, then the back-end never sees it.
For something like https://freamon.github.io/piefed-api/#/Misc/get_api_alpha_search, the docs show that ‘q’ and ‘type_’ are required, and everything else is optional. The schema definition looks like:
required
is a simple boolean for each individual field - you can say every field is required, or no fields are required, but I haven’t come across a way to say that at least one field is required.mapto@feddit.bg 5 days ago
Ah, I see, so you are talking about this.
Of course it is nice if things get auto-generated, but doing it yourself, both in code and documentation should never be excluded as an option.
freamon@preferred.social 5 days ago
Exactly that, yeah. Thank you for the link.