You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: graph/articles/naming.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
-
# Naming guidelines
1
+
# Naming
2
2
## 1. Approach
3
3
Naming policies should aid developers in discovering functionality without having to constantly refer to documentation.
4
4
Use of common patterns and standard conventions greatly aids developers in correctly guessing common property names and meanings.
5
-
Services SHOULD use verbose naming patterns and SHOULD NOT use abbreviations other than acronyms that are the dominant mode of expression in the domain being represented by the API, (e.g. Url).
5
+
Services SHOULD use verbose naming patterns and MUST NOT use abbreviations other than acronyms that are the dominant mode of expression in the domain being represented by the API, (e.g. Url).
6
6
7
7
## 2. Casing
8
8
- Acronyms SHOULD follow the casing conventions as though they were regular words (e.g. Url).
9
-
- All identifiers including namespaces, entityTypes, entitySets, properties, actions, functions and enumeration values SHOULD use lowerCamelCase.
9
+
- All identifiers including namespaces, entityTypes, entitySets, properties, actions, functions and enumeration values MUST use lowerCamelCase.
10
10
- HTTP headers are the exception and SHOULD use standard HTTP convention of Capitalized-Hyphenated-Terms.
1.`displayName` can be set to any value other than `null`
103
103
2. The response body here is provided for clarity, and is not part of the guidance itself. The [OData v4.01 standard](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) states that the workload can decide the behavior.
104
104
105
-
### {5} Update the foo property of a service principal to null
105
+
### 5. Update the foo property of a service principal to null
1.`foo` can be set to `null` because it has be marked with `Nullable="true"` in the CSDL.
124
124
2. The response body here is provided for clarity, and is not part of the guidance itself. The [OData v4.01 standard](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) states that the workload can decide the behavior.
125
125
126
-
### {6} Update the foo property of a service principal to a non-default value
126
+
### 6. Update the foo property of a service principal to a non-default value
1.`foo` can be set to `something other than testval`
145
145
2. The response body here is provided for clarity, and is not part of the guidance itself. The [OData v4.01 standard](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) states that the workload can decide the behavior.
146
146
147
-
### {7} Update the bar property of a service principal to null
147
+
### 7. Update the bar property of a service principal to null
2. The response body here is provided for clarity, and is not part of the guidance itself. The [OData v4.01 standard](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_UpdateanEntity) states that the workload can decide the behavior.
186
186
187
-
### {9} Create a service principal while customizing the display name
187
+
### 9. Create a service principal while customizing the display name
188
188
```HTTP
189
189
POST /servicePrincipals
190
190
{
@@ -206,7 +206,7 @@ Notes:
206
206
2.`foo` has the default value as specified by its `DefaultValue` attribute in the CSDL
207
207
3.`bar` has the default value as specified by its `DefaultValue` attribute in the CSDL
208
208
209
-
### {10} Create a service principal with a null display name
209
+
### 10. Create a service principal with a null display name
210
210
```HTTP
211
211
POST /servicePrincipals
212
212
{
@@ -225,7 +225,7 @@ POST /servicePrincipals
225
225
Notes:
226
226
1.`displayName` isn't required to create a new `servicePrincipal`, but it *can* be provided; it *cannot* be provided as `null` because the property was marked with `Nullable="false"`
227
227
228
-
### {11} Create a service principal with a value for the foo property
228
+
### 11. Create a service principal with a value for the foo property
229
229
```HTTP
230
230
POST /servicePrincipals
231
231
{
@@ -247,7 +247,7 @@ Notes:
247
247
2.`foo` isn't required to create a new `servicePrincipal`, but it *can* be provided; this is orthogonal to whether or not the property has `Nullable="true"` or `Nullable="false"`.
248
248
3.`bar` has the default value as specified by its `DefaultValue` attribute in the CSDL
249
249
250
-
### {12} Create a service principal with null for the foo property
250
+
### 12. Create a service principal with null for the foo property
251
251
```HTTP
252
252
POST /servicePrincipals
253
253
{
@@ -269,7 +269,7 @@ Notes:
269
269
2.`foo` isn't required to create a new `servicePrincipal`, but it *can* be provided; because the property has `Nullable="true"`, a `null` value can be provided for it.
270
270
3.`bar` has the default value as specified by its `DefaultValue` attribute in the CSDL
271
271
272
-
### {13} Create a service principal with a value for the bar property
272
+
### 13. Create a service principal with a value for the bar property
273
273
```HTTP
274
274
POST /servicePrincipals
275
275
{
@@ -291,7 +291,7 @@ Notes:
291
291
2.`foo` has the default value as specified by its `DefaultValue` attribute in the CSDL
292
292
3.`bar` isn't required to create a new `servicePrincipal`, but it *can* be provided; this is orthogonal to whether or not the property has `Nullable="true"` or `Nullable="false"`.
293
293
294
-
### {14} Create a service principal with null for the bar property
294
+
### 14. Create a service principal with null for the bar property
There are some deviations from the base guidelines where Microsoft Graph API standards require that you do one of the following:
52
-
53
49
- For the RELO pattern, you should return the Location header that indicates the location of the resource.
54
50
- The API response says the targeted resource is being created by returning a 201 status code and the resource URI is provided in the Location header, but the response indicates that the request is not completed by including "Provisioning" status.
0 commit comments