Skip to content

Commit 18f7cd3

Browse files
committed
docs: Updated context and examples for header.url
Signed-off-by: Eddie Knight <knight@linux.com>
1 parent e74d6af commit 18f7cd3

File tree

6 files changed

+12
-8
lines changed

6 files changed

+12
-8
lines changed

examples/example-full.yml

Lines changed: 1 addition & 1 deletion
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.

examples/example-minimum.yml

Lines changed: 1 addition & 1 deletion
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

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ 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
8-
project-si-source: https://raw.githubusercontent.com/example/repo/refs/heads/main/security-insights.yml
7+
url: https://example.com/foo/bar/raw/branch/main/security-insights.yml
8+
project-si-source: https://example.com/foo/baz/refs/heads/main/security-insights.yml
99

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

examples/example-multi-repository-project.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ 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/foobar/foo/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

spec/header.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,11 @@ The `header` object captures high-level metadata about the schema.
2828
## `header.url`
2929

3030
- **Type**: [URL]
31-
- **Description**: The primary reference URL for this schema’s origin or repository.
31+
- **Description**: The original URL for this 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.
32+
33+
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.
34+
35+
This is not to be confused with the URL for the project. Project URLs should be specified in `project.repositories` instead.
3236

3337
---
3438

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.
129129
url: #URL @go(URL)
130130

131131
// Additional information about the schema.

0 commit comments

Comments
 (0)