Skip to content

Commit 7465ae0

Browse files
jumboduckFayeSGW
andcommitted
Release: get attestation by id (#624)
* Add --artifact-id flag to get attestation command * Tidy up tests and documentation --------- Co-authored-by: Faye <[email protected]>
1 parent 78b1ff9 commit 7465ae0

File tree

100 files changed

+266
-251
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

100 files changed

+266
-251
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"currentversion": "v2.11.35"}
1+
{"currentversion": "v2.11.36"}

docs.kosli.com/content/client_reference/kosli_get_attestation.md

Lines changed: 24 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,37 +2,39 @@
22
title: "kosli get attestation"
33
beta: false
44
deprecated: false
5-
summary: "Get attestation by name from a specified trail or artifact. "
5+
summary: "Get an attestation using its name or id. "
66
---
77

88
# kosli get attestation
99

1010
## Synopsis
1111

1212
```shell
13-
kosli get attestation ATTESTATION-NAME [flags]
13+
kosli get attestation [ATTESTATION-NAME] [flags]
1414
```
1515

16-
Get attestation by name from a specified trail or artifact.
17-
You can get an attestation from a trail or artifact using its name. The attestation name should be given
18-
WITHOUT dot-notation.
19-
20-
To get an attestation from a trail, specify the trail name using the --trail flag.
21-
To get an attestation from an artifact, specify the artifact fingerprint using the --fingerprint flag.
22-
23-
In both cases the flow must also be specified using the --flow flag.
16+
Get an attestation using its name or id.
2417

18+
You can get an attestation from a trail or artifact using its name. The attestation name should be given
19+
WITHOUT dot-notation.
20+
To get an attestation from a trail, specify the trail name using the `--trail` flag.
21+
To get an attestation from an artifact, specify the artifact fingerprint using the `--fingerprint` flag.
22+
These flags cannot be used together. In both cases the flow must also be specified using the `--flow` flag.
2523
If there are multiple attestations with the same name on the trail or artifact, a list of all will be returned.
2624

25+
You can also get an attestation by its id using the `--attestation-id` flag. This cannot be used with the attestation name,
26+
or any of the `--flow`, `--trail` or `--fingerprint` flags.
27+
2728

2829
## Flags
2930
| Flag | Description |
3031
| :--- | :--- |
31-
| -F, --fingerprint string | [conditional] The fingerprint of the artifact for the attestation. Cannot be used together with --trail. |
32-
| -f, --flow string | The Kosli flow name. |
32+
| --attestation-id string | [conditional] The unique identifier of the attestation to retrieve. Cannot be used together with ATTESTATION-NAME. |
33+
| -F, --fingerprint string | [conditional] The fingerprint of the artifact for the attestation. Cannot be used together with --trail or --attestation-id. |
34+
| -f, --flow string | [conditional] The name of the Kosli flow for the attestation. Required if ATTESTATION-NAME provided. Cannot be used together with --attestation-id. |
3335
| -h, --help | help for attestation |
3436
| -o, --output string | [defaulted] The format of the output. Valid formats are: [table, json]. (default "table") |
35-
| -t, --trail string | [conditional] The name of the Kosli trailfor the attestation. Cannot be used together with --fingerprint. |
37+
| -t, --trail string | [conditional] The name of the Kosli trail for the attestation. Cannot be used together with --fingerprint or --attestation-id. |
3638

3739

3840
## Flags inherited from parent commands
@@ -57,17 +59,24 @@ kosli get attestation snyk-container-scan --flow=differ-ci --fingerprint=0cbbe3a
5759

5860
These examples all assume that the flags `--api-token`, `--org`, `--host`, (and `--flow`, `--trail` when required), are [set/provided](https://docs.kosli.com/getting_started/install/#assigning-flags-via-environment-variables).
5961

60-
##### get an attestation from a trail (requires the --trail flag)
62+
##### get an attestation by name from a trail (requires the --trail flag)
6163

6264
```shell
6365
kosli get attestation attestationName
6466

6567
```
6668

67-
##### get an attestation from an artifact
69+
##### get an attestation by name from an artifact
6870

6971
```shell
7072
kosli get attestation attestationName
7173
--fingerprint fingerprint
74+
75+
```
76+
77+
##### get an attestation by its id
78+
79+
```shell
80+
kosli get attestation --attestation-id attestationID
7281
```
7382

docs.kosli.com/content/legacy_ref/v2.11.30/_index.md

Lines changed: 0 additions & 7 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: v2.11.31
33
bookCollapseSection: true
4-
weight: 603
4+
weight: 604
55
---
66

77
# v2.11.31
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: v2.11.32
33
bookCollapseSection: true
4-
weight: 602
4+
weight: 603
55
---
66

77
# v2.11.32
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: v2.11.33
33
bookCollapseSection: true
4-
weight: 601
4+
weight: 602
55
---
66

77
# v2.11.33
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: v2.11.34
33
bookCollapseSection: true
4-
weight: 600
4+
weight: 601
55
---
66

77
# v2.11.34
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: v2.11.35
3+
bookCollapseSection: true
4+
weight: 600
5+
---
6+
7+
# v2.11.35
File renamed without changes.

docs.kosli.com/content/legacy_ref/v2.11.30/kosli_allow_artifact.md renamed to docs.kosli.com/content/legacy_ref/v2.11.35/kosli_allow_artifact.md

File renamed without changes.

0 commit comments

Comments
 (0)