proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-07 07:48:07 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: add guidance for CLI cmds that output JSON

Browse Source 
Signed-off-by: Christian Hopps <chopps@labn.net>
This commit is contained in:
Christian Hopps 2023-01-03 07:22:28 -05:00
parent f6328b3d85
commit b44b66c7bf
2 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/developer/cli.rst
View File

@ -106,6 +106,11 @@ convention. Please do not scatter individual CLI commands in the middle of
source files; instead expose the necessary functions in a header and place the source files; instead expose the necessary functions in a header and place the
command definition in a ``*_vty.[ch]`` file. command definition in a ``*_vty.[ch]`` file.
.. note::
Please see :ref:`cli-workflow` for requirements when creating CLI commands
(e.g., JSON structure and formatting).
Definition Grammar Definition Grammar
^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^
FRR uses its own grammar for defining CLI commands. The grammar draws from FRR uses its own grammar for defining CLI commands. The grammar draws from

18
doc/developer/workflow.rst
View File

@ -1308,6 +1308,8 @@ is to correctly set up `LD_LIBRARY_PATH` so that libraries from the build tree
are used. (On some systems, `libtool` is also available from PATH, but this is are used. (On some systems, `libtool` is also available from PATH, but this is
not always the case.) not always the case.)
.. _cli-workflow:
CLI changes CLI changes
----------- -----------
@ -1374,9 +1376,23 @@ the development mailing list / public Slack instance.
JSON Output JSON Output
^^^^^^^^^^^ ^^^^^^^^^^^
* All JSON keys are to be camelCased, with no spaces New JSON output in FRR needs to be backed by schema, in particular a YANG model.
When adding new JSON, first search for an existing YANG model, either in FRR or
a standard model (e.g., IETF) and use that model as the basis for any JSON
structure and *especially* for key names and canonical values formats.
If no YANG model exists to support the JSON then an FRR YANG model needs to be
added to or created to support the JSON format.
* All JSON keys are to be ``camelCased``, with no spaces. YANG modules almost
always use ``kebab-case`` (i.e., all lower case with hyphens to separate
words), so these identifiers need to be mapped to ``camelCase`` by removing
the hyphen (or symbol) and capitalizing the following letter, for
example "router-id" becomes "routerId"
* Commands which output JSON should produce ``{}`` if they have nothing to * Commands which output JSON should produce ``{}`` if they have nothing to
display display
* In general JSON commands include a ``json`` keyword typically at the end of
the CLI command (e.g., ``show ip ospf json``)
Use of const Use of const
^^^^^^^^^^^^ ^^^^^^^^^^^^