Skip to content
ADP
API Design PrincipleBETA

[ADP-705] Name Field Convention

Guidance

  • MAY prefix the name field with {resourceType} if there is potential for ambiguity or conflict.

Design Rationale

The name field is often a common attribute in resource objects. Prefixing it with the resource type clarifies whether the field refers to the name of the resource itself or something else.

Examples

May:

json
{
  "principleName": "My Principle"
}