Skip to content

Commit a4b18ac

Browse files
committed
Updated with endpoint rules
1 parent 7a5f473 commit a4b18ac

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

STYLEGUIDE.md

+10
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,16 @@ For general software-industry styles and terminology, see the [Microsoft Writing
110110
| Mar. 15 | March 15 |
111111
| 15 March 2048 | March 15, 2048 |
112112

113+
* Endpoint names should be capitalized when used in-text: Discovery endpoint, Authorization endpoint, Token endpoint.
114+
* Endpoints with names longer than one or two words should also be capitalized with the exception of prepositions and articles (i.e. with, to, the, a, an) such as Update a Hook endpoint.
115+
* Endpoint names denoted as a path should not be capitalized but should be in monospace font: `/authorize,` `/post_user_import`
116+
117+
| **Incorrect** | **Correct** |
118+
| --- | --- |
119+
| You will need to access the discovery endpoint. | You will need to access the Discovery endpoint.|
120+
| The get user endpoint allows you to search based on a variety of criteria. | The Get User endpoint allows you to search based on a variety of criteria. |
121+
| The POST /login/callback endpoint can accept a sing-on SAML request from an identity provider. | The POST '/login/callback' endpoint can accept a sing-on SAML request from an identity provider. |
122+
113123
* Spell out whole numbers from zero to nine.
114124
* Write numerically numbers from 10 up and fractions.
115125
* Spell out any number that starts a sentence.

0 commit comments

Comments
 (0)