Document:
03350: Ballot 02b: revised design changes + change drafts for issues #321 and #335

Draft (A preliminary unapproved sketch, outline, or version.)

Details

Submitted By David Keaton on 2019-03-23 5:01 am UTC

Publication Type

None at this time.

Group / Folder

OASIS Static Analysis Results Interchange Format (SARIF) TC / System Ballot Results

Modified by

Not modified.

Copy

This document is not a copy.

Technical Contact

None at this time.

Download Count

195

Download Agreement

None at this time.

Description

The design changes for issues #321 and #335 were previously approved, but adjustments were made afterward. Shall the adjustments be approved, and shall the resulting change draft be approved? The change draft is referenced in this ballot. The change draft is for the following two issues. https://github.com/oasis-tcs/sarif-spec/issues/321 https://github.com/oasis-tcs/sarif-spec/issues/335 The provisional draft with the changes for all ballots merged is here: https://github.com/oasis-tcs/sarif-spec/blob/master/Documents/ProvisionalDrafts/sarif-v2.0-csd02-provisional.docx ----- Adjustments to issue #321: Erratum: The name of the new property should be sarifLog.inlineExternalProperties, not inlineExternalPropertyFiles, and it is an array of externalProperties objects (as defined in §4.3 of the spec), not externalPropertyFile objects. If you look at all the examples above, you'll see that they really are arrays of externalProperties objects. @kupsch's first example proposed to name the new property inlineExternalFiles, which would be ok. Later in the thread, I proposed inlineExternalProperties, as suggested here, which I prefer because it matches the name of the objects in the array. "inlineExternalPropertyFiles", as we proposed in the ballot, is just wrong. There is an object in the spec called externalPropertyFile, but it is just a "locator" for an external file. Our new sarifLog property contains the contents of "external" files, not locators for them. ----- Adjustments to issue #335: In the externalProperties object: Rename the instanceGuid property to guid. Rename the properties property to externalizedProperties. Add a property named properties that is a property bag. In the externalPropertyFile object: Rename the object to externalPropertyFileReference. Rename the instanceGuid property to guid. Rename the artifactLocation property property to location. With regard to the run.externalPropertyFiles property, and the object it contains: Rename it to run.externalPropertyFileReferences. Change the name of the contained object’s properties property to externalizedProperties. Remove the run. prefix from the property names.