-
Notifications
You must be signed in to change notification settings - Fork 36
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2109 from CVEProject/content-rjr-2096
#2096 Update links + some text on 3 pages
- Loading branch information
Showing
3 changed files
with
47 additions
and
53 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 |
|---|---|---|
|
|
@@ -42,17 +42,31 @@ | |
| </p> | ||
| <h3 class="title" :id="pagePath['Overview']['items']['Current Status'].anchorId">Current Status</h3> | ||
| <p> | ||
| As of March 29, 2023, the CVE Program achieved hard deploy of CVE Services 2.1, | ||
| <a href='/AllResources/CveServices#cve-json-5'>CVE JSON 5.0</a>, | ||
| and the <a href='/Downloads'>CVE JSON 5.0 Bulk Download</a> | ||
| capability. “Hard deploy” means issues with the CVE Services | ||
| “<a href="https://cveproject.github.io/automation-cve-services-faqs#what-is-meant-by-cve-services-21-soft-deploy" target="_blank">soft | ||
| deploy</a>” | ||
| phase that began in October 2022 and ended in March 2023 have been addressed, and the CVE JSON 5.0 Bulk Download | ||
| capability is available for community use. For hard deploy known issues click | ||
| <a href="https://cveproject.github.io/automation-cve-services-known-issues#known-issues" target="_blank">here</a>. | ||
| To learn more about the new bulk download capability, click | ||
| <a href='/Media/News/item/blog/2023/03/29/CVE-Downloads-in-JSON-5-Format'>here</a>. | ||
| As of March 29, 2023, the CVE Program achieved hard deploy of CVE Services 2.1, | ||
| <router-link to="/AllResources/CveServices#cve-json-5">CVE JSON 5.0</router-link>, | ||
| and the <router-link to="/Downloads">CVE JSON 5.0 Bulk Download</router-link> | ||
| capability. “Hard deploy” means issues with the CVE Services “soft deploy” phase that began in October 2022 and ended in March 2023 | ||
| have been addressed, and the CVE JSON 5.0 Bulk Download capability is available for community use. To learn more about the new bulk | ||
| download capability, click <router-link to="/Media/News/item/blog/2023/03/29/CVE-Downloads-in-JSON-5-Format">here</router-link>. | ||
| </p> | ||
| <h4 class="title">Known Issues</h4> | ||
| <p> | ||
| <span class="has-text-weight-bold">CVE Record Retrieval returning over 500 records may return incomplete results</span> | ||
| </p> | ||
| <p> | ||
| <span class="is-italic">Added: 4/14/2023</span> — In a situation where the following conditions are present: (1) A CNA submits | ||
| a request for a CVE Record lookup that results in over 500 records being returned, AND (2) that CNA owns records that are being | ||
| updated (either by the CNA or the Secretariat) at the exact instance the retrieval is processing. The results returned may not be | ||
| complete (i.e., one record may be dropped). It is suggested that if CNAs are repeatedly retrieving more than 500 records from CVE | ||
| Services (using the GET /cve-id endpoint), that they contact the Secretariat for guidance on how best to implement/use this function | ||
| in their client. | ||
| </p> | ||
| <p> | ||
| <span class="has-text-weight-bold">NOTE:</span> Please report any anomalous behavior in CVE Services to the CVE Automation Working | ||
| Group (AWG) at <a href="mailto:[email protected]">[email protected]</a>. Questions about your chosen | ||
| <router-link to="/AllResources/CveServices#using-cve-services-clients">CVE Services Client</router-link> | ||
| should be directed to the client developers (learn more | ||
| <router-link to="/AllResources/CveServices#using-cve-services-clients">here</router-link>). | ||
| </p> | ||
| <h3 class="title" :id="pagePath['Overview']['items']['Architecture'].anchorId">CVE Services Architecture</h3> | ||
| <p> | ||
|
|
@@ -401,11 +415,11 @@ | |
| If a CNA or individual is interested in fielding its own CVE Services client, the CVE Services Server API documentation will provide | ||
| the interface specification to allow you to develop your own client. Also, a CVE Services “test environment” is available. | ||
| </p> | ||
| <h4>CVE Services API</h4> | ||
| <h4 class="title">CVE Services API</h4> | ||
| <ul> | ||
| <li><a href="https://cveawg.mitre.org/api-docs/" target="_blank">API Documentation</a></li> | ||
| <li><strong>Test API URL</strong>: https://cveawg-test.mitre.org/api</li> | ||
| <li><strong>Production API URL</strong>: https://cveawg.mitre.org/api</li> | ||
| <li><a href="https://cveawg.mitre.org/api-docs/" target="_blank">API Documentation</a></li> | ||
| <li><strong>Test API URL</strong>: https://cveawg-test.mitre.org/api</li> | ||
| <li><strong>Production API URL</strong>: https://cveawg.mitre.org/api</li> | ||
| </ul> | ||
| <p> | ||
| Of specific interest in the API documentation are these four endpoints, which are important functions for publishing CVE Records to | ||
|
|
@@ -422,22 +436,22 @@ | |
| Additionally, concrete examples of the data (referred to as a “CNA Container”) to submit via a POST /cve/{id}/cna endpoint (or PUT | ||
| /cve/{id}/cna endpoint) can be found at the following links: | ||
| </p> | ||
| <ul> | ||
| <li> | ||
| <a href="https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v5.0/docs/cnaContainer-basic-example.json" | ||
| target="_blank"> | ||
| CVE Record JSON 5.0 Format CNA Container – Basic Example | ||
| </a> provides an example of the simplest possible JSON 5.0 CVE Record | ||
| </li> | ||
| <li> | ||
| <a href="https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v5.0/docs/cnaContainer-advanced-example.json" | ||
| target="_blank"> | ||
| CVE Record JSON 5.0 Format CNA Container – Advanced Example | ||
| </a> provides an example of a very robust CVE Record submission, demonstrating most of the possible capabilities of a JSON 5.0 CVE | ||
| Record | ||
| </li> | ||
| </ul> | ||
| <h4>Test Environment</h4> | ||
| <ul> | ||
| <li> | ||
| <a href="https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v5.0/docs/cnaContainer-basic-example.json" | ||
| target="_blank"> | ||
| CVE Record JSON 5.0 Format CNA Container – Basic Example | ||
| </a> provides an example of the simplest possible JSON 5.0 CVE Record | ||
| </li> | ||
| <li> | ||
| <a href="https://raw.githubusercontent.com/CVEProject/cve-schema/master/schema/v5.0/docs/cnaContainer-advanced-example.json" | ||
| target="_blank"> | ||
| CVE Record JSON 5.0 Format CNA Container – Advanced Example | ||
| </a> provides an example of a very robust CVE Record submission, demonstrating most of the possible capabilities of a JSON 5.0 CVE | ||
| Record | ||
| </li> | ||
| </ul> | ||
| <h4 class="title">Test Environment</h4> | ||
| <p> | ||
| A CVE Services “Test Environment” consisting of the CVE Services test instance API noted above and a | ||
| <a href='https://test.cve.org/' target='_blank'>CVE website test instance</a> | ||
|
|
@@ -495,15 +509,6 @@ | |
| <li><router-link to="/Downloads">Downloads page</router-link></li> | ||
| <li><a href="https://github.com/CVEProject/cvelistV5" target="_blank">cvelistV5 repository on GitHub</a></li> | ||
| </ul> | ||
| <p>CVE Services resources hosted on the CVE Automation Transition website:</p> | ||
| <ul> | ||
| <li> | ||
| <a href="https://cveproject.github.io/automation-cve-services-known-issues" | ||
| target="_blank">CVE Services – Hard Deploy Known Issues</a> | ||
| </li> | ||
| <li><a href="https://cveproject.github.io/automation-cve-services-faqs" target="_blank">CVE Services Transition FAQs</a></li> | ||
| <li><a href="https://cveproject.github.io/automation-transition" target="_blank">Transition Bulletins</a></li> | ||
| </ul> | ||
| <p>Other helpful resources:</p> | ||
| <ul> | ||
| <li> | ||
|
|
||
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