Skip to content

Commit 6ee895b

Browse files
committed
docs: updated examples and explanation for header.url
Signed-off-by: Eddie Knight <knight@linux.com>
1 parent b49e62d commit 6ee895b

File tree

7 files changed

+18
-18
lines changed

7 files changed

+18
-18
lines changed

docs/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ The version of the Security Insights schema being used.
8989

9090
### `header.url`
9191

92-
The primary reference URL for this schema’s origin or repository.
92+
The original URL for the current Security Insights file. This should point to the canonical location where the file is hosted (e.g., a raw file URL in a version control system). This helps preserve context when the file is extracted from its source. This may also be referenced to help readers find the latest version of the security insights file, in the event that they are accessing it from an outdated source, such as a past release artifact. This is not to be confused with the URL for the project. Project URLs should be specified in `project.repositories` instead.
9393

9494
- **Type**: [URL]
9595

examples/example-full.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ header:
22
schema-version: 2.0.0
33
last-updated: '2025-03-01'
44
last-reviewed: '2025-04-01'
5-
url: https://example.com/foo/bar
5+
url: https://example.com/foo/bar/raw/branch/main/security-insights.yml
66
comment: |
77
This file contains all possible information for both project and repository,
88
though it is not required to include all of this information every time.
@@ -33,11 +33,11 @@ project:
3333
signature-verification: https://example.com/signature-verification
3434
repositories:
3535
- name: Foo
36-
url: https://vcs.example.com/foobar/foo
36+
url: https://example.com/foobar/foo
3737
comment: |
3838
Foo is the core repo for FooBar.
3939
- name: Bar
40-
url: https://vcs.example.com/foobar/bar
40+
url: https://example.com/foobar/bar
4141
comment: |
4242
Bar is a subproject repo.
4343
vulnerability-reporting:

examples/example-minimum.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ header:
22
schema-version: 2.0.0
33
last-updated: '2025-03-01'
44
last-reviewed: '2025-04-01'
5-
url: https://example.com/kubernetes/kubernetes
5+
url: https://example.com/foo/bar/raw/branch/main/security-insights.yml
66
comment: |
77
This file contains the minimum information for both project and repository.
88
It not required to include both a project and repository section if the project
@@ -18,15 +18,15 @@ project:
1818
primary: true
1919
repositories:
2020
- name: Foo
21-
url: https://vcs.example.com/foobar/foo
21+
url: https://example.com/foobar/foo
2222
comment: |
2323
Foo is the core repo for FooBar.
2424
vulnerability-reporting:
2525
reports-accepted: true
2626
bug-bounty-available: true
2727

2828
repository:
29-
url: https://vcs.example.com/foobar/foo
29+
url: https://example.com/foobar/foo
3030
status: active
3131
accepts-change-request: true
3232
accepts-automated-change-request: true

examples/example-multi-repository-project-reuse.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Repository template for a multi-repository project
2-
# This file would be stored in the https://vcs.example.com/foobar/bar repository
2+
# This file would be stored in the https://example.com/foobar/bar repository
33
header:
44
schema-version: 2.0.0
55
last-updated: '2025-03-01'
66
last-reviewed: '2025-04-01'
7-
url: https://example.com/kubernetes/kubernetes
7+
url: https://example.com/foo/bar/raw/branch/main/security-insights.yml
88
project-si-source: https://raw.githubusercontent.com/example/repo/refs/heads/main/security-insights.yml
99

1010
repository:
11-
url: https://vcs.example.com/foobar/bar
11+
url: https://example.com/foobar/bar
1212
status: active
1313
accepts-change-request: true
1414
accepts-automated-change-request: true

examples/example-multi-repository-project.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Project and repository template for a multi-repository project
2-
# This file would be stored in the https://vcs.example.com/foobar/foo repository
3-
# and addressable via https://vcs.example.com/foobar/foo/security-insights.yml
2+
# This file would be stored in the https://example.com/foobar/foo repository
3+
# and addressable via https://example.com/foobar/foo/security-insights.yml
44
header:
55
schema-version: 2.0.0
66
last-updated: '2025-03-01'
77
last-reviewed: '2025-04-01'
8-
url: https://example.com/kubernetes/kubernetes
8+
url: https://example.com/foo/bar/raw/branch/main/security-insights.yml
99
comment: |
1010
This file contains the minimum information for both project and repository.
1111
It not required to include both a project and repository section if the project
@@ -21,19 +21,19 @@ project:
2121
primary: true
2222
repositories:
2323
- name: Foo
24-
url: https://vcs.example.com/foobar/foo
24+
url: https://example.com/foobar/foo
2525
comment: |
2626
Foo is the core repo for FooBar.
2727
- name: Bar
28-
url: https://vcs.example.com/foobar/bar
28+
url: https://example.com/foobar/bar
2929
comment: |
3030
Bar is also part of the FooBar project.
3131
vulnerability-reporting:
3232
reports-accepted: true
3333
bug-bounty-available: true
3434

3535
repository:
36-
url: https://vcs.example.com/foobar/foo
36+
url: https://example.com/foobar/foo
3737
status: active
3838
accepts-change-request: true
3939
accepts-automated-change-request: true

spec/schema.cue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ import (
125125
// The version of the Security Insights schema being used.
126126
"schema-version": #SchemaVersion @go(SchemaVersion)
127127

128-
// The primary reference URL for this schema’s origin or repository.
128+
// The original URL for the current Security Insights file. This should point to the canonical location where the file is hosted (e.g., a raw file URL in a version control system). This helps preserve context when the file is extracted from its source. This may also be referenced to help readers find the latest version of the security insights file, in the event that they are accessing it from an outdated source, such as a past release artifact. This is not to be confused with the URL for the project. Project URLs should be specified in `project.repositories` instead.
129129
url: #URL @go(URL)
130130

131131
// Additional information about the schema.

spec/schema.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The version of the Security Insights schema being used.
8282

8383
### `header.url`
8484

85-
The primary reference URL for this schema’s origin or repository.
85+
The original URL for the current Security Insights file. This should point to the canonical location where the file is hosted (e.g., a raw file URL in a version control system). This helps preserve context when the file is extracted from its source. This may also be referenced to help readers find the latest version of the security insights file, in the event that they are accessing it from an outdated source, such as a past release artifact. This is not to be confused with the URL for the project. Project URLs should be specified in `project.repositories` instead.
8686

8787
- **Type**: [URL]
8888

0 commit comments

Comments
 (0)