-
-
Notifications
You must be signed in to change notification settings - Fork 389
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
API endpoints for automation and integration #910
Comments
ToDos:
|
remarks: - the format is JSON - it is a "live" and dynamic documentation reflecting the runtime. - it can be retrieved at /manager/v3/api-docs of a running steve instance - only enabled for PROD profile
Hi @goekay, can you please suggest how to contribute to this feature request? I had made an OpenAPI specification for an HTTP REST API and began implementing it through an API controller, but that is WIP and nowhere near completion. However, I had completed adding Swagger UI to SteVe. I would be glad to contribute a few snippets if that is suitable for you. |
The endpoints that had been implemented and manually tested are as follows:
|
hey @anirudh-ramesh, thanks for your work! this feature request and its realisation has a very clear scope, and therefore i would like to keep it that way. while working on this, i am also laying some ground work (such as auth and openapi spec) for further extensions. if you'd like, you are welcome to make a PR (after this is finished and merged) of your impl where your endpoints use the ground work introduced by this one. thanks! |
remarks: - the format is JSON - it is a "live" and dynamic documentation reflecting the runtime. - it can be retrieved at /manager/v3/api-docs of a running steve instance - only enabled for PROD profile
Hi @goekay, great work here, I'm very interested in this feature request. How long do you think it will take to complete it for an usable scenario?. Thanks. |
@frmunozForcast it is usable already ;) |
Hi, is this feature already released or under a specific branch? Thank you! |
hey @iprastha there is no release yet, but you can see the referenced commits above in the respective feature branch. |
@goekay am I right, that the next step is to create a pull request so that the commits can be merged and released? |
yes, that is correct. i am waiting for the testing by and feedback from @kohlerdominik to make a PR and merge it. as far as can see, the feature impl is complete. |
Hi all Sorry for my delay. Just this week I started testing and implementation on our end. I think there are some minor things I want to give as feedback to @goekay, so he can consider wether he want's to adjust them, and after that we're good to go. I will finish feedback until the end of the week. However, by simply checking out the branch 910-api-endpoints-for-automation-and-integration, everyone can already use it. |
@kohlerdominik I tried to but found no documentation on the new APIs. All I found was a configuration option for the API key and token. |
true, that's an area for improvement. i try to write useful commit messages though. you can see that, if you checkout the branch and start steve, the endpoint |
- ignore fields that are irrelevant - deserialization: use ISO pattern for LocalDateTime - serialization: do not write dates as timestamps. use string and ISO pattern instead - throw 422 "Unprocessable Entity" when trying to create an existing ocpp tag - improve query param defaults - improve API spec documentation
…tomation-and-integration PR: API endpoints for automation and integration (#910)
Hey everyone, this feature is merged and part of master branch. Thanks to @enertech-ch for sponsoring the feature, and to @kohlerdominik for the collaboration! |
This feature is awesome and open a lot of new options. Well done 👍 |
@cbrandlehner i added a section about this. is it good enough for you to get started? the majority of the integration work should come from inspecting open-api spec and its capabilities. the documentation is the spec. |
Describe the problem you are trying to solve
We are trying to interact with SteVe with a third party service in a micro service architecture. SteVe should manage the charging points, but we need to extract consumed energy information.
Describe the solution you'd like
If SteVe would provide API-endpoints for relevant information, Machine-to-Machine communication and therefore automation and integration in other systems would be possible.
Three important use cases came to our mind:
Additional context
This feature request was discussed between @goekay and @lextira in a video call, and it was agreed to cover two key features for now:
The text was updated successfully, but these errors were encountered: