llnl / llnl/conduit

multiple levels of blueprint verification

Open
#536 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

design feature
Dominant language
C++
Stars
248
Forks
72
Avg merge
1d 16h
Merged PRs (30d)
15

Description

The design philosophy behind all of the curent conduit::blueprint::verify functions has been to approach the problem of schema validation from a data-agnostic perspective. While this makes validation straightforward and efficient, it excludes a number of more thorough checks that could be performed to more confidently report the validity of a given Blueprint hierarchy (e.g. entries in the topology and adjsets section could have their index values bounds-checked against the length of the associated coordset), which will become more relevant as the data becomes more complex (see #511, #513). These checks could be included conditionally based on user preferences, which would require adding a parameter to the conduit::blueprint::verify function to indicate a "level" of thoroughness.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the existing conduit::blueprint::verify functions and the related discussions in #511 and #513. Define the verification levels and the scope of checks such as topology and adjsets index bounds before deciding how the API should expose them; done means the level semantics and affected checks are agreed.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.