googleapis / googleapis/google-api-nodejs-client

Incomplete documentation on the Telemetry API

Aperta
#3,024 1 commento 1 reazione 0 assegnatari Vedi su GitHub
priority: p2 type: bug
Lingua principale
TypeScript
Stelle
12.2k
Fork
2k
Merge medio
1g 9h
PR unite (30g)
24

Descrizione

- OS: Windows 10 21H2
- Node.js version: 14.16.0
- npm version: 8.1.2
- `googleapis` version: 105.0.0

#### Steps to reproduce

- There is no documentation for the Telemetry API in official documentation: https://googleapis.dev/nodejs/googleapis/latest/chromemanagement/classes/Chromemanagement.html

- In [repository documentation](https://github.com/googleapis/google-api-nodejs-client/blob/432ce2dccd56b308b5d3ebaaf6233a279d026858/discovery/chromemanagement-v1.json), description of `parent` in `telemetry.devices.list` is :
`Required. Customer id or \"my_customer\" to use the customer associated to the account making the request.`.
But right Customer id to use the customer associated to the account making the request is `\"customer/my_customer\"`

```javascript
const chromemanagement = google.chromemanagement({
version: 'v1',
auth: oAuth2Client
});

const telemetry = await chromemanagement.customers.telemetry.devices.list({
parent: 'my_customer',
readMask: 'name'
}) // Throw error: "The requested URL /v1/my_customer/telemetry/devices was not found on this server."

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia da discovery/chromemanagement-v1.json e confronta la descrizione dell'elemento padre di telemetry.devices.list con il formato della risorsa mostrato da Telemetry API. Controlla la documentazione ufficiale di Chromemanagement collegata, quindi correggi la documentazione del repository in modo che il valore documentato dell'elemento padre e i dettagli dell'API siano accurati e siano riportati di conseguenza.

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

Valutazione

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

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.