Skip to content

Commit 1832e23

Browse files
committed
Some minor fixes to docs
Problem: Missing subject_label and incorrect asset_name Solution: Added subject_label and changed asset_name to asset_label Signed-off-by: Paul Hewlett <phewlett76@gmail.com>
1 parent 5cee62b commit 1832e23

2 files changed

Lines changed: 20 additions & 2 deletions

File tree

docs/runner/events_create.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ An example when releasing a software package as an sbom:
6969
- step:
7070
action: EVENTS_CREATE
7171
description: Release YYYYMMDD.1 of Test SBOM for YAML story
72-
asset_name: ACME Corporation Detector SAAS
72+
asset_label: ACME Corporation Detector SAAS
7373
print_response: true
7474
operation: Record
7575
behaviour: RecordEvidence
@@ -95,7 +95,7 @@ An example when releasing a software package as an sbom attachment:
9595
- step:
9696
action: EVENTS_CREATE
9797
description: Release YYYYMMDD.1 of Test SBOM for YAML story
98-
asset_name: ACME Corporation Detector SAAS
98+
asset_label: ACME Corporation Detector SAAS
9999
print_response: true
100100
operation: Record
101101
behaviour: RecordEvidence

docs/runner/generic.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ Each step follows the same pattern:
5353

5454
assets/add30235-1424-4fda-840a-d5ef82c4c96fa
5555

56+
when accessing a previously created asset. (i.e. not when creating an asset)
57+
5658
:location_label:
5759
For location create type actions (LOCATIONS_CREATE_IF_NOT_EXISTS) the label is used
5860
by the runner to keep track of locations.
@@ -66,4 +68,20 @@ Each step follows the same pattern:
6668

6769
locations/add30235-1424-4fda-840a-d5ef82c4c96fa
6870

71+
when accessing a previously created location. (i.e. not when creating a location)
72+
73+
:subject_label:
74+
For subject create type actions (SUBJECTS_CREATE) the label is used
75+
by the runner to keep track of subjects.
76+
77+
For other actions which require access to a subject, this value is used as a key to
78+
obtain the identity of such a previously-created subject.
79+
80+
In this way one can create subjects and then refer to them in later steps of the story.
81+
82+
Additionally this label can be an explicit subject identity of the form:
83+
84+
subjects/add30235-1424-4fda-840a-d5ef82c4c96fa
85+
86+
when accessing a previously created subject. (i.e. not when creating a subject)
6987

0 commit comments

Comments
 (0)