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 more documentation for api endpoint GET requests #752

Closed
1 of 6 tasks
johannaengland opened this issue Apr 11, 2024 · 1 comment · Fixed by #755
Closed
1 of 6 tasks

Add more documentation for api endpoint GET requests #752

johannaengland opened this issue Apr 11, 2024 · 1 comment · Fixed by #755
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@johannaengland
Copy link
Contributor

johannaengland commented Apr 11, 2024

Specifically example results and potential explanations of fields.

  • v1: auth (api/v1/auth/user)
  • v1: incidents (api/v1/incidents/metadata/)
  • v1: notificationprofiles (api/v1/notificationprofiles/, api/v1/notificationprofiles/timeslots/, api/v1/notificationprofiles/filters/)
  • v2: auth (api/v2/auth/user)
  • v2: incidents
  • v2: notificationprofiles (api/v2/notificationprofiles/, api/v2/notificationprofiles/destinations/, api/v2/notificationprofiles/media/, api/v2/notificationprofiles/media/<slug:slug>/json_schema/, api/v2/notificationprofiles/timeslots/, api/v2/notificationprofiles/filters/)
@johannaengland johannaengland added the documentation Improvements or additions to documentation label Apr 11, 2024
@johannaengland
Copy link
Contributor Author

As mentioned in Uninett/Argus-frontend#537

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

Successfully merging a pull request may close this issue.

1 participant