Skip to content

Commit 09a17f8

Browse files
tiegzandrewpollock
andauthored
Clarify sentence about "last_affected" and "fixed" in docs. (#310)
From the docs: > Entries in the events array can contain either "last_affected" or "fixed" events, but not both. This line could be referring to either of these events arrays: ``` json { "events": [ {"introduced": "0.0.0"}, {"last_affected": "1.0.0", "fixed": "1.0.1"} ] } ``` ``` json { "events": [ {"introduced": "0.0.0"}, {"last_affected": "1.0.0"}, {"fixed": "1.0.1"} ] } ``` The first one is invalid because it has an Object that contains two entries, but that is covered by this line from the docs: > Only a single type (either introduced, fixed, last_affected, limit) is allowed in each event object. And according to this comment I think the **latter** invalid case is the one that is being referred to: #146 (comment) So I suggest changing the wording to be more specific: > An events array can have entries containing either "last_affected" or "fixed" events, but not both. --------- Signed-off-by: Tieg Zaharia <[email protected]> Signed-off-by: Tieg Zaharia <[email protected]> Co-authored-by: Andrew Pollock <[email protected]>
1 parent 9d03e8f commit 09a17f8

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/schema.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,8 +1058,8 @@ Only **a single type** (either `introduced`, `fixed`, `last_affected`,
10581058
`limit`) is allowed in each event object. For instance,
10591059
`{"introduced": "1.0.0", "fixed": "1.0.2"}` is **invalid**.
10601060

1061-
Entries in the `events` array can contain either `last_affected` or `fixed`
1062-
events, but not both. It's **strongly recommended** to use `fixed` instead of
1061+
Entries in the `events` array may be "last_affected" or "fixed" events,
1062+
but not both. It's **strongly recommended** to use `fixed` instead of
10631063
`last_affected` where possible, as it precisely identifies the version which
10641064
contains the fix. `last_affected` should be thought of as the hard ceiling
10651065
of the vulnerability _at the time of publication_ in the absence of a fixed version.

0 commit comments

Comments
 (0)