googleapis / googleapis/google-cloud-node

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

Aperta
#7,461 2 commenti 3 reazioni 0 assegnatari Vedi su GitHub
api: firestore library: nodejs-firestore priority: p2 type: bug type: docs
Lingua principale
TypeScript
Stelle
3.2k
Fork
712
Merge medio
2g 9h
PR unite (30g)
104

Descrizione

v6.5.0 of the docs has [a section for exportDocuments()](https://googleapis.dev/nodejs/firestore/6.5.0/google.firestore.admin.v1.FirestoreAdmin.html#exportDocuments1)

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](https://github.com/googleapis/nodejs-firestore/blob/7a9d17bdd5fca3d91e66f7500c035140a7397c33/dev/protos/firestore_admin_v1_proto_api.js#L1046-L1057), [here 2](https://github.com/googleapis/nodejs-firestore/blob/7a9d17bdd5fca3d91e66f7500c035140a7397c33/types/v1/firestore_admin_client.d.ts#L551-L626) and [here 3](https://github.com/googleapis/nodejs-firestore/blob/7a9d17bdd5fca3d91e66f7500c035140a7397c33/types/protos/firestore_admin_v1_proto_api.d.ts#L324-L343)

So the docs should be updated to reflect that the API still exists, or the [CHANGELOG](https://github.com/googleapis/nodejs-firestore/blob/main/CHANGELOG.md) should indicate that this *breaking change* exists.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Compare the v6.5.0 exportDocuments() documentation with the generated API references linked in dev/protos/firestore_admin_v1_proto_api.js, types/v1/firestore_admin_client.d.ts, and types/protos/firestore_admin_v1_proto_api.d.ts. Determine whether the API is still intended to be documented, then update the documentation or the CHANGELOG to clearly record the outcome.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
nodejs, typescript
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.