Skip to content

feat: validation settings docs#342

Merged
akijakya merged 5 commits intomainfrom
feat/validation-settings-docs
Jan 27, 2026
Merged

feat: validation settings docs#342
akijakya merged 5 commits intomainfrom
feat/validation-settings-docs

Conversation

@akijakya
Copy link
Member

@akijakya akijakya commented Jan 12, 2026

Added docs to OASF with a comparison table about the API and json schema validators (behavior in different cases)
Added docs on how to configure validation for directory server
Extended docs for oasf-sdk with new validation settings

Closes #349

@akijakya akijakya force-pushed the feat/validation-settings-docs branch from 9d668e1 to 3720ab9 Compare January 13, 2026 17:21
@akijakya akijakya marked this pull request as ready for review January 13, 2026 17:27
@akijakya akijakya requested a review from a team as a code owner January 13, 2026 17:27
@akijakya akijakya requested review from jparello and removed request for a team January 13, 2026 17:27
@keraron keraron self-requested a review January 13, 2026 17:28
@akijakya akijakya marked this pull request as draft January 15, 2026 09:13
@akijakya akijakya force-pushed the feat/validation-settings-docs branch from 3720ab9 to 4d43cb9 Compare January 23, 2026 14:15
@akijakya akijakya marked this pull request as ready for review January 23, 2026 14:15
### Environment Variable

```bash
DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL=https://schema.oasf.outshift.com ./dirctl-apiserver
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL=https://schema.oasf.outshift.com ./dirctl-apiserver
DIRECTORY_SERVER_OASF_API_VALIDATION_SCHEMA_URL=https://schema.oasf.outshift.com

is this okay because it has some suffix?

Copy link
Member Author

Choose a reason for hiding this comment

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

I replaced it with task server:start

@@ -0,0 +1,99 @@
# Validation Comparison: API Validator vs JSON Schema Draft-07
Copy link
Member

@ramizpolic ramizpolic Jan 23, 2026

Choose a reason for hiding this comment

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

this might be interesting for a blog-post as well

Signed-off-by: András Jáky <ajaky@cisco.com>
Signed-off-by: András Jáky <ajaky@cisco.com>
Signed-off-by: András Jáky <ajaky@cisco.com>
@akijakya akijakya force-pushed the feat/validation-settings-docs branch from 4d43cb9 to d74fbf3 Compare January 23, 2026 16:57
Signed-off-by: Aron Kerekes <arkereke@cisco.com>
Signed-off-by: András Jáky <ajaky@cisco.com>
@akijakya akijakya merged commit 31ffb2a into main Jan 27, 2026
6 checks passed
@akijakya akijakya deleted the feat/validation-settings-docs branch January 27, 2026 14:48
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

Successfully merging this pull request may close these issues.

Document different ways of validating records and their implications

3 participants