googleapis / googleapis/google-api-nodejs-client

Incomplete documentation on the Telemetry API

Offen
#3,024 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen
priority: p2 type: bug
Vorherrschende Sprache
TypeScript
Sterne
12.3k
Forks
2k
Ø Merge
1 T. 9 Std.
Gemergte PRs (30 T.)
24

Beschreibung

- 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."

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne mit discovery/chromemanagement-v1.json und vergleiche die Beschreibung des übergeordneten Elements von telemetry.devices.list mit dem vom Telemetry API gezeigten Ressourcenformat. Prüfe die verlinkte offizielle Chromemanagement-Dokumentation und korrigiere anschließend die Repository-Dokumentation, damit der dokumentierte Wert des übergeordneten Elements und die API-Details korrekt sind und dort entsprechend wiedergegeben werden.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
node.js, typescript
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
38/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.