Please check if the PR fulfills these requirements
[x] The commit message follows our guidelines
[x] Tests for the changes have been added (for bug fixes / features)
[ ] Docs have been added / updated (for bug fixes / features)
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
Feature
What is the current behavior?
What is the new behavior (if this is a feature change)?
Add model documentation 'doc' field in JSON
Documentation is accessible from models builder and itools
Rename lib (or tag event model) to modelName when lib or alias is used :
lib now refers exclusively to the library name used by Dynawo
modelName/name is the name used in powsybl-dynawo in builders and suppliers and DSL i.e. an alias if it exists or the lib value
Does this PR introduce a breaking change or deprecate an API?
[x] Yes
[ ] No
If yes, please check if the following requirements are fulfilled
[x] The Breaking Change or Deprecated label has been added
[x] The migration steps are described in the following section
What changes might users need to make in their application due to this PR? (migration steps)
Replace every builders getSupportedLibs with getSupportedModelInfos:
getSupportedModelInfos returns a collection of ModelInfo
the name of the supported libs (model name) is returned by ModelInfo::name
Replace BuilderConfiggetLibs with getModelInfos.
Replace every event builders getTag with getModelName and add a static getEventModelInfo
Replace EventBuilderConfiggetTag with getEventModelInfo.
Please check if the PR fulfills these requirements
Does this PR already have an issue describing the problem?
No
What kind of change does this PR introduce?
Feature
What is the current behavior?
What is the new behavior (if this is a feature change)? Add model documentation 'doc' field in JSON Documentation is accessible from models builder and itools Rename
lib
(ortag
event model) tomodelName
whenlib
oralias
is used :lib
valueDoes this PR introduce a breaking change or deprecate an API?
If yes, please check if the following requirements are fulfilled
What changes might users need to make in their application due to this PR? (migration steps)
Replace every builders
getSupportedLibs
withgetSupportedModelInfos
:getSupportedModelInfos
returns a collection ofModelInfo
ModelInfo::name
ReplaceBuilderConfig
getLibs
withgetModelInfos
.Replace every event builders
getTag
withgetModelName
and add a staticgetEventModelInfo
ReplaceEventBuilderConfig
getTag
withgetEventModelInfo
.