doc: Update json handling specification in workflow.rst#21244
Merged
choppsv1 merged 1 commit intoFRRouting:masterfrom Mar 24, 2026
Merged
doc: Update json handling specification in workflow.rst#21244choppsv1 merged 1 commit intoFRRouting:masterfrom
choppsv1 merged 1 commit intoFRRouting:masterfrom
Conversation
Community members keep creating json output that includes `warning` or `error` if the specified data does not exist. Add a bit more verbiage to also specifically call out error situations as well. Signed-off-by: Donald Sharp <sharpd@nvidia.com>
Greptile SummaryThis PR updates the JSON handling specification in
Confidence Score: 4/5
Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[JSON CLI Command Invoked] --> B{Input valid?}
B -- No --> E[Output empty JSON object]
B -- Yes --> C{Data available?}
C -- No --> E
C -- Yes --> D[Output populated JSON object]
Prompt To Fix All With AIThis is a comment left during a code review.
Path: doc/developer/workflow.rst
Line: 1664
Comment:
**Typo: "ocurrs" should be "occurs"**
The word `ocurrs` is misspelled — it should be `occurs` (one `c`, two `r`s is wrong; it's one `c`, one `r`).
```suggestion
display or if an error occurs with the input.
```
How can I resolve this? If you propose a fix, please make it concise.Last reviewed commit: "doc: Update json han..." |
| example "router-id" becomes "routerId" | ||
| * Commands which output JSON should produce ``{}`` if they have nothing to | ||
| display | ||
| display or if an error ocurrs with the input. |
There was a problem hiding this comment.
Typo: "ocurrs" should be "occurs"
The word ocurrs is misspelled — it should be occurs (one c, two rs is wrong; it's one c, one r).
Suggested change
| display or if an error ocurrs with the input. | |
| display or if an error occurs with the input. |
Prompt To Fix With AI
This is a comment left during a code review.
Path: doc/developer/workflow.rst
Line: 1664
Comment:
**Typo: "ocurrs" should be "occurs"**
The word `ocurrs` is misspelled — it should be `occurs` (one `c`, two `r`s is wrong; it's one `c`, one `r`).
```suggestion
display or if an error occurs with the input.
```
How can I resolve this? If you propose a fix, please make it concise.
Member
Author
|
ci:rerun |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Community members keep creating json output that includes
warningorerrorif the specified data does not exist. Add a bit more verbiage to also specifically call out error situations as well.