Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix missing validation bug in names rules #277

Merged
merged 1 commit into from
Sep 17, 2024
Merged

Conversation

vcschapp
Copy link
Collaborator

@vcschapp vcschapp commented Sep 11, 2024

Category

What kind of change is this?
Please select one of the following four options.
Consult Pull request merging criteria for a description of each category.

  1. Cosmetic change.
  2. Documentation change by member.
  3. Documentation change by Overture tech writer.
  4. Material change.

Description

Brief description of the business purpose and effect of the pull request.

Fixes a bug noted by @DavidKarlas where the schema didn't require entries under names.rules to have a variant. This was an omission, as all name rules need a variant.

Reference

List of relevant links to GitHub issues, PRs, and other documentation.

  1. https://github.com/OvertureMaps/schema-wg/issues/324

Testing

Brief description of the testing done for this change showing why you are confident it works as expected and does not introduce regressions. Provide sample output data where appropriate.

  1. Ran the example tests.
  2. Verified that the last three months of releases pass the validation.

See the test SQL below run in Amazon Athena.

SELECT 'v2024_06_13_beta_0' AS version, type, id, names
  FROM v2024_06_13_beta_0
 WHERE any_match(names.rules, rule -> rule.variant IS NULL)

UNION ALL

SELECT 'v2024_06_13_beta_1' AS version, type, id, names
  FROM v2024_06_13_beta_1
 WHERE any_match(names.rules, rule -> rule.variant IS NULL)

UNION ALL

SELECT 'v2024_07_22_0' AS version, type, id, names
  FROM v2024_07_22_0
 WHERE any_match(names.rules, rule -> rule.variant IS NULL)

UNION ALL

SELECT 'v2024_08_20_0' AS version, type, id, names
  FROM v2024_08_20_0
 WHERE any_match(names.rules, rule -> rule.variant IS NULL)

Checklist

Checklist of tasks commonly-associated with schema pull requests. Please review the relevant checklists and ensure you do all the tasks that are required for the change you made.

  1. Add relevant examples.
  2. Add relevant counterexamples.
  3. Update any counterexamples that became obsolete. For example, if a counterexample uses property A but is not intended to test property A's validity, and you made a schema change that invalidates property A in that counterexample, fix the counterexample to align it with your schema change.
  4. Update in-schema documentation using plain English written in complete sentences, if an update is required.
  5. Update Docusaurus documentation, if an update is required.
  6. Review change with Overture technical writer to ensure any advanced documentation needs will be taken care of, unless the change is trivial and would not affect the documentation.

Documentation Website

Update the hyperlink below to put the pull request number in.

Docs preview for this PR.

@vcschapp vcschapp merged commit 7940920 into dev Sep 17, 2024
2 checks passed
@vcschapp vcschapp deleted the fix_names_rules_validation branch September 17, 2024 14:10
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.

4 participants