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

Api v2 cases put #36

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Api v2 cases put #36

wants to merge 13 commits into from

Conversation

c8y3
Copy link
Contributor

@c8y3 c8y3 commented Jan 17, 2025

Updated documentation with:

  • PUT /api/v2/cases/{case_identifier}
  • endpoints at /api/v2/cases/{case_identifier}/iocs/{identifier}
  • endpoints at /api/v2/cases/{case_identifier}/assets/{identifier}
  • endpoints at /api/v2/cases/{case_identifier}/tasks/{identifier}
  • the missing endpoints from Case Object IDs iris-web#549 (GET /manage/tlp/list and GET /manage/event-categories/list)
  • GET /manage/severities/list

There are many endpoints which were recently added to the implementation, which are not documented yet. This is done on purpose, as I feel we need to discuss them first (they do not seem to be consistent with the rules we are trying to follow for API v2):

  • implementation of GET /api/v2/alerts does not adhere to the conventions (return value for paginated data: field alerts should be field data)
  • implementation of GET /api/v2/cases/{identifier}/assets does not adhere to the conventions (return value for paginated data: field assets should be field data, spurious field state, missing total, last_page, current_page and next_page)
  • I am not sure we want /api/v2/login, /api/v2/logout and /api/v2/whoami
  • implementation of GET /api/v2/context/search-cases (verb in URL)
  • implementation of POST /api/v2/context/set (verb in URL)
  • GET /api/v2/dashboard/cases/list does not adhere to the conventions (verb in URL)
  • Why do we need GET /api/v2/dashboard/cases/list? Shouldn't we be using the cases resource: GET /api/v2/cases with the right parameters
  • Same with GET /api/v2/dashboard/tasks/list (and maybe GET /api/v2/dashboard/reviews/list)

@c8y3 c8y3 requested a review from whikernel January 17, 2025 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant