firebase
[docs] No detailed information on Firestore triggers `*WithAuthContext()`
Related issues
none.
[REQUIRED] Version info
node: all
firebase-functions:
- onDocumentCreatedWithAuthContext
- onDocumentDeletedWithAuthContext
- onDocumentUpdatedWithAuthContext
- onDocumentWrittenWithAuthContext
[REQUIRED] Test case
Search the Firebase Documentation website. There is only mention of any of the above functions with no detailed reference.
[REQUIRED] Steps to reproduce
See Test Case section above.
[REQUIRED] Expected behavior
Documentation for these should exist and be discoverable.
[REQUIRED] Actual behavior
No documentation exist beyond mention of the functions in this page
Were you able to successfully deploy your functions?
N/A
I couldn't figure out how to label this issue, so I've labeled it for a human to triage. Hang tight.
Hi @gregfenton
Does this cover what you're expecting to see?
If not, could you provide some detail into what you'd expect for these triggers to be better documented.
@CorieW Yes! But I didn't find that page. There are no links from the page I posted above, and the Search function on the Firebase docs pages does not locate that page. Either there is no clear navigation to that Reference page, or I'm missing it for some non-obvious reason??
Searching for onDocumentCreated seems to have many hits, including the page you provided.
Yeah, you're right, it's more difficult than it should be to reach.
There is an 'API Reference' tab on the sidebar of this page, but even from there you have to go to '2nd gen API reference', then 'Firestore'. I see how new users to Firebase might find this difficult, especially when the main API Reference Page isn't directly helpful here.
I'll raise this and see if API reference links could be added (like in v1) to each trigger. Additionally, it might be more convenient if the search/filter functionality (on the docs) brought up all pages in the docs that made mention of the search term (e.g. onDocumentCreatedWithAuthContext in this instance).
