Skip to content

AssessAction entity names - should they include statuses? #10

Description

@beforan

Looking at the example in draft 0.4 of a Disclosure Phase AssessAction:

{  
  "@id": "#disclosure-b16c1f0a-ae7f-4582-9b28-7d9df3313e27",
  "type": "AssessAction",
  "name": "Disclosure check of workflow results: pending (estimate: 1 week)",
  // ...
  "actionStatus": "http://schema.org/PotentialActionStatus"
}

Here the name property includes commentary on the status: pending (estimate: 1 week).

  • Is it useful or appropriate to put this status information here?
    • the actual action status has its own well defined property actionStatus
  • If so, is it appropriate or problematic to be updating the entity name when status changes?
    • e.g. to Disclosure check of workflow results: completed
    • I realise the id is unchanging and is the canonical unique identifier for the entity, so perhaps changing the name is acceptable, but it seems odd
  • Should/Can the additional status commentary such as estimates of assessment duration in a pending state be recorded in a well defined property instead?
    • I don't know if this is useful or overkill, but if modifying the name is deemed undesirable, then doing this will be necessary to retain the pending estimate, or other status information such as reasons for disclosure check failure.

Happy to hear thoughts :)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions