Skip to content

Better signal where behaviour is in parameter descriptions #208

Description

@j616

Context
We've had a few cases where implementers have missed behaviour of TAMS which is described in parameter descriptions. i.e. where a parameter is not just behaving as a place to store a fixed value. We should figure out a way to make these cases easier to spot. Perhaps using an emoji, like we've done to call out exceptions to a basic CRUD -> HTTP methods mapping in the auth app note. See also Github's approach to "Alert" boxes in markdown.

Actions

  • Figure out a way to signal important behavioural implementation in descriptions in the TAMS spec
  • Add this approach across the spec where required

Outcome

  • Changes to TAMS spec descriptions as required

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Fields

    No fields configured for Task.

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions