Feature - APIs & openapi spec

There’s still quite a few data elements in Eramba that do not feature an API or API documentation. Some examples include:

  • Account Reviews
  • Awareness Programs
  • Business Units
  • Continuity Plans
  • Compliance Exceptions
  • External Audit Findings
  • Goals
  • Liabilities
  • Program Issues
  • Scope
  • Support Contracts
  • Policy Exceptions
  • Team Roles

I may have missed a couple and it seems some like Business Units are listed in this postman collection, but not in the application itself: Postman

We are aiming for extensive integration of Eramba and the available APIs have been very helpful with that, but some of the missing APIs would be very useful to have. Out of this list I am especially looking for APIs for Continuity Plans and Awareness Programs.

I’m not sure if these are excluded by design or if there’s just not been time to implement them yet, but if possible I would like to request them as a feature.

It would also be tremendously helpful if you could provide a full OpenAPI v3.x specification of the available APIs accessible through the application at runtime. While the postman collection has been helpful, I’ve ran into some issues where the application returns 500 errors on bad requests which requires me to examine the error log to figure out what the exact cause is. Sometimes it’s just a serialization issue where the data is not serialized by our applications into the same JSON elements that the API expects and fails in the deserialization process, probably prior to the data validation pipeline. The API specification in the application does provide some added value as well, but it’s not easily machine readable to generate API clients.

Hello,

We are starting with the migration of APIs already. I will prepare the post and paste it here too.

Regarding the available sections, I cannot tell right now, but we will go back to the Swagger documentation that we used before.

1 Like