googleapis / googleapis/google-api-nodejs-client

Docs don't match types

Aperta
#3,790 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
size: s type: docs
Lingua principale
TypeScript
Stelle
12.2k
Fork
2k
Merge medio
1g 9h
PR unite (30g)
24

Descrizione

### Please make sure you have searched for information in the following guides.

- [x] Search the issues already opened: https://github.com/GoogleCloudPlatform/google-cloud-node/issues
- [x] Check our Troubleshooting guide: https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/troubleshooting
- [x] Check our FAQ: https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/faq
- [x] Check our libraries HOW-TO: https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md
- [x] Check out our authentication guide: https://github.com/googleapis/google-auth-library-nodejs
- [x] Check out handwritten samples for many of our APIs: https://github.com/GoogleCloudPlatform/nodejs-docs-samples

### Documentation Request

The npm docs at: https://www.npmjs.com/package/googleapis#oauth2-client

say to use the googleapi oauth client like:

`
const oauth2Client = new google.auth.OAuth2(
YOUR_CLIENT_ID,
YOUR_CLIENT_SECRET,
YOUR_REDIRECT_URL
);
`

But in VS code that is marked as deprecated in the types, in favor of using a config object. Maybe the docs on npm need to be updated?

Also, your checklist before submitting an issue says to go to this url:

https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/troubleshooting

But when I went there I got a 404.

I also got a 404 for this FAQ link:

https://googlecloudplatform.github.io/google-cloud-node/#/docs/guides/faq

At this URL they show using the config object. Maybe link to this from the npm docs?

https://github.com/googleapis/google-auth-library-nodejs

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Confronta la documentazione del pacchetto npm OAuth2 con i tipi TypeScript correnti e verifica gli URL di troubleshooting e FAQ citati nell'issue. Aggiorna l'esempio del constructor e i link non funzionanti in modo che la documentazione corrisponda alla configurazione supportata e che i link vengano risolti correttamente.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.