Skip to content

client-api: fix misspelled neighborhood setting keys in G_API_SETTINGS #197

Description

@lmeyerov

Summary

client-api has misspelled neighborhood setting keys in G_API_SETTINGS, while adjacent docs/comments and client-api-react use the correctly spelled names.

Evidence

  • Misspelled keys in projects/client-api/src/index.js:
    • neighbhorhoodHighlight at line 1199
    • neighbhorhoodHighlightHops at line 1200
  • Same file docs/comments use correct spellings:
    • neighborhoodHighlight and neighborhoodHighlightHops around lines 1247-1248
  • client-api-react bindings use correct spellings:
    • projects/client-api-react/src/bindings.js lines 15-16

Why this matters

Consumers calling updateSetting() with correctly spelled keys may fail or behave unexpectedly due to cross-surface naming inconsistency.

Requested fix

  1. Add correctly spelled keys to G_API_SETTINGS:
    • neighborhoodHighlight
    • neighborhoodHighlightHops
  2. Keep misspelled keys as temporary aliases for backward compatibility:
    • neighbhorhoodHighlight
    • neighbhorhoodHighlightHops
  3. Emit deprecation warning when misspelled aliases are used.
  4. Add tests ensuring both spellings resolve to identical model paths.
  5. Update changelog/docs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions