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.

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

Update Metaschema Syntax Documentation to Refer to Token Types, Not IDs #238

Closed
1 of 4 tasks
Tracked by #329
aj-stein-nist opened this issue Sep 16, 2022 · 3 comments · Fixed by #329
Closed
1 of 4 tasks
Tracked by #329

Update Metaschema Syntax Documentation to Refer to Token Types, Not IDs #238

aj-stein-nist opened this issue Sep 16, 2022 · 3 comments · Fixed by #329
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@aj-stein-nist
Copy link
Collaborator

aj-stein-nist commented Sep 16, 2022

User Story:

As a NIST OSCAL developer, in order to properly understand JSON enhancement features, I would like to have clearer documentation about key, ID, and the appropriate Metaschema types.

Goals:

  • Update the following section and additional relevant references on the syntax page.

To support this, flags used as addresses should be declared as type ID, providing "an extra layer of protection". On the JSON side, validating the uniqueness of these values (on same-named properties across document scope) remains TBD.

Dependencies:

{Describe any previous issues or related work that must be completed to start or complete this issue.}

Acceptance Criteria

  • All website and readme documentation affected by the changes in this issue have been updated. Changes to the website can be made in the docs/content directory of your branch.
  • A Pull Request (PR) is submitted that fully addresses the goals of this User Story. This issue is referenced in the PR.
  • The CI-CD build process runs without any reported errors on the PR. This can be confirmed by reviewing that all checks have passed in the PR.

{The items above are general acceptance criteria for all User Stories. Please describe anything else that must be completed for this issue to be considered resolved.}

@aj-stein-nist aj-stein-nist added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 16, 2022
@aj-stein-nist
Copy link
Collaborator Author

Per discussion with team reorganization, I will move this Metaschema issue off the NIST OSCAL workboard.

@aj-stein-nist
Copy link
Collaborator Author

I recommend we include this for a release before or latest as a part of 1.0.0 release.

@david-waltermire david-waltermire added this to the Metaschema 0.9.0 milestone Feb 10, 2023
@david-waltermire david-waltermire linked a pull request Mar 10, 2023 that will close this issue
16 tasks
@david-waltermire
Copy link
Collaborator

Addressed by PR #329.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants