You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: BUGBOT.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,3 +11,26 @@
11
11
12
12
## Resource Types
13
13
Resource types that do not list entitlements or grants should have the SkipEntitlementsAndGrants annotation in the ResourceType definition.
14
+
15
+
## Breaking Change Considerations
16
+
17
+
All connectors should be considered potentially in-use, and the data they expose should be considered a stable API.
18
+
19
+
### Resource Type Changes
20
+
21
+
-**NEVER remove a resource type**
22
+
-**NEVER change how resource IDs are calculated** - the ID of a given resource must remain stable across all versions of the connector
23
+
-**EXERCISE EXTREME CAUTION** when filtering out previously included resources
24
+
-**EXERCISE EXTREME CAUTION** when changing how any values associated with a resource are calculated
25
+
26
+
### Entitlement Changes
27
+
28
+
-**NEVER remove an entitlement**
29
+
30
+
### User Profile Changes
31
+
32
+
Resources implementing the `User` trait may have an associated user profile, typically set using `WithUserProfile`. All changes to user profiles must remain backwards compatible:
33
+
34
+
-**NEVER remove keys from user profiles**
35
+
-**NEVER change the type of a value in a user profile**
36
+
-**NEVER change the value how values are represented in a user profile** - eg `alice` should always be `alice`, not `Alice` or `[email protected]`
0 commit comments