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

Standard inconsistency about tag attribute #442

Open
braingram opened this issue Aug 26, 2024 · 0 comments
Open

Standard inconsistency about tag attribute #442

braingram opened this issue Aug 26, 2024 · 0 comments

Comments

@braingram
Copy link
Contributor

The schema information docs mention:
https://asdf-standard.readthedocs.io/en/1.1.1/schemas.html#schema-implementation

The following top-level attributes are required for all ASDF schemas:

  • $schema: Indicates the metaschema definition used to validate this schema
  • id: A name that uniquely identifies the schema
  • tag: The YAML tag corresponding to the type described by this schema

However, later on the same page
https://asdf-standard.readthedocs.io/en/1.1.1/schemas.html#tag
the tag attribute is described as optional:

While the id attribute will almost certainly become required in a future version of the ASDF Standard, the tag attribute may remain optional. This is because schemas can be referenced by id without necessarily referring to a particular tagged type in the YAML representation.

Given the work to remove the top level tag attribute (which limits schema re-use). I suggest we remove any description of the top-level tag attribute.

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

No branches or pull requests

2 participants
@braingram and others