fix: guard unsupported endpoint searches - #9
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
IGDBSearchableEndpointPathto endpoints actually marked searchableIGDBEndpoint.search()helper reject unsupported endpoint pathsWhy
IGDB only documents search support for Characters, Collections, Games, Platforms, Themes, plus the dedicated Search endpoint. The wrapper exposed the helper uniformly, so calls such as
client.companies.search(...)appeared valid but produced an unsupported IGDB request.Official reference: https://api-docs.igdb.com/#search
Impact
Unsupported high-level searches now fail early with
IGDBValidationError, while supported endpoint searches retain the same API.Checks
@ts-expect-errorcoverage verifies the searchable path type is genuinely narrowedmainfor scopebun run checkwas not available in the connector-only environment; CI should be treated as the executable verification