Skip to content

fix: correct schema documentation errors#1758

Merged
ivan-aksamentov merged 6 commits intomasterfrom
docs/schema-docs-2
Mar 5, 2026
Merged

fix: correct schema documentation errors#1758
ivan-aksamentov merged 6 commits intomasterfrom
docs/schema-docs-2

Conversation

@ivan-aksamentov
Copy link
Copy Markdown
Member

@ivan-aksamentov ivan-aksamentov commented Mar 5, 2026

Fix documentation errors discovered during schema review: incorrect enum values, stale TODOs, missing fields, and wrong field types.

  • Use cdsName instead of geneName in QC examples
  • Replace stale aaMutLabelMap TODO with actual documentation
  • Correct searchAlgo enum value ancestor-latest to ancestor-nearest
  • Mark clade_node_attrs displayName as required per schema
  • Add missing fields to pathogen config documentation
  • Correct ref_nodes field types and add missing qry[].name
  1. Depends on: docs: add documentation comments to JSON schema types #1757
  2. Related to: fix: correct documentation errors in dataset guides nextclade_data#415

geneName was renamed to cdsName in the v2-to-v3 migration.
- Add aaMutLabelMap example to mutLabels JSON snippet
- Fix pathogenJson -> pathogen.json typo
- Clarify files field is required for datasets, not by schema
- Add includeNearestNodeInfo to generalParams
- Add deletion weight fields to privateMutations example
- Document alignmentPreset field and fix missing closing parenthesis
- Change qry and node from "object" to "array of objects" per schema
- Add [] notation to sub-field paths for consistency
- Document qry[].name field
@github-actions
Copy link
Copy Markdown

github-actions bot commented Mar 5, 2026

Base automatically changed from docs/schema-docs-1 to master March 5, 2026 02:59
@ivan-aksamentov ivan-aksamentov merged commit bfa730a into master Mar 5, 2026
35 of 37 checks passed
@ivan-aksamentov ivan-aksamentov deleted the docs/schema-docs-2 branch March 5, 2026 02:59
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.

1 participant