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

Update docs for changing attribute input to immutable #7442

Merged
merged 1 commit into from
Mar 10, 2023
Merged

Update docs for changing attribute input to immutable #7442

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/content/docs/how-to/add-mmv1-resource.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ as the following adding support for a `fooBar` field in the API:
- !ruby/object:Api::Type::String
name: 'fooBar'
min_version: beta
input: true
immutable: true
description: |
The cloud.google.com description of this field.
```
Expand All @@ -59,7 +59,7 @@ setting values to `false`, and omit them instead.
* `required: true` indicates that a field is required. New top-level fields
should not be considered required, as that is a breaking change. Subfields
of newly-added optional fields can be added as required.
* `input: true` indicates that a field can only be set when the API resource is
* `immutable: true` indicates that a field can only be set when the API resource is
created. Changing the field will force the resource to be recreated.
* `output: true` indicates that a field is output-only in the API and cannot
be configured by the user.
Expand Down