Skip to content

Commit 903e82b

Browse files
authored
Attempt to make AIP-180 the only starting point needed for compatibility (#897)
(Not everything needs to be in AIP-180, but anything in other APIs should be linked from AIP-180.)
1 parent 00c9302 commit 903e82b

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

aip/general/0151.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,11 @@ Errors that occur over the course of an operation **may** be placed in the
108108
metadata message. The errors themselves **must** still be represented with a
109109
[google.rpc.Status][] object.
110110

111+
### Backwards compatibility
112+
113+
Changing either the `response_type` or `metadata_type` of a long-running operation
114+
is a breaking change.
115+
111116
<!-- prettier-ignore-start -->
112117
[aip-128]: ./0128.md
113118
[aip-131]: ./0131.md
@@ -125,6 +130,7 @@ metadata message. The errors themselves **must** still be represented with a
125130

126131
## Changelog
127132

133+
- **2022-06-??**: Added compatibility section
128134
- **2020-08-24**: Clarified that responses are not streaming responses.
129135
- **2020-06-24**: Added guidance for parallel operations.
130136
- **2020-03-20**: Clarified that both `response_type` and `metadata_type` are

aip/general/0180.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,16 +133,23 @@ this guidance could ostensibly prevent _any_ change (which is not the intent).
133133
## Further reading
134134

135135
- For compatibility around pagination, see [AIP-158][].
136+
- For compatibility around long-running operations, see [AIP-151][].
136137
- For understanding stability levels and expectations, see [AIP-181][].
138+
- For compatibility with client library resource name parsing, see [AIP-4231][]
139+
- For compatibility with client library method signatures, see [AIP-4232][]
137140

138141
## Changelog
139142

143+
- **2022-06-??**: Added more links to other AIPs with compatibility concerns
140144
- **2019-12-16**: Clarified that moving existing fields into oneofs is
141145
breaking.
142146

143147
<!-- prettier-ignore-start -->
144148
[aip-122]: ./0122.md
149+
[aip-151]: ./0151.md
145150
[aip-158]: ./0158.md
146151
[aip-181]: ./0181.md
152+
[aip-4231]: ./client-libraries/4231.md
153+
[aip-4232]: ./client-libraries/4232.md
147154
[ec2]: https://aws.amazon.com/blogs/aws/theyre-here-longer-ec2-resource-ids-now-available/
148155
<!-- prettier-ignore-end -->

0 commit comments

Comments
 (0)