Feat: Add --path Option to Target Specific Schema Parts in validate Command

[Karan-Palan]

What kind of change does this PR introduce?

• Feature: Added support for the --path (or -p) option in the validate command to allow targeting specific parts of a JSON schema using JSON Pointers.

Issue Number:

• Closes Add a --path option to commands like validate #218

Screenshots/videos:

Screencast.from.2025-02-02.12-53-07.webm

If relevant, did you update the documentation?

Not yet

Summary

This PR introduces the --path (-p) option to the validate command, enabling users to specify a JSON Pointer for validating a sub-schema within a larger JSON schema. This is especially useful for OpenAPI specs and complex JSON structures where validation may be needed for specific nested sections.

Key changes:

• Added --path/-p option to CLI parser.
• Integrated JSON Pointer resolution to extract the specified sub-schema.
• Added error handling for invalid pointers or sub-schemas.

Does this PR introduce a breaking change?

• No breaking changes. The new option is fully backward-compatible. Existing workflows without the --path option will continue to function as expected.

[jviotti]

Awesome! Great first step. Can you fix the formatting issues and add a couple of test cases (at least one where the pointer exists and one where it doesn't)?

[Karan-Palan]

Awesome! Great first step. Can you fix the formatting issues and add a couple of test cases (at least one where the pointer exists and one where it doesn't)?

Thanks!
I fixed the linting errors - they were because my clang default was set to chromium's source. I also added some tests and docs (it's my first time writing tests in shell :p)
Please review when you get the time!

[jviotti]

@Karan-Palan I think you forgot to actually register the tests, so they are not really running right now. You can do so like this:

diff --git a/test/CMakeLists.txt b/test/CMakeLists.txt
index 0f9840b..a3baa6d 100644
--- a/test/CMakeLists.txt
+++ b/test/CMakeLists.txt
@@ -74,6 +74,8 @@ add_jsonschema_test_unix(validate/pass_many_verbose)
 add_jsonschema_test_unix(validate/fail_many)
 add_jsonschema_test_unix(validate/fail_many_verbose)
 add_jsonschema_test_unix(validate/fail_yaml)
+add_jsonschema_test_unix(validate/pass_pointer_exists)
+add_jsonschema_test_unix(validate/fail_pointer_not_exists)

 # Metaschema
 add_jsonschema_test_unix(metaschema/pass_trace)

With that, running make does reveal a test failure!

[jviotti]

I believe options.at("p") and options.at("path") will give you what you want? Look at how we take options in other commands, like for --resolve

[jviotti]

Instead of accessing a subschema of the schema, to make the test more representative, can you make the schema a very concise OpenAPI spec (in JSON) and access one of its schema components?

[jviotti]

Minor thing, but other commands call this prelude clean. Can you do the same for consistency?

[jviotti]

Also, you don't need the explicit if check. Because of set -o errexit, the entire script will fail if any of its commands fail. See how we do it for other "pass" tests

[jviotti]

No need to print these things. ctest will already nicely report the specific test cases

[jviotti]

Can you also add a test where the JSON Pointer passed to --path is indeed valid, but it's not an actual schema? Maybe /type or something like that?