Skip to content

Commit 4679cf0

Browse files
committed
Update GuidelinesGraph.md
1 parent 64212e0 commit 4679cf0

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

graph/GuidelinesGraph.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,8 @@ Microsoft Graph APIs should support basic query options in conformance with ODat
166166
|Requirements |
167167
|----------------------------------------------------------------------------------------------------|
168168
| :heavy_check_mark: **MUST** support `$select on resource` to enable properties projection. |
169-
| :ballot_box_with_check: **SHOULD** support `\$filter with eq`, `ne` operations on properties of entities for collections. |
169+
| :ballot_box_with_check: **SHOULD** support `$expand=navProp1` option for navigation properties of entities. |
170+
| :ballot_box_with_check: **SHOULD** support `$filter with eq`, `ne` operations on properties of entities for collections. |
170171
| :heavy_check_mark: **MUST** support [server-driven pagination](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#981-server-driven-paging) of collections using a [nextLink](http://docs.oasis-open.org/odata/odata-json-format/v4.01/odata-json-format-v4.01.html#sec_ControlInformationnextLinkodatanextL). |
171172
| :ballot_box_with_check: **SHOULD** support [client-driven pagination](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#982-client-driven-paging) of collections using `$top` and `$skip` (or `$skipToken`). |
172173
| :ballot_box_with_check: **SHOULD** support `$count` for collections. |
@@ -184,15 +185,15 @@ You can model structured resources for your APIs by using the OData entity type
184185
Because objects of complex types in Microsoft Graph don’t have unique identifiers, they are not directly addressable via URIs. Therefore, you must not use complex type to model addressable resources such as individually addressable items within a collection. For more information, see the [Microsoft REST API Guidelines collection URL patterns](https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#93-collection-url-patterns). Complex types are better suited to represent composite properties of API entities.
185186

186187
```xml
187-
<EntityType Name="Author">
188+
<EntityType Name="author">
188189
<Key>
189190
<PropertyRef Name="id" />
190191
</Key>
191192
<Property Name="id" Type="Edm.String" Nullable="false" />
192193
<Property Name="name" Type="Edm.String" />
193194
<Property Name="address" Type="microsoft.graph.Address" />
194195
</EntityType>
195-
<ComplexType Name="Address">
196+
<ComplexType Name="address">
196197
<Property Name="city" Type="Edm.String" />
197198
<Property Name="street" Type="Edm.String" />
198199
<Property Name="stateOrProvince" Type="Edm.String" />
@@ -273,11 +274,11 @@ Microsoft REST API Guidelines provide guidelines that Microsoft Graph APIs shoul
273274
```http
274275
{
275276
"error": {
276-
"code": "BadRequest",
277+
"code": "badRequest",
277278
"message": "Cannot process the request because a required field is missing.",
278279
"target": "query",
279280
"innererror": {
280-
"code": "RequiredFieldMissing",
281+
"code": "requiredFieldMissing",
281282
282283
}
283284
}
@@ -291,9 +292,9 @@ The top-level error code must be aligned with HTTP response status codes accordi
291292
```http
292293
{
293294
"error": {
294-
"code": "BadRequest",
295+
"code": "badRequest",
295296
"message": "Cannot process the request because it is malformed or incorrect.",
296-
"target": "Resource X (Optional)"
297+
"target": "resource X (Optional)"
297298
}
298299
}
299300
```
@@ -303,7 +304,7 @@ The top-level error code must be aligned with HTTP response status codes accordi
303304
```http
304305
{
305306
"error": {
306-
"code": "BadRequest",
307+
"code": "badRequest",
307308
"message": "Cannot process the request because it is malformed or incorrect.",
308309
"innererror": {
309310
"code": "requiredFieldOrParameterMissing",

0 commit comments

Comments
 (0)