Skip to content

Task/3 24 2026 json schema for filters documentation edition#1682

Open
emily-howell wants to merge 28 commits intotask/3_19_2026-json-schema-for-filters-extended-editionfrom
task/3_24_2026-json-schema-for-filters-documentation-edition
Open

Task/3 24 2026 json schema for filters documentation edition#1682
emily-howell wants to merge 28 commits intotask/3_19_2026-json-schema-for-filters-extended-editionfrom
task/3_24_2026-json-schema-for-filters-documentation-edition

Conversation

@emily-howell
Copy link
Copy Markdown
Member

@emily-howell emily-howell commented Mar 27, 2026

This PR adds documentation and some final touches to the work completed in #1676 and #1663 and should be merged after them

@emily-howell emily-howell self-assigned this Mar 27, 2026
…' of github.com:Alpine-DAV/ascent into task/3_24_2026-json-schema-for-filters-documentation-edition
…' of github.com:Alpine-DAV/ascent into task/3_24_2026-json-schema-for-filters-documentation-edition
…' of github.com:Alpine-DAV/ascent into task/3_24_2026-json-schema-for-filters-documentation-edition
@emily-howell emily-howell marked this pull request as ready for review March 30, 2026 23:07
Copy link
Copy Markdown
Member

@cyrush cyrush left a comment

Choose a reason for hiding this comment

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

pass with a few of my suggestions


Each helper returns a Conduit node that represents a schema fragment (see :ref:`param_schema`).
These fragments are typically inserted under ``param_schema["properties/<param_name>"]``.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

if we change to ref style args, we will need to update these docs

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I updated these docs to reflect the updated access pattern.


.. code-block:: c++

conduit::Node string_enum_schema(std::vector<std::string> options);
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

prefer const string ref vector

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Updated to be conduit::Node &string_enum_schema(conduit::Node &schema_node, const std::vector<std::string> &options)

Parameter Schemas for Validation and Surprise Checking
======================================================

The schema validator supports a focused subset of JSON Schema, along with a few Conduit-specific extensions under constraints.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

add link to json schema web resources

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Link added specifically to the top level references page: https://json-schema.org/understanding-json-schema/reference

…' of github.com:Alpine-DAV/ascent into task/3_24_2026-json-schema-for-filters-documentation-edition
…' of github.com:Alpine-DAV/ascent into task/3_24_2026-json-schema-for-filters-documentation-edition
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.

2 participants