-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Eddie Knight <[email protected]>
- Loading branch information
1 parent
29bd586
commit df44640
Showing
8 changed files
with
379 additions
and
517 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| # Aliases | ||
|
|
||
| The following aliases are used throughout the schema. | ||
|
|
||
| ## `assessment` | ||
|
|
||
| ### `assessment.name` | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: The name or identifier of the assessment artifact. | ||
|
|
||
| ### `assessment.evidence` | ||
|
|
||
| - **Type**: [URL] | ||
| - **Matches Pattern**: `^https?://[^\\s]+$` | ||
| - **Description**: The URL where the assessment report or artifact is located. | ||
|
|
||
| ### `assessment.date` | ||
|
|
||
| - **Type**: [Date] | ||
| - **Description**: The date the assessment was published. | ||
|
|
||
| ### `assessment.comment` | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: Notes or commentary about the findings or purpose of the assessment. | ||
|
|
||
| --- | ||
|
|
||
| ## `attestation` | ||
|
|
||
| A list of objects describing various release attestations or artifacts. | ||
|
|
||
| ### `attestation.name` | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: The name or identifier of the attestation. | ||
|
|
||
| ### `attestation.location` | ||
|
|
||
| - **Type**: [URL] | ||
| - **Description**: A web location where the attestation can be found. | ||
|
|
||
| ### `attestation.predicate-uri` | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: A URI to a resource describing the attestation’s predicate or specification. | ||
|
|
||
| ### `attestation.comment` | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: Additional context or instructions for using the attestation. | ||
|
|
||
| --- | ||
|
|
||
| ## `contact` | ||
|
|
||
| - `contact.name` | ||
| - **Type**: `string` | ||
| - **Description**: The contact person's name. | ||
| - `contact.primary` | ||
| - **Type**: `bool` | ||
| - **Description**: Indicates whether this admin is the first point of contact for inquiries. Only one entry should be marked as primary. | ||
| - `contact.affiliation` (optional) | ||
| - **Type**: `string` | ||
| - **Description**: The entity with which the contact is affiliated, such as a school or employer. | ||
| - `contact.email` (optional) | ||
| - **Type**: [Email] | ||
| - **Description**: A preferred email address to reach the contact. | ||
| - `contact.social` (optional) | ||
| - **Type**: `string` | ||
| - **Description**: A social media handle or profile for the contact. | ||
|
|
||
| --- | ||
|
|
||
| ## `license` | ||
|
|
||
| - `license.url` | ||
| - **Type**: [URL] | ||
| - **Description**: A web address where the license can be found. | ||
| - `license.expression` | ||
| - **Type**: `string` | ||
| - **Description**: The SPDX license expression for the license. | ||
|
|
||
| --- | ||
|
|
||
| ## `link` | ||
|
|
||
| - `link.uri` | ||
| - **Type**: `string` | ||
| - **Description**: A link to a resource, not restricted to http/s. | ||
| - `link.comment` | ||
| - **Type**: `string` | ||
| - **Description**: Instructions or information about the link. | ||
|
|
||
| --- | ||
|
|
||
| ## Validation Types | ||
|
|
||
| - `date` | ||
| - **Type**: `string` | ||
| - **Description**: A date in ISO 8601 format (`YYYY-MM-DD`). | ||
| - `email` | ||
| - **Type**: `string` | ||
| - **Matches Pattern**: `^[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,}$` | ||
| - `url` | ||
| - **Type**: `string` | ||
| - **Matches Pattern**: `^https?://[^\\s]+$` | ||
|
|
||
| --- | ||
|
|
||
| [URL]: #url | ||
| [Email]: #email | ||
| [Date]: #date |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,51 @@ | ||
| # Header | ||
| # `header` | ||
|
|
||
| The `header` object provides high-level information about the project schema. | ||
| The `header` object captures high-level metadata about the schema. | ||
|
|
||
| This section is **required**. | ||
|
|
||
| ```yaml | ||
| header: | ||
| schema-version: 1.0.0 | ||
| last-updated: '2021-09-01' | ||
| last-reviewed: '2022-09-01' | ||
| repo-url: https://foo.bar | ||
| repo-status: active | ||
| ``` | ||
| --- | ||
|
|
||
| ## `header.last-reviewed` | ||
|
|
||
| ## `header.schema-version` | ||
| - **Type**: `string` | ||
| - **Description**: *[Add description here]* | ||
| - **Example**: *[Add example here]* | ||
| - **Type**: [Date] | ||
| - **Description**: The date when the document or data was last reviewed. | ||
|
|
||
| --- | ||
|
|
||
| ## `header.last-updated` | ||
| - **Type**: `string` | ||
| - **Description**: *[Add description here]* | ||
| - **Example**: *[Add example here]* | ||
|
|
||
| - **Type**: [Date] | ||
| - **Description**: The date when this document or data was last updated. | ||
|
|
||
| --- | ||
|
|
||
| ## `header.last-reviewed` | ||
| ## `header.schema-version` | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: *[Add description here]* | ||
| - **Example**: *[Add example here]* | ||
| - **Description**: Represents the version of this schema. | ||
|
|
||
| --- | ||
|
|
||
| ## `header.repo-url` | ||
| - **Type**: `string` | ||
| - **Matches Pattern**: `^https?://[^\\s]+$` | ||
| - **Description**: *[Add description here]* | ||
| - **Example**: *[Add example here]* | ||
| ## `header.url` | ||
|
|
||
| - **Type**: [URL] | ||
| - **Description**: The primary reference URL for this schema’s origin or repository. | ||
|
|
||
| --- | ||
|
|
||
| ## `header.repo-status` | ||
| ## `header.comment` (optional) | ||
|
|
||
| - **Type**: `string` | ||
| - **Description**: *[Add description here]* | ||
| - **Example**: *[Add example here]* | ||
| - **Description**: Additional information about the schema. | ||
|
|
||
| --- | ||
|
|
||
| ## `header.project-si-source` (optional) | ||
|
|
||
| - **Type**: [URL] | ||
| - **Description**: A URL to the security insights file that contains project information for this file to inherit. | ||
|
|
||
| --- | ||
|
|
||
| > **Note**: Each field should be assigned a value consistent with its specified data type and/or regular expression pattern. Fields not marked as optional are required. | ||
| [URL]: #url | ||
| [Email]: #email | ||
| [Date]: #date |
Oops, something went wrong.