docs(oasf): taxonomy and schema validator updates#483
Open
akijakya wants to merge 2 commits into
Open
Conversation
Member
akijakya
commented
May 26, 2026
akijakya
commented
- updated contribution guide with latest changes on how the taxonomy gets created from the json files.
- updated validation comparison since the json draft-07 schema generator got updated (feat(server): json schema generator maxLength and pattern constraints oasf#464)
Signed-off-by: András Jáky <ajaky@cisco.com>
agntcy/oasf#464 Signed-off-by: András Jáky <ajaky@cisco.com>
There was a problem hiding this comment.
Pull request overview
Updates OASF documentation to reflect recent taxonomy/category creation changes and align the validator behavior comparison with updated JSON Schema generation output.
Changes:
- Updated validation comparison to reflect that regex
patternconstraints now fail JSON Schema validation (while API treats them as warnings). - Updated contributing guide to describe category creation via
"category": trueon class JSON files and adjusted extension directory guidance accordingly.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/oasf/validation-comparison.md | Updates the comparison table and summary sections to reflect stricter JSON Schema behavior for regex patterns and inherited max length. |
| docs/oasf/contributing.md | Updates contributor guidance on taxonomy/category creation and extension layout, including marking categories via a class JSON property. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| An attribute is the more generic name for both fields and entities in OASF. | ||
| A field is a scalar attribute while an entity is a complex attribute. | ||
| - **Category:** A Category organizes classes that represent a particular domain. | ||
| - **Category:** A Category organizes classes that represent a particular domain. Categories are marked by adding `category: true` to a class JSON file and can be created at any level of the taxonomy tree. |
Comment on lines
+398
to
+403
| | `skills` | Create it to define new skill classes. Categories are created by | | ||
| | | adding `"category": true` to a skill class JSON file. | | ||
| | `domains` | Create it to define new domain classes. Categories are created by | | ||
| | | adding `"category": true` to a domain class JSON file. | | ||
| | `modules` | Create it to define new module classes. Categories are created by | | ||
| | | adding `"category": true` to a module class JSON file. | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.