Fixed missing comma, and made docs more detailed

CVEProject · Dec 20, 2024 · f160f27 · f160f27
1 parent 4efba1a
commit f160f27
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 4 deletions.
diff --git a/api-docs/openapi.json b/api-docs/openapi.json
@@ -1426,6 +1426,18 @@
               "type": "string"
             },
             "description": "The CVE ID for which the record is being updated"
+          },
+          {
+            "$ref": "#/components/parameters/apiEntityHeader"
+          },
+          {
+            "$ref": "#/components/parameters/apiUserHeader"
+          },
+          {
+            "$ref": "#/components/parameters/apiSecretHeader"
+          },
+          {
+            "$ref": "#/components/parameters/erlCheck"
           }
         ],
         "responses": {
@@ -3033,7 +3045,7 @@
       "erlCheck": {
         "in": "query",
         "name": "erlcheck",
-        "description": "Enables stricter validation that ensures submitted record meets enrichment data requirements",
+        "description": "Enables stricter validation that ensures submitted record meets enrichment data requirements. For a record to be enriched, a CVSS score and a CWE ID must be provided.",
         "required": false,
         "schema": {
           "type": "boolean"

diff --git a/src/controller/cve.controller/index.js b/src/controller/cve.controller/index.js
@@ -648,8 +648,8 @@ router.put('/cve/:id/cna',
   #swagger.parameters['$ref'] = [
     '#/components/parameters/apiEntityHeader',
     '#/components/parameters/apiUserHeader',
-    '#/components/parameters/apiSecretHeader'
-    '#/components/parameters/erlCheck',
+    '#/components/parameters/apiSecretHeader',
+    '#/components/parameters/erlCheck'
   ]
   #swagger.requestBody = {
      description: '<h3>Notes:</h3>

diff --git a/src/swagger.js b/src/swagger.js
@@ -171,7 +171,7 @@ const doc = {
       erlCheck: {
         in: 'query',
         name: 'erlcheck',
-        description: 'Enables stricter validation that ensures submitted record meets enrichment data requirements',
+        description: 'Enables stricter validation that ensures submitted record meets enrichment data requirements. For a record to be enriched, a CVSS score and a CWE ID must be provided.',
         required: false,
         schema: {
           type: 'boolean'