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.

Sign up for GitHub

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

Jump to bottom

Invalid parameter in quota documentation example #3762

Closed
sleungcy opened this issue Apr 22, 2024 · 1 comment · Fixed by #3786
Closed

Invalid parameter in quota documentation example #3762

sleungcy opened this issue Apr 22, 2024 · 1 comment · Fixed by #3786

Comments

@sleungcy
Copy link

Hi,

The example provided in the documentation seems to be invalid. The documentation uses domains.total_domains rather than domains.total_private_domains.

Could you help clarify in the docs which is the correct parameter to use?

cloud_controller_ng/docs/v3/source/includes/resources/organization_quotas/_update.md.erb

Line 31 in 337bf71

"total_private_domains": 7

Thanks,
Sam
@sleungcy sleungcy changed the title Invalid parameter in example Invalid parameter in quota documentation example Apr 22, 2024
tcdowney added a commit that referenced this issue May 7, 2024
@tcdowney
Correct v3 org quota update example in docs
652d192 
- The correct field for specifying the total amount of private
domains an org should be allowed to have is `domains.total_domains`

Fixes #3762
@tcdowney tcdowney mentioned this issue May 7, 2024
Merged
5 tasks
@tcdowney
Copy link
Member

tcdowney commented May 7, 2024

Thank you for pointing out this issue @sleungcy! The correct parameter to use in V3 is domains.total_domains. I just submitted PR #3786 to correct it.

johha pushed a commit that referenced this issue May 8, 2024
@tcdowney @johha
Correct v3 org quota update example in docs
6d32549 
- The correct field for specifying the total amount of private
domains an org should be allowed to have is `domains.total_domains`

Fixes #3762
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Correct v3 org quota update example in docs cloudfoundry/cloud_controller_ng
2 participants
@tcdowney @sleungcy