Skip to content

Commit 4f222e9

Browse files
authored
fix(AIP-4231): include type and child_type ref compat guidance (#1332)
* fix(AIP-4231): include type and child_type ref comapt guidance * specify request scope for type to child_type * more explicit language and references
1 parent 574114e commit 4f222e9

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

aip/client-libraries/4231.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,19 @@ to the following backwards-compatibility expectations:
219219
libraries.
220220
- The addition of a `google.api.resource_reference` annotation on an existing
221221
field **must** be a backwards-compatible change.
222+
- Changing a `google.api.resource_reference` from `child_type` to `type`
223+
**must** be a backwards-compatible change when the `child_type` referenced
224+
has a single `pattern` and the newly referenced `type` is the matching
225+
parent resource `pattern` (see the
226+
[Referencing other resources](#referencing-other-resources) section for
227+
more info).
228+
- For references that appear in a request, changing from `type` to
229+
`child_type` **must** be a backwards-compatible change when the resource
230+
`pattern` originally referenced via the `type` is included in the set of
231+
possible resource `pattern`s derived through `child_type` resolution (see
232+
the above [Multi-pattern resources](#multi-pattern-resources) and
233+
[Referencing other resources](#referencing-other-resources) sections for
234+
more examples).
222235

223236
Note: The `ORIGINALLY_SINGLE_PATTERN` and `FUTURE_MULTI_PATTERN` flags are
224237
deprecated, and must not be used.
@@ -230,6 +243,7 @@ deprecated, and must not be used.
230243

231244
## Changelog
232245

246+
- **2023-03-25**: Include compatibility guidance for `type` and `child_type`.
233247
- **2022-10-28**: Pattern variables are considered final
234248
- **2020-09-14**: Disallow simultaneous use of both `type` and `child_type`.
235249
- **2020-05-14**: Added complex resource ID path segments.

0 commit comments

Comments
 (0)