Skip to content

Commit e05dba5

Browse files
authored
AIP-180: Clarify scope of compatibility rules. (#1187)
1 parent f461d12 commit e05dba5

1 file changed

Lines changed: 8 additions & 0 deletions

File tree

aip/general/0180.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ There are three distinct types of compatibility to consider:
4444
buffers and JSON as transport formats. Other transport formats may have
4545
slightly different rules.
4646

47+
**Note:** This guidance assumes that APIs are intended to be called from a
48+
range of consumers, written in multiple languages and with no control over
49+
how and when consumers update. Any API which has a more limited scope (for
50+
example, an API which is only called by client code written by the same team
51+
as the API producer, or deployed in a way which can enforce updates) should
52+
carefully consider its own compatibility requirements.
53+
4754
### Adding components
4855

4956
In general, new components (interfaces, methods, messages, fields, enums, or
@@ -236,6 +243,7 @@ version.
236243

237244
## Changelog
238245

246+
- **2023-07-26**: Added note on APIs which have limited clients.
239247
- **2022-08-11**: Added "Moving components between files" section.
240248
- **2022-06-01**: Added more links to other AIPs with compatibility concerns
241249
- **2019-12-16**: Clarified that moving existing fields into oneofs is

0 commit comments

Comments
 (0)