Skip to content

Meaning of {{API_NAME}}.{{SPECIFIC_CODE}} #538

@tlohmar

Description

@tlohmar

Problem description

NOTE 2: A {{SPECIFIC_CODE}}, unless it may have traversal scope (i.e. re-usable among different APIs), SHALL follow this scheme for a specific API: {{API_NAME}}.{{SPECIFIC_CODE}}

The Note in the syntax exceptions table in Section 3 is not clear.

  1. Is the value of {{API_NAME}} referring to a value like the <api-name> of the Servers Object (link)?
  2. What is the meaning of the double curly brackets ({{...}})? Does that refer to a substitution like in Python's str.format() method?

Expected action

Clarify the API design guidelines.

Additional context

Metadata

Metadata

Assignees

No one assigned

    Labels

    Spring26Scope of Spring26 (H1-2026) meta-releasedocumentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions