Skip to main content

IPA-113: Singleton Resources

An API may define singleton resources. A singleton resource must always exist by virtue of the existence of its parent, with one and exactly one per parent.

State

Adopt

Guidance​

  • Singleton resources must not have a user-provided or system-generated ID
  • Singleton resources must not define the Create or Delete standard methods
    • The singleton is implicitly created or deleted when its parent is created or deleted
  • Singleton resources should define the Get and Update methods
  • Singleton resources may define custom methods as appropriate

Example

GET /groups/${groupId}/settings
###
PATCH /groups/${groupId}/settings