Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update entity address scheme in documentation #142

Closed
Flix6x opened this issue Jun 8, 2021 · 2 comments
Closed

Update entity address scheme in documentation #142

Flix6x opened this issue Jun 8, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Flix6x
Copy link
Contributor

Flix6x commented Jun 8, 2021

Docstrings of all API endpoints that mention entity addresses should be updated to describe the fm scheme. For example, here is an excerpt from the postMeterData documentation:

"connections": [
    "CS 1",
    "CS 3"
],

I propose to use the fm0 scheme in documentation of API endpoint versions preceding version 2.0. I'm on the fence if we should already be documenting fm1 for version 2.0. Given that the control endpoints (getDeviceMessage, postUdiEvent) are not part of fm1 yet, this would result in mixed documentation.

@Flix6x
Copy link
Contributor Author

Flix6x commented Jan 5, 2022

This has gotten some attention in #290, in which at least the documentation for API version 2.0 has been updated, indeed, with mixed documentation.

@Flix6x Flix6x added the documentation Improvements or additions to documentation label Jan 5, 2022
@Flix6x
Copy link
Contributor Author

Flix6x commented Nov 15, 2022

We will leave the documentation for API versions 1.0 to 1.3 as is, since they will be deprecated soon.

@Flix6x Flix6x closed this as completed Nov 15, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant