Skip to content

Commit

Permalink
Change draft + merge for #319: multiformatMessageString
Browse files Browse the repository at this point in the history
  • Loading branch information
Larry Golding committed Mar 16, 2019
1 parent 3c7273c commit 8bf2605
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 1 deletion.
Binary file not shown.
Binary file modified Documents/ProvisionalDrafts/sarif-v2.0-csd02-provisional.docx
Binary file not shown.
26 changes: 26 additions & 0 deletions Documents/Schema changes between SARIF v1 and v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -1381,6 +1381,32 @@ Start of changes for CSD.2

- Add a property `threadFlowLocations` of type `threadFlowLocations[]`, optional, unique, minItems: 0, default: empty array

- [Issue #319](https://github.com/oasis-tcs/sarif-spec/issues/319): "Converge all messages into a common format strings object"

Define a `multiformatMessageString` object with the following properties:

- `text` of type string, non-empty, required.
- `markdown` of type string, non-empty, optional.

In the `resource` object (or in the `toolComponent` object, if that change happened first):

- Change the type of the `messageStrings` property from `object` with `string`-valued properties to `object` with `multiformatMessageString`-valued properties.

In the `rule` object (or in the `reportingDescriptor` object, if that rename happened first):

- Change the type of the `messageStrings` property from `object` with `string`-valued properties to `object` with `multiformatMessageString`-valued properties.
- Change the type of the `help` property from `string` to `multiformatMessageString`.
- Remove the `richMessageStrings` property.
- Change the type of the `help` property from `message` to `multiformatMessageString`.

In the `message` object:

- Rename the `richText` property to `markdown`.
- Remove the `richMessageId` property.

In the `run` object:

- Remove the `richMessageMimeType` property.

## Changes not yet approved

Expand Down
6 changes: 5 additions & 1 deletion EditorsReports/Editor's report 2019-04-03.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Presented at TC Meeting #34, April 3th, 2019
We decided to reject this because the "driver" component might consist of multiple files, and here we particularly want to specify the primary executable,
that is, the file containing the entry point. So `executableLocation` is good.

1. The following change drafts were available prior to TC #33 and they are still available:
1. The following change drafts were available prior to TC #33, but were inadvertently omitted from the Editor's Report:

1. [Issue #291](https://github.com/oasis-tcs/sarif-spec/issues/291): "Update logical location kinds to accommodate XML and JSON paths"

Expand All @@ -27,6 +27,8 @@ Presented at TC Meeting #34, April 3th, 2019

1. [Issue #309](https://github.com/oasis-tcs/sarif-spec/issues/309): "Rename run.files to run.artifacts, fileLocation to artifactLocation."

1. [Issue #319](https://github.com/oasis-tcs/sarif-spec/issues/319): "Converge all messages into a common format strings object"

1. Combined change draft for:

- [Issue #321](https://github.com/oasis-tcs/sarif-spec/issues/321): "Provide mechanism for inlining externalized properties data into the root log"
Expand All @@ -38,3 +40,5 @@ Presented at TC Meeting #34, April 3th, 2019
1. Change drafts were made available for the following issues which had _not_ previously been "design approved" by the TC:

1. [Issue #168](https://github.com/oasis-tcs/sarif-spec/issues/168): "Consider adding codeflow.state to capture initial execution state for things like static variables"

1. [Issue #168](https://github.com/oasis-tcs/sarif-spec/issues/168):

0 comments on commit 8bf2605

Please sign in to comment.