Skip to content

Commit 875d657

Browse files
committed
added antipattern template
1 parent 482fa42 commit 875d657

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

graph/patterns/antiPatternTemplate.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
# Antipattern name
3+
4+
*name with a negative connotation*
5+
6+
*Example: Fleabag of properties:
7+
8+
## Description
9+
10+
*Example: The flat bag pattern is a known anti-pattern in Microsoft Graph, where multiple variants of a common concept are modeled as a single entity type with all potential properties plus an additional property to distinguish the variants.*
11+
12+
## Consequences
13+
*Describe the consequences in terms of the developer experience*
14+
15+
*Example: This is the least recommended modeling choice because it is weakly typed, which increases the number of variations and complexity of solutions, making it difficult to verify the semantic correctness of the API for both clients and producers...*
16+
17+
## Preferable solutions
18+
19+
*Example: It is preferable to use type hierarchy and facets patterns.*
20+
21+
## Example
22+
23+
*Provide an example of better modeling*

0 commit comments

Comments
 (0)