OpenEnergyPlatform / OpenEnergyPlatform/open-MaStR
Update docs to reflect deprecated SOAP API as well as the most current data model
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 141
- Forks
- 35
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 5
Description
The docs are inconsistent when it comes to the SOAP API. If its deprecated, it should be marked as such everywhere. Not sure if it is though?
Also, while we are at it, instead of admitting that the table names are confusing, we could attempt at documenting the whole data model better and make it less confusing. The screen shot of the MaStR data model is only partially helpful, as it does not contain the naming conventions of open-mastr. For instance, it does not show where the table basic_units fits in the model, and its not clear what table the box electricity producing units refers to.
Im only partially qualified to do this (I do find the table names confusing), so with some clarificatory support (@FlorianK13 @nesnoj ?) I'd be happy to submit a PR.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by confirming the SOAP API's deprecation status with the maintainers and reviewing the existing documentation and MaStR data-model diagrams. Done means the SOAP API status is consistent everywhere and the data model clearly explains open-MaStR naming conventions, including basic_units and electricity-producing units.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, database, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 45/100