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

Some REST API documentation issues #10

Open
c8y3 opened this issue Jan 9, 2023 · 0 comments
Open

Some REST API documentation issues #10

c8y3 opened this issue Jan 9, 2023 · 0 comments

Comments

@c8y3
Copy link
Contributor

c8y3 commented Jan 9, 2023

Here are a few issues with the REST API documentation.

  • The example url provided in section "How to use" of https://docs.dfir-iris.org/operations/api/ has query parameter cid (http://localhost:8000/manage/cases/list?cid=1). But in the API documentation of endpoint /manage/cases/list, cid does not seem to be a query parameter.
  • Field cid in the payload of /manage/cases/add is indicated as required. This does not seem to be the case both from the request sample and an experimentation with v2.0.0-beta-1.
  • It would be nice to have a response sample for endpoint /case/export
  • Endpoint /manage/customers/list to get the list of customers is not documented but seems to be working in version v2.0.0-beta-1
  • Endpoint /manage/cases/{cid} to get a case seems not to be working in version v2.0.0-beta-1. It is not documented either, but it is present in the client. What should it be?

Initially opened as dfir-iris/iris-web#165 (comment)

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

No branches or pull requests

1 participant