summaryrefslogtreecommitdiff
path: root/buildscripts/idl
diff options
context:
space:
mode:
authorHuayu Ouyang <huayu.ouyang@mongodb.com>2022-08-11 18:47:23 +0000
committerEvergreen Agent <no-reply@evergreen.mongodb.com>2022-08-11 19:49:09 +0000
commitc83e20e55a7d6a1ffa3e2c7d106c379edfbd2784 (patch)
tree7f1c4a97c28b04afba74b64dc3aa845d0113a9e5 /buildscripts/idl
parentc8bfab6325363f696e628ddafaf40df921526560 (diff)
downloadmongo-c83e20e55a7d6a1ffa3e2c7d106c379edfbd2784.tar.gz
SERVER-68644 Update Stable API README
Diffstat (limited to 'buildscripts/idl')
-rw-r--r--buildscripts/idl/idl_check_compatibility.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/buildscripts/idl/idl_check_compatibility.py b/buildscripts/idl/idl_check_compatibility.py
index 148bd5594b0..4a421e1353a 100644
--- a/buildscripts/idl/idl_check_compatibility.py
+++ b/buildscripts/idl/idl_check_compatibility.py
@@ -168,6 +168,8 @@ ALLOW_ANY_TYPE_LIST: List[str] = [
# Do not add user visible fields already released in earlier versions.
# We generally don't allow changing a field from stable to unstable, but we permit it in special cases,
# such as when we want to avoid making internal fields part of the stable API.
+# Additions to this list must be approved by the Stable API PM and code reviewed by the Replication
+# team.
IGNORE_STABLE_TO_UNSTABLE_LIST: List[str] = [
# This list is only used in unit-tests.
'newReplyFieldUnstableIgnoreList-reply-unstableNewFieldIgnoreList',
@@ -227,6 +229,8 @@ IGNORE_STABLE_TO_UNSTABLE_LIST: List[str] = [
# want to make sure such changes are always intentional. Therefore, the checker will throw errors
# unless the field is also added to this list below, with which the author ackhowledges they are
# aware of the above implications.
+# Additions to this list must be approved by the Stable API PM and code reviewed by the Replication
+# team.
ALLOWED_STABLE_FIELDS_LIST: List[str] = [
# This list is only used in unit-tests. These cases modify fields from unstable to stable.
'oldReplyFieldTypeBsonAnyUnstable-reply-oldBsonSerializationTypeAnyUnstableReplyField',