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

standardListQueryParameters is way too standard #1342

Open
Etsija opened this issue Nov 1, 2024 · 0 comments
Open

standardListQueryParameters is way too standard #1342

Etsija opened this issue Nov 1, 2024 · 0 comments
Labels
api Issues related to the API. documentation Improvements or additions to documentation.

Comments

@Etsija
Copy link
Contributor

Etsija commented Nov 1, 2024

When starting to implement sorting-related stuff for the UI, I bumped into this:

Screenshot from 2024-11-01 13-43-44

"The listed fields must be supported by the endpoint" is way too vague for documenting an API endpoint properly. As a non-back-end specialist, I had to dig quite deep into the code to find out the fields by which the results of a certain list query can be sorted.

Could this function be changed into something, which actually prints out to the API docs, which are the sortable fields of an endpoint?

@Etsija Etsija added documentation Improvements or additions to documentation. api Issues related to the API. labels Nov 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues related to the API. documentation Improvements or additions to documentation.
Projects
None yet
Development

No branches or pull requests

1 participant