Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Invalid diskType URL is give as example in many places #357

Closed
kinghrothgar opened this issue Apr 18, 2019 · 4 comments
Closed

Invalid diskType URL is give as example in many places #357

kinghrothgar opened this issue Apr 18, 2019 · 4 comments
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@kinghrothgar
Copy link

kinghrothgar commented Apr 18, 2019

In several comments through out this library, project/zones/zone/diskTypes/ is used as an example for diskType URL which is not valid. This led to confusion that took me about an hour to sort out. Instead, projects/project/zones/zone/diskTypes/ should be used which IS valid. I made a PR #356 and then realized I believe the files I was trying to change are generated so I'm not sure how to fix this.

This invalid example can be found in the core API documentation also https://cloud.google.com/compute/docs/reference/rest/v1/disks/insert :

string

URL of the disk type resource describing which disk type to use to create the disk. Provide this when creating the disk. For example: project/zones/zone/diskTypes/pd-standard or pd-ssd
@jeanbza jeanbza added type: docs Improvement to the documentation for an API. type: question Request for information or clarification. Not an issue. labels Apr 18, 2019
@jeanbza
Copy link
Member

jeanbza commented Apr 18, 2019

Thanks for raising this. I've pinged the compute team.

@jeanbza
Copy link
Member

jeanbza commented Apr 19, 2019

Thanks again for raising this. The compute team is working on this.

@kinghrothgar
Copy link
Author

Just glad it's open source and I can report it!

@JustinBeckwith JustinBeckwith removed the type: question Request for information or clarification. Not an issue. label Jun 5, 2019
@jeanbza
Copy link
Member

jeanbza commented Dec 10, 2019

This appears to now be fixed. Closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

3 participants