Skip to content

Commit 21e1d4c

Browse files
authored
Update JSON.md to discuss issue severity/isFailure fields. (#1657)
These fields were added in Swift 6.3 but we neglected to update JSON.md to describe them. The fields are optional because they are not present prior to the 6.3 schema version. ### Checklist: - [x] Code and documentation should follow the style of the [Style Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md). - [x] If public symbols are renamed or modified, DocC references should be updated.
1 parent ceb905b commit 21e1d4c

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

Documentation/ABI/JSON.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,8 @@ sufficient information to display the event in a human-readable format.
214214
215215
<issue> ::= {
216216
"isKnown": <bool>, ; is this a known issue or not?
217+
"severity": <string>, ; the severity of the issue
218+
"isFailure": <bool>, ; if the issue is a failing issue
217219
["sourceLocation": <source-location>,] ; where the issue occurred, if known
218220
}
219221
@@ -243,7 +245,7 @@ sufficient information to display the event in a human-readable format.
243245
|:-|-|-:|-:|
244246
| [ST-0002](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0002-json-abi.md) | Introduced the initial version of this JSON schema. | 6.0 | `0` |
245247
| [ST-0009](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0009-attachments.md#integration-with-supporting-tools) | Added attachments. | 6.2 | `0` |
246-
| [ST-0013](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0013-issue-severity-warning.md#event-stream) | Added test issue severity. | 6.3 | `"6.3"` |
248+
| [ST-0013](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0013-issue-severity-warning.md#event-stream) | Added test issue `severity` and `isFailure`. | 6.3 | `"6.3"` |
247249
| [ST-0016](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0016-test-cancellation.md#integration-with-supporting-tools) | Added test cancellation. | 6.3 | `"6.3"` |
248250
| [ST-0019](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0019-include-tags-bugs-and-timeline-in-event-stream.md#json-schema-changes) | Added `tags`, `bugs`, and `timeLimit`. | 6.4 | `"6.4"` |
249251
| [ST-0020](https://github.com/swiftlang/swift-evolution/blob/main/proposals/testing/0020-sourcelocation-filepath.md#detailed-design) | Added `filePath`. | 6.3 | `"6.3"` |

0 commit comments

Comments
 (0)