Skip to content

Commit 5827bab

Browse files
authored
additional clarifications
1 parent 0f714c2 commit 5827bab

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

graph/patterns/namespace.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Microsoft Graph API Design Pattern
88

99
When building a complex offering API designers may need to model many different
1010
resources and their relationships. For better user experience and
11-
discoverability related API elements need to be clustered together.
11+
discoverability related API elements need to be grouped together.
1212

1313

1414
## Solution
@@ -27,13 +27,14 @@ case, i.e microsoft.graph.myNamespace.
2727

2828
When type casting is required in the API query, request or response, a fully
2929
qualified type name is represented as concatenation of a namespace and a type
30-
name. Consequently namespaces should be aligned with API category path segment.
30+
name. For consistent user experience namespaces should be aligned with the corresponding API category path segment.
31+
3132

3233
## When to Use this Pattern
3334

3435
API resource grouping creates a user-friendly experience keeping all resources
35-
for a specific feature close together. It also allows generating smaller SDKs
36-
and libraries and limits length of IDE prompts such as Intellisense.
36+
for a specific feature close together. It also allows generating smallersmaller downloadable client components
37+
and limits length of IDE prompts such as Intellisense.
3738

3839
We recommend creating a new namespace when a new top-level API category is
3940
introduced.
@@ -42,10 +43,10 @@ introduced.
4243

4344
1. Microsoft Graph consistency requirements discourage using the same type
4445
names for different concepts even within different namespaces. Microsoft
45-
Graph type names must be descriptive and almost always unique within the API
46-
surface.
46+
Graph type names must be descriptive and unique within the API
47+
surface without requiring full qualification.
4748

48-
2. Namespace must be consistent with API navigation path.
49+
2. Namespace must be consistent with API category in the navigation path according to [Microsoft Graph REST API Guidelines](https://github.com/microsoft/api-guidelines/blob/vNext/graph/GuidelinesGraph.md#uniform-resource-locators-urls)
4950

5051
3. When type name is ambiguous and requires a namespace qualifier, changing
5152
namespace is a breaking change.

0 commit comments

Comments
 (0)