Docs: Add diagrams for pool components

[fabiodmota]

Description

Create mermaid sequence diagrams showing the different services/components of the BPDM Pool and how they interact each other on these use cases:

• Create legal entity
• Update legal entity
• Search legal entity

#472

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

• DEPENDENCIES are up-to-date. Dash license tool. Committers can open IP issues for restricted libs.
• Copyright and license header are present on all affected files

[nicoprow]

I think these are great diagrams, very detailed and explain a lot about the inner workings of the Pool. I have a small concern with this: The method names in the sequence diagrams could be replaced with a more abstract description. Since there are explanations in the below this is just a minor issue. Also, concepts change less often than method names and it would be a nightmare to keep this documentation up-to-date with the current names and method invocations in detail.

In general I think it's an excellent contribution, not sure though if we should have the aspiration to keep this documention the code (with names and so many details) up-to-date.

I would like to see @gerlitmcoding input on this. From my end, I would approve.

[gerlitmcoding]

I think these are great diagrams, very detailed and explain a lot about the inner workings of the Pool. I have a small concern with this: The method names in the sequence diagrams could be replaced with a more abstract description. Since there are explanations in the below this is just a minor issue. Also, concepts change less often than method names and it would be a nightmare to keep this documentation up-to-date with the current names and method invocations in detail.

In general I think it's an excellent contribution, not sure though if we should have the aspiration to keep this documention the code (with names and so many details) up-to-date.

I would like to see @gerlitmcoding input on this. From my end, I would approve.

As discussed one by one with @nicoprow it is good as you did it @fabiodmota. We will not update every change that comes with every pull request. We will check for each new "release/arc42" if the information are still up-to-date.