SSI DIm Middle Layer documentation

[jjeroch]

Description

The ssi-dim-middle-layer component is a critical part of the SSI architecture to ensure that the SAP Wallet can get integrated with the catena-x world.
This ticket aims to add comprehensive documentation to the component's repository, focusing on the database schema and the testing suite.

Tasks

1. Database Documentation

• Document the database schema used by the ssi-dim-middle-layer component, including the following:
  • Entity-Relationship (ER) diagram showcasing the tables and their relationships
  • Detailed description of each table, including:
    • Table name
    • Column names and data types
    • Primary and foreign key constraints
    • Brief explanation of the purpose of each table
  • Explanation of any indexing strategies or optimization techniques employed

2. Testing Documentation

• Document the testing suite for the ssi-dim-middle-layer component, including:
  • Overview of current considered tests incl. a breakdown of the different test suites (e.g., unit tests, integration tests, end-to-end tests)
  • Overview of the testing framework and its configuration
  • Description of the test cases
  • Instructions on how to run the tests locally and in the CI/CD pipeline

3. General Documentation

• Provide a high-level overview of the ssi-dim-middle-layer component, including:
  • Purpose and responsibilities of the component
  • Integration points with other components in the SSI platform
  • Deployment and configuration guidelines