[go: nahoru, domu]
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.

Sign up for GitHub

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

Jump to bottom

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

Open
gregfenton opened this issue Oct 21, 2023 · 2 comments
Open

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

gregfenton opened this issue Oct 21, 2023 · 2 comments
Assignees
@ehsannas
Labels
api: firestore Issues related to the googleapis/nodejs-firestore API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. type: docs Improvement to the documentation for an API.

Comments

@gregfenton
Copy link

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 gregfenton added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Oct 21, 2023
@product-auto-label product-auto-label bot added the api: firestore Issues related to the googleapis/nodejs-firestore API. label Oct 21, 2023
@ehsannas
Copy link
Contributor

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

@ehsannas ehsannas self-assigned this Oct 23, 2023
@th0rgall
Copy link

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:

@ehsannas ehsannas added the type: docs Improvement to the documentation for an API. label Jan 30, 2024
@ehsannas ehsannas assigned ehsannas and unassigned ehsannas Jan 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ehsannas ehsannas

Labels
api: firestore Issues related to the googleapis/nodejs-firestore API. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. type: docs Improvement to the documentation for an API.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ehsannas @gregfenton @th0rgall