9. API Proposal

You will find below a link to the latest version of the swagger file that contains all entities manipulated by the system and the API calls associated with them. The swagger includes the roles that have access to each API call.

https://prod.rncv.lu/backend/api/v1/swagger-ui/

1.1. Change log

2.1. Context

2.2. Document purpose and scope

2.3. Targeted audience

3.1. User management

3.2. Roles

4.1. User - Profile management [canceled]

4.2. User - Change password

4.3. User - Manage user secrets [canceled]

4.4. Application Administrator - Create users

4.5. Application Administrator - Update users

4.6. Application Administrator - Delete users

4.7. Application Administrator - Recover users marked for deletion

4.8. Application Administrator - Create access tokens [new]

4.9. Application Administrator - Delete access tokens [new]

4.10. Application Administrator - View audit logs

4.11. Application Administrator - View all data on the platform

4.12. Application Administrator - Restore deleted records

4.13. Application Administrator - Un-reject/approve an approved/rejected record

4.14. Application Administrator - Export all

4.15. Application Administrator - Monitoring

4.16. Application Administrator - Alerting

4.17. Application Administrator - Lightweight Administration Panel

4.18. Application Administrator - Define webhooks [new]

4.19. Organisation Administrator - Create organisation users

4.20. Organisation Administrator - Update organisation users

4.21. Organisation Administrator - Delete organisation users

4.22. Organisation Approver - Recover organisation users marked for deletion

4.23. Organisation Administrator - Create organisation access tokens [new]

4.24. Organisation Administrator - Delete organisation access tokens [new]

4.25. Organisation Administrator - View organisation audit logs

4.26. Organisation Administrator - Un-reject/approve an approved/rejected record lined to organisation

4.27. Organisation Administrator - Restore records deleted by the organisation

4.28. Editor - Create temporary address

4.29. Editor - Create an additional temporary address for an existing site

4.30. Editor - Create an additional temporary address for an existing block

4.31. Editor - Add a site

4.32. Editor - Update a site

4.33. Editor - Delete a site

4.34. Editor - Add a block

4.35. Editor - Update a block

3.36. Editor - Delete a block

4.37. Editor - Add a unit

4.38. Editor - Update a unit

4.39. Editor - Delete a unit

4.40. Editor - Add an equipment

4.41. Editor - Update an equipment

4.42. Editor - Delete an equipment

4.43. Editor - Attach pictures [postponed]

4.44. Editor - Delete Pictures [postponed]

4.45. Editor - Search a site by address

4.46. Editor - Send an update vertical cabling request

4.47. Approver - Approve deleted site request

4.48. Approver - Approve deleted block request

4.49. Approver - Approve deleted unit request

4.50. Approver - Approve deleted equipment request

4.51. Approver - Approve or reject update vertical cabling request

4.52. Organisation Approver - Approve deleted site request for organisation

4.53. Organisation Approver - Approve deleted block request for organisation

4.54. Organisation Approver - Approve deleted unit request for organisation

4.55. Organisation Approver - Approve delete equipment request for organisation

4.56. Organisation Approver - Approve or reject update vertical cabling request for organisation

4.57. Analyst - Access to all data

4.58. Analyst - Querying data

4.59. Analyst - Query historical data

4.60. Analyst - Query audit logs

4.61. Analyst - Export data [to be reviewed]

4.62. Analyst - Integrate external applications [to be reviewed]

4.63. Analyst - Un-reject/approve an approved/rejected record

4.64. Viewer - Search sites/blocks/units/equipments by address

4.65. Viewer - Read single entries by ID

4.66. Viewer - Read different versions of connections

4.67. ETL - Retrieve addresses

4.68. ETL - Create and update addresses

6.1. User management

6.2. Address ingestion

6.3. Versioning, approvals and audit logs

6.4. Data privacy

6.5. Data quality

6.6. Data governance