Skip to content

Commit

Permalink
Dpe 135 naming rules (#88)
Browse files Browse the repository at this point in the history
Removed reference to rule that doesn't existing in naming.md

---------

Signed-off-by: Ethan Honzik <[email protected]>
Co-authored-by: Brandon Sahadeo <[email protected]>
  • Loading branch information
EthanHonzikSPS and brandonsahadeo authored Jul 22, 2024
1 parent 7a49a50 commit 08c542b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion standards/naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ When you consider the names to use for your path, endpoints and other components
- Names **MUST** be different for different concepts.
- Overly general names that are ambiguous within the context of the API and the larger ecosystem of APIs **MUST** be avoided (i.e. "identity", "notification-service", etc). They can lead to a misunderstanding of API concepts. Rather, choose specific names that accurately describe the API concept. - This is particularly important for names that define first-order API elements, such as resources. There is no definitive list of names to avoid, as every name must be evaluated in the context of other names.
- Names that may conflict with keywords in common programming languages **SHOULD NOT** be used. <a name="sps-no-keyword-conflicts" href="#sps-no-keyword-conflicts"><i class="fa fa-check-circle" title="#sps-no-keyword-conflicts"></i></a>
- Names **SHOULD** use abbreviations instead of long form names. <a name="sps-mandate-abbreviations-identifier" href="#sps-mandate-abbreviations-identifier"><i class="fa fa-check-circle" title="#sps-mandate-abbreviations-identifier"></i></a> <a name="sps-mandate-abbreviations-reference" href="#sps-mandate-abbreviations-reference"><i class="fa fa-check-circle" title="#sps-mandate-abbreviations-reference"></i></a> <a name="sps-mandate-abbreviations-organization" href="#sps-mandate-abbreviations-organization"><i class="fa fa-check-circle" title="#sps-mandate-abbreviations-organization"></i></a>
- Names **SHOULD** use abbreviations instead of long form names. <a name="sps-mandate-abbreviations-identifier" href="#sps-mandate-abbreviations-identifier"><i class="fa fa-check-circle" title="#sps-mandate-abbreviations-identifier"></i></a> <a name="sps-mandate-abbreviations-organization" href="#sps-mandate-abbreviations-organization"><i class="fa fa-check-circle" title="#sps-mandate-abbreviations-organization"></i></a>

## Text

Expand Down

0 comments on commit 08c542b

Please sign in to comment.