Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AssessAction entity names - should they include statuses? #10

Open
beforan opened this issue Jun 12, 2023 · 2 comments
Open

AssessAction entity names - should they include statuses? #10

beforan opened this issue Jun 12, 2023 · 2 comments
Milestone

Comments

@beforan
Copy link

beforan commented Jun 12, 2023

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 :)

@stain
Copy link
Member

stain commented Jun 12, 2023

Agree now, might be more consistent to not reflect the status in name. It could be misleading if they are not matching after an update. Perhaps status can be detailed in description textually (which may be a multi-line log) but that the normative status is in the actionStatus.

Also if there is some detail report of the action (e.g. programmatic validation log file, or manual checklist) then perhaps that needs to be associated as a separate CreativeWork entity from the action's subjectOf -- not sure if we should recommend that or leave it open.

@stain
Copy link
Member

stain commented Jun 12, 2023

https://schema.org/startTime includes "The startTime of something. For a reserved event or service (e.g. FoodEstablishmentReservation), the time that it is expected to start. For actions that span a period of time, when the action was performed" and vice versa for https://schema.org/endTime -- so that was my thinking to only include predicted startTime for a scheduled or in progress event, and only add endTime if it is completed or failed.

@stain stain added this to the 0.4 milestone Jun 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants