nodejs-firestore icon indicating copy to clipboard operation
nodejs-firestore copied to clipboard

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

Open gregfenton opened this issue 8 months ago • 2 comments

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.

gregfenton avatar Oct 21 '23 01:10 gregfenton

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

ehsannas avatar Oct 23 '23 17:10 ehsannas

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:

th0rgall avatar Jan 23 '24 07:01 th0rgall