[WIP]: feat(bed-4728): Add jsonpointer package as core component for JSON sc… #805
Conversation
This file contains 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
…hema validation
This commit introduces a new `jsonpointer` package that provides utilities for working with JSON Pointers as defined in RFC 6901. This package serves as a precursor and core component for our upcoming JSON schema validator package, laying the groundwork for efficient JSON traversal and manipulation.
Key features:
- Implements a `WalkJSON` function for traversing JSON-like structures
- Supports map[string]any, []any, and uses reflection for other types
- Provides a visitor pattern for custom handling of each element
- Includes comprehensive documentation and usage examples
- Offers extensibility for future enhancements, particularly for JSON schema validation
The 'jsonpointer' package is designed with a clear goal in mind: to balance performance with flexibility. It provides fast paths for common JSON types while supporting complex nested structures. This balance is not just a feature, but a promise of efficiency and adaptability, crucial for implementing efficient JSON schema validation.
Usage example:
```go
data := map[string]any{
"foo": []any{1, 2, 3},
"bar": map[string]any{"baz": "qux"},
}
err := WalkJSON(data, func(elem any) error {
fmt.Printf("Visited: %v\n", elem)
return nil
})
```
REFERENCE: https://specterops.atlassian.net/browse/BED-4728
|
Closing this to discuss the broader initiative of enhancing REST endpoints to validate requests and responses during testing. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
…hema validation
This commit introduces a new
jsonpointerpackage that provides utilities for working with JSON Pointers as defined in RFC 6901. This package serves as a precursor and core component for our upcoming JSON schema validator package, laying the groundwork for efficient JSON traversal and manipulation.Key features:
WalkJSONfunction for traversing JSON-like structuresThe 'jsonpointer' package is designed with a clear goal in mind: to balance performance with flexibility. It provides fast paths for common JSON types while supporting complex nested structures. This balance is not just a feature, but a promise of efficiency and adaptability, crucial for implementing efficient JSON schema validation.
Usage example:
REFERENCE: https://specterops.atlassian.net/browse/BED-4728
Description
Describe your changes in detail
Motivation and Context
This PR addresses: [GitHub issue or Jira ticket number]
Why is this change required? What problem does it solve?
How Has This Been Tested?
Please describe in detail how you tested your changes.
Include details of your testing environment, and the tests you ran to
see how your change affects other areas of the code, etc.
Screenshots (optional):
Types of changes
Checklist: