WIP - v2.8.0 feature

api-docs/openapi.json

@@ -1,7 +1,7 @@
 {
   "openapi": "3.0.2",
   "info": {
-    "version": "2.7.2",
+    "version": "2.8.0",
     "title": "CVE Services API",
     "description": "The CVE Services API supports automation tooling for the CVE Program. Credentials are     required for most service endpoints. Representatives of     <a href='https://www.cve.org/ProgramOrganization/CNAs'>CVE Numbering Authorities (CNAs)</a> should     use one of the methods below to obtain credentials:    <ul><li>If your organization already has an Organizational Administrator (OA) account for the CVE     Services, ask your admin for credentials</li>     <li>Contact your Root (<a href='https://www.cve.org/PartnerInformation/ListofPartners/partner/Google'>Google</a>,     <a href='https://www.cve.org/PartnerInformation/ListofPartners/partner/INCIBE'>INCIBE</a>,     <a href='https://www.cve.org/PartnerInformation/ListofPartners/partner/jpcert'>JPCERT/CC</a>, or     <a href='https://www.cve.org/PartnerInformation/ListofPartners/partner/redhat'>Red Hat</a>) or     Top-Level Root (<a href='https://www.cve.org/PartnerInformation/ListofPartners/partner/icscert'>CISA ICS</a>     or <a href='https://www.cve.org/PartnerInformation/ListofPartners/partner/mitre'>MITRE</a>) to request credentials     </ul>     <p>CVE data is to be in the JSON 5.2 CVE Record format. Details of the JSON 5.2 schema are     located <a href='https://github.com/CVEProject/cve-schema/releases/tag/v5.2.0' target='_blank'>here</a>.</p>    <a href='https://cveform.mitre.org/' class='link' target='_blank'>Contact the CVE Services team</a>",
     "contact": {

datadump/pre-population/glossary.json

@@ -0,0 +1,7 @@
+[
+    {
+        "services_short_name": "long_name",
+        "label": "Long Name",
+        "def": "The full, official name of an organization participating in the CVE program."
+    }
+]

package.json

@@ -1,7 +1,7 @@
 {
     "name": "cve-services",
     "author": "Automation Working Group",
-    "version": "2.7.2",
+    "version": "2.8.0",
     "license": "(CC0)",
     "devDependencies": {
         "@faker-js/faker": "^7.6.0",

schemas/glossary/create-glossary-item-response.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://cve.mitre.org/api-docs/schema/glossary/create-glossary-item-response.json",
+  "type": "object",
+  "properties": {
+    "message": {
+      "type": "string"
+    },
+    "created": {
+      "$ref": "glossary.json"
+    }
+  },
+  "required": [
+    "message",
+    "created"
+  ],
+  "additionalProperties": false
+}

schemas/glossary/glossary.json

@@ -0,0 +1,24 @@
+{
+  "$id": "https://cve.mitre.org/api-docs/schema/glossary/glossary.json",
+  "type": "object",
+  "properties": {
+    "services_short_name": {
+      "type": "string",
+      "minLength": 1
+    },
+    "label": {
+      "type": "string",
+      "minLength": 1
+    },
+    "def": {
+      "type": "string",
+      "minLength": 1
+    }
+  },
+  "required": [
+    "services_short_name",
+    "label",
+    "def"
+  ],
+  "additionalProperties": false
+}

schemas/glossary/list-glossary-items-response.json

@@ -0,0 +1,16 @@
+{
+  "$id": "https://cve.mitre.org/api-docs/schema/glossary/list-glossary-items-response.json",
+  "type": "object",
+  "properties": {
+    "glossary": {
+      "type": "array",
+      "items": {
+        "type": "object"
+      }
+    }
+  },
+  "required": [
+    "glossary"
+  ],
+  "additionalProperties": false
+}

schemas/glossary/update-glossary-item-response.json

@@ -0,0 +1,17 @@
+{
+  "$id": "https://cve.mitre.org/api-docs/schema/glossary/update-glossary-item-response.json",
+  "type": "object",
+  "properties": {
+    "message": {
+      "type": "string"
+    },
+    "updated": {
+      "$ref": "glossary.json"
+    }
+  },
+  "required": [
+    "message",
+    "updated"
+  ],
+  "additionalProperties": false
+}