Skip to content

Commit

Permalink
Attempt to make AIP-180 the only starting point needed for compatibil…
Browse files Browse the repository at this point in the history
…ity (aip-dev#897)

(Not everything needs to be in AIP-180, but anything in other APIs
should be linked from AIP-180.)
  • Loading branch information
jskeet authored May 31, 2022
1 parent 00c9302 commit 903e82b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 0 deletions.
6 changes: 6 additions & 0 deletions aip/general/0151.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,6 +108,11 @@ Errors that occur over the course of an operation **may** be placed in the
metadata message. The errors themselves **must** still be represented with a
[google.rpc.Status][] object.

### Backwards compatibility

Changing either the `response_type` or `metadata_type` of a long-running operation
is a breaking change.

<!-- prettier-ignore-start -->
[aip-128]: ./0128.md
[aip-131]: ./0131.md
Expand All @@ -125,6 +130,7 @@ metadata message. The errors themselves **must** still be represented with a

## Changelog

- **2022-06-??**: Added compatibility section
- **2020-08-24**: Clarified that responses are not streaming responses.
- **2020-06-24**: Added guidance for parallel operations.
- **2020-03-20**: Clarified that both `response_type` and `metadata_type` are
Expand Down
7 changes: 7 additions & 0 deletions aip/general/0180.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,16 +133,23 @@ this guidance could ostensibly prevent _any_ change (which is not the intent).
## Further reading

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

## Changelog

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

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

0 comments on commit 903e82b

Please sign in to comment.