Skip to content

Key Terms

Within this document, the keywords “MUST”, “MUST NOT”, “SHOULD”, “SHOULD NOT”, and “MAY” are to be interpreted as described in the table below. Note that “MUST” is not intended to convey that publishing an API may be blocked if it does not comply but that the API MUST look and behave this way if we are to achieve a cohesive, consistent experience across the whole platform catalog.

KeywordInterpretation
MUSTAdherence is critical to a consistent client-side developer experience.
MUST NOTAvoidance is critical to a consistent client-side developer experience.
SHOULDAdherence is recommended for a good client-side developer experience.
SHOULD NOTAvoidance is recommended for a good client-side developer experience.
MAYEncouraged. The client-side developer experience won’t be negatively impacted if this is not implemented.