Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of EventContext for Firestore #1019

Open
IchordeDionysos opened this issue Jan 11, 2022 · 1 comment
Open

Improve documentation of EventContext for Firestore #1019

IchordeDionysos opened this issue Jan 11, 2022 · 1 comment

Comments

@IchordeDionysos
Copy link

Related issues

#739
#785

Description

The functions/field documentation for EventContext, does not respect/mention Firestore in any way, which makes it confusing when reading through it.

It should mention Firestore at least in here:
https://firebase.google.com/docs/reference/functions/cloud_functions.eventcontext#resource
https://firebase.google.com/docs/reference/functions/cloud_functions.eventcontext#params (This is the most confusing only mentions RTDB, not Firestore)

And ideally, also explain what is sent here (maybe explicitly for Firestore as this had sparked confusion in the past):
https://firebase.google.com/docs/reference/functions/cloud_functions.eventcontext#optional-auth
https://firebase.google.com/docs/reference/functions/cloud_functions.eventcontext#optional-authtype

--
Also, it says in auth that it's there for RTDB and callable functions, but in the authType sections it says "all except RTDB".
So authType is also null for callable functions?

@google-oss-bot
Copy link
Collaborator

I found a few problems with this issue:

  • I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
  • This issue does not seem to follow the issue template. Make sure you provide all the required information.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants