Skip to content

[yang]Adding a tool for generating documentation based on yang model #34

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

Closed
wants to merge 10 commits into from

Conversation

dgsudharsan
Copy link
Owner

Why I did it

Added a tool to generate configuration based on yang model

How I did it

Parse the yang model and create documentation based on description field.

How to verify it

Added UT to verify it.

Which release branch to backport (provide reason below if selected)

  • 201811
  • 201911
  • 202006
  • 202012
  • 202106
  • 202111

Description for the changelog

Link to config_db schema for YANG module changes

A picture of a cute animal (not mandatory but encouraged)

Copy link

@stepanblyschak stepanblyschak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not part of sonic-utilities?

@dgsudharsan
Copy link
Owner Author

Why not part of sonic-utilities?

The documentation of the config_db schema is under sonic-buildimage inside the yang folder. I am planning to propose this tool to replace the config schema and may be to even auto generate it and replace the config schema inside yang folder. Hence logically i thought it is better to have this tool in sonic-yang-mgmt. Let me know your view

@dgsudharsan dgsudharsan deleted the yang_help branch March 9, 2023 01:49
dgsudharsan pushed a commit that referenced this pull request Mar 7, 2025
…sonic-net#21818)

#### Why I did it
src/dhcpmon
```
* 2519a88 - (HEAD -> 202411, origin/202411) Merge pull request #34 from yaqiangz/202411_dhcpmon_bootp (2 days ago) [Kumaresh Perumal]
* 3e58f23 - Fix counting bootp packets by mistake (#31) (3 days ago) [Yaqiang Zhu]
```
#### How I did it
#### How to verify it
#### Description for the changelog
dgsudharsan pushed a commit that referenced this pull request Mar 17, 2025
…lly (sonic-net#634)

#### Why I did it
src/sonic-swss
```
* b2a7b03 - (HEAD -> 202412, origin/202412) [code sync] Merge code from sonic-net/sonic-swss:202411 to 202412 (#36) (7 hours ago) [mssonicbld]
* 84485cd - [code sync] Merge code from sonic-net/sonic-swss:202411 to 202412 (#35) (31 hours ago) [mssonicbld]
* 6e83557 - [code sync] Merge code from sonic-net/sonic-swss:202411 to 202412 (#34) (2 days ago) [mssonicbld]
```
#### How I did it
#### How to verify it
#### Description for the changelog
dgsudharsan pushed a commit that referenced this pull request Mar 17, 2025
… automatically (sonic-net#672)

#### Why I did it
src/sonic-platform-common
```
* 26e5980 - (HEAD -> 202412, origin/202412) [code sync] Merge code from sonic-net/sonic-platform-common:202411 to 202412 (#34) (55 minutes ago) [mssonicbld]
```
#### How I did it
#### How to verify it
#### Description for the changelog
dgsudharsan pushed a commit that referenced this pull request Mar 17, 2025
…tomatically (sonic-net#853)

#### Why I did it
src/sonic-linux-kernel
```
* c2f3387 - (HEAD -> 202412, origin/HEAD, origin/202412) [code sync] Merge code from sonic-net/sonic-linux-kernel:202411 to 202412 (#34) (21 hours ago) [mssonicbld]
```
#### How I did it
#### How to verify it
#### Description for the changelog
dgsudharsan pushed a commit that referenced this pull request Mar 17, 2025
…omatically (sonic-net#878)

#### Why I did it
src/sonic-swss-common
```
* 97af2db - (HEAD -> 202412, origin/HEAD, origin/202412) [FC] remove FLEX_COUNTER_DELAY_STATUS_FIELD (sonic-net#982) (#34) (21 hours ago) [mssonicbld]
```
#### How I did it
#### How to verify it
#### Description for the changelog
dgsudharsan pushed a commit that referenced this pull request Mar 31, 2025
…tically (sonic-net#22051)

#### Why I did it
src/sonic-dash-api
```
* 5c5aa8a - (HEAD -> master, origin/master, origin/HEAD) Add outbound_direction_lookup to dash appliance table (#32) (7 days ago) [prabhataravind]
* a662860 - Add tunnel field to route message (#34) (8 days ago) [Lawrence Lee]
```
#### How I did it
#### How to verify it
#### Description for the changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants