Remove operational state from PUT request#2359
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @ihrasko, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request refines an example in the documentation to accurately reflect the capabilities of RESTCONF. It removes an attempt to configure operational state data, which is not permissible through RESTCONF, ensuring that users are provided with correct and functional examples for interacting with network devices.
Highlights
- Corrected RESTCONF PUT Example: The example PUT request in the
README.mdfor thelighty-gnmi-community-restconf-apphas been updated to remove the configuration of the 'state' container. - Adherence to YANG Model: The 'state' container is marked as
config falsein the corresponding YANG model, meaning it represents operational data and cannot be modified via RESTCONF PUT requests. This change ensures the example is accurate.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Code Review
This pull request correctly removes the attempt to configure operational state data from a PUT request example in the README.md. This is a valid fix as operational data is read-only. However, this change introduces inconsistencies in the documentation and the associated Postman collection. The text in the README.md describing the example still mentions modifying state, and the Postman collection itself has not been updated. Please see the detailed comment for the necessary changes in the README.md and also update the Postman collection to match.
Remove configuration of "state" container from GNMI example PUT requests because its marked as config false in corresponding YANG model. We cannot modify operational data using RESTCONF. GH issue: PANTHEONtech#2358 Signed-off-by: Ivan Hrasko <[email protected]>
Remove configuration of "state" container from GNMI example PUT requests because its marked as config false in corresponding YANG model.
We cannot modify operational data using RESTCONF.
GH issue: #2358