Skip to content

Commit d569024

Browse files
authored
formatting
1 parent b694497 commit d569024

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

graph/patterns/namespace.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,19 @@
22

33
Microsoft Graph API Design Pattern
44

5-
### *The Namespace provides the ability to organize resource definitions together into a logical set.*
5+
*The Namespace provides the ability to organize resource definitions together into a logical set.*
66

77
## Problem
88

9+
---
910
When building a complex offering API designers may need to model many different
1011
resources and their relationships. For better user experience and
1112
discoverability related API elements need to be grouped together.
1213

1314

1415
## Solution
1516

17+
---
1618
API designers can use the Namespace attribute of the CSDL schema to declare a
1719
namespace and logically organize related API entities in the Graph metadata.
1820

@@ -32,6 +34,7 @@ name. For consistent user experience namespaces MUST be aligned with the corresp
3234

3335
## When to Use this Pattern
3436

37+
---
3538
API resource grouping creates a user-friendly experience keeping all resources
3639
for a specific feature close together
3740
and limits the length of IDE prompts such as auto-complete in some programming languages.
@@ -40,6 +43,7 @@ We recommend that a new namespace should be aligned with top-level API category.
4043

4144
## Issues and Considerations
4245

46+
---
4347
1. Microsoft Graph consistency requirements discourage using the same type
4448
names for different concepts even within different namespaces. Microsoft
4549
Graph type names must be descriptive and unique within the API
@@ -70,6 +74,7 @@ We recommend that a new namespace should be aligned with top-level API category.
7074

7175
## Examples
7276

77+
---
7378
### Namespace and type declarations:
7479

7580
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ XML

0 commit comments

Comments
 (0)