← Prev in month ← Prev in thread
Next in thread → Next in month →

Change draft for #242: UTC property names

From
Larry Golding (Myriad Consulting Inc) <>
Date
2018-09-18T17:03:23+00:00
ID
Thread
Change draft for #242: UTC property names
I pushed a change draft for 
Issue #242, “Rename startTime/endTime to startTimeUtc and endTimeUtc”:

 

Documents/ChangeDrafts/Active/sarif-v2.0-issue-242-UTC-times.docx

 

We will move its adoption at TC #24 on Wednesday 9/26.

 

The motivation for the change is that a customer, not understanding that the spec required times to be UTC, erroneously set
invocation.startTime to the local time. That caused a problem because the SARIF SDK automatically (and correctly) set
invocation.endTime to a UTC time. Adding “-Utc” to the property names will mitigate this confusion.

 

While I was at it, I inventoried all the date/time property names and decided that there were two other issues:

 

We inconsistently used “time” in some names and “timestamp” in others.

We were not always sufficiently explicit about what the time(stamp) referred to.

 

So in summary, I propose the following renames:

 

invocation.startTime =>
startTimeUtc

invocation.endTime =>
endTimeUtc

file.lastModifiedTime =>
lastModifiedTimeUtc

versionControlDetails.timestamp =>
revisionTimeUtc (which, by the was is consistent with
versionControlDetails.revisionId)

threadFlowLocation.timestamp =>
executionTimeUtc

notification.time =>
notification.timeUtc (“notification.notificationTimeUtc” seemed unnecessarily redundant but I’m willing to be persuaded on that point)

 

Thanks,

Larry
← Prev in month ← Prev in thread
Next in thread → Next in month →