Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

Generated doc pages are missing nested config items #50

Closed
zbjornson opened this issue Mar 5, 2018 · 1 comment
Closed

Generated doc pages are missing nested config items #50

zbjornson opened this issue Mar 5, 2018 · 1 comment
Assignees
Labels
api: compute Issues related to the googleapis/nodejs-compute API. 🚨 This issue needs some love. triage me I really want to be triaged.

Comments

@zbjornson
Copy link

This is probably a more general issue than just googleapis/nodejs-compute, but if you look at e.g. the generated doc page for zone.createVM https://cloud.google.com/nodejs/docs/reference/compute/0.9.x/Zone#createVM
there are only three parameters: name, config and callback -- the config.* sub-parameters os, http, https and others are missing:

nodejs-compute/src/zone.js

Lines 520 to 537 in df05066

* @param {object} config - See an
* [Instance resource](https://cloud.google.com/compute/docs/reference/v1/instances).
* @param {?object[]} config.disks - See a
* [Disk resource](https://cloud.google.com/compute/docs/reference/v1/disks).
* @param {boolean=} config.http - Allow HTTP traffic. Default: `false`
* @param {boolean=} config.https - Allow HTTPS traffic. Default: `false`
* @param {?object[]} config.networkInterfaces - An array of configurations for
* this interface. This specifies how this interface should interact with
* other network services, such as connecting to the internet. Default:
* `[ { network: 'global/networks/default' } ]`
* @param {string=} config.machineType - The machine type resource to use.
* Provide only the name of the machine, e.g. `n1-standard-16`. Refer to
* [Available Machine Types](https://goo.gl/jrHEbo). Default:
* `n1-standard-1`
* @param {string=} config.os - Specify the name of an OS, and we will use the
* latest version as the source image of a new boot disk. See
* [this list of accepted OS names](https://github.com/stephenplusplus/gce-images#accepted-os-names).
* @param {?string[]} config.tags - An array of tags.

@stephenplusplus
Copy link
Contributor

Thanks for reporting. We have an issue for this at googleapis/google-cloud-node#2783.

@google-cloud-label-sync google-cloud-label-sync bot added the api: compute Issues related to the googleapis/nodejs-compute API. label Jan 31, 2020
@yoshi-automation yoshi-automation added triage me I really want to be triaged. 🚨 This issue needs some love. labels Apr 6, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api: compute Issues related to the googleapis/nodejs-compute API. 🚨 This issue needs some love. triage me I really want to be triaged.
Projects
None yet
Development

No branches or pull requests

3 participants