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

Formalize documentation of json-key json-key-value #316

Open
3 tasks
nikitawootten-nist opened this issue Feb 10, 2023 · 0 comments
Open
3 tasks

Formalize documentation of json-key json-key-value #316

nikitawootten-nist opened this issue Feb 10, 2023 · 0 comments
Assignees
Labels
enhancement New feature or request specification Improvements or additions to the specification

Comments

@nikitawootten-nist
Copy link
Contributor

User Story:

As a Metaschema implementor, I need formal documentation as to the expected parsing behavior for Metaschema features, so that I can create interoperable systems that are compatible with Metaschema.

Goals:

Following a thread on Gitter, several underspecified capabilities were surfaced for formal documentation:

  • Parsing behavior for JSON document instance Field with a json-key-value @flag-name:
    • Do multiple extraneous properties yield an error? (leading to potential ambiguity or malicious misuse)
    • Is a simple field (no normal flags) with a json-key-value or value @flag-name valid?
  • Do json-key-value flags and json-value flags cause a given Field to be considered not simple?
    • In the Java implementation this is no, but "simple" seems to be distinct from "promotable"
  • How do json-key and json-key-value interact with collapsibility?
  • How is an assembly meant to be parsed if more then one child has a json-key flag?

Dependencies:

N/A

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request specification Improvements or additions to the specification
Projects
None yet
Development

No branches or pull requests

2 participants