Skip to content

Commit 1e98d65

Browse files
authored
Resolving comments and typos
1 parent 22fdf41 commit 1e98d65

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

graph/patterns/namespace.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ namespace and logically organize related API entities in the Graph metadata.
2222
</Schema>
2323
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2424

25-
A public namespace must have "microsoft.graph. prefix and be presented in camel
25+
A public namespace must have "microsoft.graph." prefix and be presented in camel
2626
case, i.e microsoft.graph.myNamespace.
2727

2828
When type casting is required in the API query, request or response, a fully
@@ -36,8 +36,7 @@ API resource grouping creates a user-friendly experience keeping all resources
3636
for a specific feature close together
3737
and limits the length of IDE prompts such as auto-complete in some programming languages.
3838

39-
We recommend creating a new namespace when a new top-level API category is
40-
introduced.
39+
We recommend that a new namespace should be aligned with top-level API category.
4140

4241
## Issues and Considerations
4342

@@ -60,12 +59,14 @@ introduced.
6059
6. Cyclical references between namespaces are not allowed as many
6160
object-oriented languages don’t support a cycles between namespaces.
6261

63-
7. Microsoft Graph has heuristic rules for declared namespaces:
62+
7. Microsoft Graph has some predefined constraints for declared namespaces:
6463

65-
1. All public namespaces must have a prefix microsoft.graph
64+
1. All public namespaces must have a prefix "microsoft.graph"
6665

67-
2. If a namespace does not begin with ‘microsoft.graph’ prefix, all types
68-
in the schema will be coerced into the main ‘microsoft.graph’ namespace.
66+
2. Only one level of nesting deeper then "microsoft.graph" is supported
67+
68+
3. If a namespace does not begin with "microsoft.graph" prefix, all types
69+
in the schema will be coerced into the main "microsoft.graph" namespace.
6970

7071
## Examples
7172

@@ -80,27 +81,26 @@ introduced.
8081
</Schema>
8182
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8283

83-
Fully qualified type name: microsoft.graph.search.bookmark
84+
Fully qualified type name: "microsoft.graph.search.bookmark"
8485

8586
### Managing multiple schemas:
8687

8788
Workloads must define schemas in their csdl using the Edmx format.
88-
[Microsoft.IC3.DataPlatform](https://dev.azure.com/msazure/One/_git/AD-AggregatorService-Workloads?path=%2FWorkloads%2FMicrosoft.IC3.DataPlatform%2Foverride%2Fschema-Prod-beta.csdl)
89-
is an example of a workload that exposes multiple namespaces.
89+
Here is an example of a workload that exposes multiple namespaces.
9090

9191
**Tip:** As with schemas that exist in the microsoft.graph namespace, defining an
92-
entity type is optional, AGS will transform your schema to make all entity types
93-
derive from microsoft.graph.entity.
92+
entity type is optional, by default your schema derives all entity types
93+
from microsoft.graph.entity.
9494

9595
**Warning:** Do not deviate from the general structure in the example below.
9696
Schema validation tool expects the XML structure (including xml namespace
9797
declarations) to match the example below.
9898
```XML
9999
<?xml version="1.0" encoding="utf-8"?>
100-
<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" xmlns:ags="http://aggregator.microsoft.com/internal" xmlns:odata="http://schemas.microsoft.com/oDataCapabilities">
100+
<edmx:Edmx Version="4.0" xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" xmlns:odata="http://schemas.microsoft.com/oDataCapabilities">
101101
<edmx:DataServices>
102-
<Schema Namespace="microsoft.graph.callRecords" xmlns="http://docs.oasis-open.org/odata/ns/edm" xmlns:ags="http://aggregator.microsoft.com/internal" xmlns:odata="http://schemas.microsoft.com/oDataCapabilities">
103-
<EntityType Name="callRecord" ags:IsOwner="true" ags:AddressUrl="https://plat.teams.microsoft.com">
102+
<Schema Namespace="microsoft.graph.callRecords" xmlns="http://docs.oasis-open.org/odata/ns/edm" xmlns:odata="http://schemas.microsoft.com/oDataCapabilities">
103+
<EntityType Name="callRecord">
104104
<Key>
105105
<PropertyRef Name="id" />
106106
</Key>

0 commit comments

Comments
 (0)