docs: add cautionary note for undocumented parameter usage #15
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.
This PR updates the
README.md
under the section “Undocumented request params” to include a cautionary note about using undocumented parameters likebaz
. While the current example uses@ts-expect-error
, it lacks guidance on the risks associated with undocumented API fields.The new note:
@ts-expect-error
and a clear comment.This change is purely documentation-related and does not affect runtime behavior or typings.