Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README to make URLs clickable #333

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README to make URLs clickable #333

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,31 @@ cve-schema specifies the CVE record format. This is the blueprint for a rich set

### Learn

Learn more about the CVE program at: https://www.cve.org/
Learn more about the CVE program at: [cve.org](https://www.cve.org/)

This CVE record format is defined using JSON Schema. Learn more about JSON Schema at: https://json-schema.org/ .
This CVE record format is defined using JSON Schema. Learn more about JSON Schema at: [json-schema.org](https://json-schema.org/).

### Latest

The latest version of the record format is 5.1.0. It is specified in the JSON schema at https://github.com/CVEProject/cve-schema/blob/master/schema/CVE_Record_Format.json
The latest version of the record format is 5.1.0. It is specified in the [CVE Record Format JSON schema](https://github.com/CVEProject/cve-schema/blob/master/schema/CVE_Record_Format.json)

A single schema file with bundled dependencies is at https://github.com/CVEProject/cve-schema/blob/master/schema/docs/CVE_Record_Format_bundled.json
A single schema file with bundled schema dependencies can always be found [here](https://github.com/CVEProject/cve-schema/blob/master/schema/docs/CVE_Record_Format_bundled.json)

### Documentation and Guidance

Documentation about this format is available at https://cveproject.github.io/cve-schema/schema/docs/
Additional [Documentation](https://cveproject.github.io/cve-schema/schema/docs/) about the format is also available.

A mindmap version of the CVE record structure is at https://cveproject.github.io/cve-schema/schema/docs/mindmap.html
The CVE record structure is also viewable as an interactive [mindmap](https://cveproject.github.io/cve-schema/schema/docs/mindmap.html).

More details about Product and Version Encodings in CVE JSON 5.1.0 record is at https://github.com/CVEProject/cve-schema/blob/master/schema/docs/versions.md
More details about Product and Product Version Formats/Encodings in CVE JSON 5.1.0 record can be found [here](https://github.com/CVEProject/cve-schema/blob/master/schema/docs/versions.md)

### Examples

A basic example of a full record in 5.1.0 format with minimally required fields is available at https://github.com/cveproject/cve-schema/blob/master/schema/docs/full-record-basic-example.json
A [basic example of a full record in 5.1.0 format with minimally required fields](https://github.com/cveproject/cve-schema/blob/master/schema/docs/full-record-basic-example.json)

An advanced example of a full record in 5.1.0 format is available at https://github.com/cveproject/cve-schema/blob/master/schema/docs/full-record-advanced-example.json
An [advanced example of a full record in 5.1.0 format](https://github.com/cveproject/cve-schema/blob/master/schema/docs/full-record-advanced-example.json)

A basic example of a cnaContainer, to be used with CVE Services, is available at https://github.com/cveproject/cve-schema/blob/master/schema/docs/cnaContainer-basic-example.json
A [basic example of a cnaContainer only](https://github.com/cveproject/cve-schema/blob/master/schema/docs/cnaContainer-basic-example.json), to be used with CVE Services

An advanced example of a cnaContainer, to be used with CVE Services, is available at https://github.com/cveproject/cve-schema/blob/master/schema/docs/cnaContainer-advanced-example.json
An [advanced example of a cnaContainer only](https://github.com/cveproject/cve-schema/blob/master/schema/docs/cnaContainer-advanced-example.json
), to be used with CVE Services