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

Additional metaschemas #867

Merged
merged 21 commits into from
Dec 7, 2023
Merged

Conversation

alanisaac
Copy link
Contributor

@alanisaac alanisaac commented Nov 22, 2023

Related Issue:

Part of #735

These metaschemas have been tested against a version of the ocsf-validator based on this PR: ocsf/ocsf-validator#3. As a result, the following issues were found:

These should be resolved before merging this PR.

Description of changes:

This PR implements additional metaschemas for:

  • categories
  • dictionary
  • extension
  • include
  • profile

It also adds the following attributes:

  • @deprecated
  • sibling

And refactors the $include attribute to be more reusable, updating it as a result of #791 / #792.

Finally, it adds additional constraints on attribute names according to the spec, as well as a description to the existing object and event types (and all new metaschemas). Descriptions of types and properties are quoted or paraphrased from either the https://github.com/ocsf/ocsf-docs repository or from documentation in this repository.

@alanisaac alanisaac added enhancement New feature or request non_breaking Non Breaking, backwards compatible changes labels Nov 22, 2023
metaschema/semver.schema.json Show resolved Hide resolved
metaschema/extension.schema.json Show resolved Hide resolved
metaschema/attribute.schema.json Outdated Show resolved Hide resolved
@alanisaac
Copy link
Contributor Author

@floydtree I think your comments are resolved, with the note that I have two follow-ups:

  • the v for semver versions, and fixing existing usages
  • making the requirement field required, and fixing existing gaps

Copy link
Contributor

@dkolbly dkolbly left a comment

Choose a reason for hiding this comment

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

Huge progress 🚀

@mikeradka mikeradka merged commit d72f6a0 into ocsf:main Dec 7, 2023
2 checks passed
@floydtree floydtree added the v1.1.0 Changes marked for v1.1.0 of OCSF label Jan 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request non_breaking Non Breaking, backwards compatible changes v1.1.0 Changes marked for v1.1.0 of OCSF
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants