Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Generate] Generate comments from schema descriptions #27

Open
brandtkeller opened this issue Sep 20, 2023 · 1 comment
Open

[Generate] Generate comments from schema descriptions #27

brandtkeller opened this issue Sep 20, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@brandtkeller
Copy link
Member

Investigate the possibility of generating comments per struct/field that could simply be the description for the item as it exists in the oscal schema.
@brandtkeller brandtkeller added the enhancement New feature or request label Sep 20, 2023
@mike-winberry mike-winberry added this to the OSCAL Version Updates milestone Dec 11, 2023
@mike-winberry mike-winberry changed the title Generate comments from schema descriptions [Generate] Generate comments from schema descriptions Dec 11, 2023
@mike-winberry
Copy link
Collaborator

mike-winberry commented Feb 7, 2024 •
edited
Loading

Potential things to bring in:

  • description as comment over struct
    • oneOf, anyOf, allOf descriptor?
    • what about fields? should we get that narrow
  • tags?
    • regex
    • restrictions/enum
    • min/max
    • etc

@mike-winberry mike-winberry added documentation Improvements or additions to documentation good first issue Good for newcomers labels Feb 7, 2024
@mike-winberry mike-winberry removed this from the OSCAL Version Updates milestone Feb 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Lula and Friends
Status: 🔖 Ready
Milestone
No milestone
Development

No branches or pull requests
2 participants
@brandtkeller @mike-winberry