googleapis / nodejs-firestore

Node.js client for Google Cloud Firestore: a NoSQL document database built for automatic scaling, high performance, and ease of application development.
https://cloud.google.com/firestore/
Apache License 2.0
643 stars 149 forks source link

[docs] FirestoreAdminClient.exportDocuments() no longer in docs #1924

Open gregfenton opened 11 months ago

gregfenton commented 11 months ago

v6.5.0 of the docs has a section for exportDocuments()

v6.6.0 and beyond does not.

But it seems that the APIs are still in the types and the proto code? For example, here, here 2 and here 3

So the docs should be updated to reflect that the API still exists, or the CHANGELOG should indicate that this breaking change exists.

ehsannas commented 11 months ago

Thanks for reporting this issue @gregfenton . This is likely a bug in the documentation generation. I'll take a look.

th0rgall commented 8 months ago

This worried me today when researching how some old client code using it worked. It makes it seem like the function is deprecated or not existing any longer.

As a broader comment, the entire Node.js firestore.v1.FirestoreAdminClient documentation on googleapis.dev is hard to find compared to other Firestore docs, to the point that it seems unofficial. And there seems to be no alternative for it, except digging through the code.

The readme of this repository only refers to a cloud.google.com docs page just like all other Cloud tools, however, I can't find any reference there to the firestore.v1 docs or FirestoreAdminClient (which should include exportDocuments): CleanShot 2024-01-23 at 09 33 14@2x

This is only an issue for the Node.js library as far as I can tell. Compare this to exportDocuments in other Cloud Firestore libraries, which all have this method (and the v1 namespace) documented on cloud.google.com: