Skip to content

Commit f160f27

Browse files
committed
Fixed missing comma, and made docs more detailed
1 parent 4efba1a commit f160f27

File tree

3 files changed

+16
-4
lines changed

3 files changed

+16
-4
lines changed

api-docs/openapi.json

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1426,6 +1426,18 @@
14261426
"type": "string"
14271427
},
14281428
"description": "The CVE ID for which the record is being updated"
1429+
},
1430+
{
1431+
"$ref": "#/components/parameters/apiEntityHeader"
1432+
},
1433+
{
1434+
"$ref": "#/components/parameters/apiUserHeader"
1435+
},
1436+
{
1437+
"$ref": "#/components/parameters/apiSecretHeader"
1438+
},
1439+
{
1440+
"$ref": "#/components/parameters/erlCheck"
14291441
}
14301442
],
14311443
"responses": {
@@ -3033,7 +3045,7 @@
30333045
"erlCheck": {
30343046
"in": "query",
30353047
"name": "erlcheck",
3036-
"description": "Enables stricter validation that ensures submitted record meets enrichment data requirements",
3048+
"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.",
30373049
"required": false,
30383050
"schema": {
30393051
"type": "boolean"

src/controller/cve.controller/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -648,8 +648,8 @@ router.put('/cve/:id/cna',
648648
#swagger.parameters['$ref'] = [
649649
'#/components/parameters/apiEntityHeader',
650650
'#/components/parameters/apiUserHeader',
651-
'#/components/parameters/apiSecretHeader'
652-
'#/components/parameters/erlCheck',
651+
'#/components/parameters/apiSecretHeader',
652+
'#/components/parameters/erlCheck'
653653
]
654654
#swagger.requestBody = {
655655
description: '<h3>Notes:</h3>

src/swagger.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ const doc = {
171171
erlCheck: {
172172
in: 'query',
173173
name: 'erlcheck',
174-
description: 'Enables stricter validation that ensures submitted record meets enrichment data requirements',
174+
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.',
175175
required: false,
176176
schema: {
177177
type: 'boolean'

0 commit comments

Comments
 (0)