docs(function): remove updatedAt from IDP User interface#126
Open
k1LoW wants to merge 1 commit into
Open
Conversation
The IDP client's User type does not expose an updatedAt field, so documenting it misleads readers into expecting a property that does not exist on returned users.
There was a problem hiding this comment.
Pull request overview
This PR corrects the TypeScript documentation for the Function service’s built-in IdP client by removing an updatedAt?: string field from the documented User interface, aligning the docs with the actual client response shape and avoiding misleading type assumptions for readers.
Changes:
- Removed the stray
updatedAt?: string;property from theinterface Usersnippet on the “Managing Built-in IdP Users” guide.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
The
Clientinterface'sUsertype on the Managing IDP users page lists anupdatedAt?: stringfield, but the actual IDP client does not return that property. Documenting it misleads readers into typing against a field that will never be present.This PR drops the stray
updatedAtline from theinterface Usersnippet.