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.

Sign up for GitHub

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

Jump to bottom

[Ongoing Alerts] Specify the limit size of the response in API documentation #243

Open
fe51 opened this issue Mar 8, 2023 · 1 comment · May be fixed by #277
Open

[Ongoing Alerts] Specify the limit size of the response in API documentation #243

fe51 opened this issue Mar 8, 2023 · 1 comment · May be fixed by #277
Labels
endpoint: detections good first issue Good for newcomers help wanted Extra attention is needed topic: docs Improvements or additions to documentation

Comments

@fe51
Copy link
Member

fe51 commented Mar 8, 2023

Hi there,

Using the route alerts, I realize the max response size for /alerts/ongoing is limited to 50

If it can be guessed from the code, it would be useful for the user to have this information directly in the documentation.

I don't know if this information is specific to this route, if not, it would be good documentation practice in the general case.

Thanks a lot,
Happy to discuss it !
@fe51 fe51 added topic: docs Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed endpoint: detections labels Mar 8, 2023
@frgfm
Copy link
Member

frgfm commented May 28, 2023

Fully agree, I imagine we're gonna solve this at the same time as #250 👍

blenzi pushed a commit that referenced this issue Aug 7, 2023
feat: add limit and offset parameters to routes that fetch lists from db
95cd027 
- add limit and offset parameters with descriptions, to all routes that fetch lists from db (fix #243, #250)
- use crud.fetch_all in all the routes above, to limit the number of items returned for non-admin users (fix #276)
- forbid /installation/site-devices to access site outside of group, instead of filtering devices
- improve test_installations.py (test_get_active_devices_on_site)
- Dockerfile-dev: update FROM image name
@blenzi blenzi linked a pull request Aug 7, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
endpoint: detections good first issue Good for newcomers help wanted Extra attention is needed topic: docs Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add limit and offset parameters to routes that fetch lists from db pyronear/pyro-api
2 participants
@frgfm @fe51