Skip to content

Add responsible use guide to Swagger documentation #168

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

Merged
jdaigneau5 merged 2 commits into from
Oct 7, 2026
Merged

Add responsible use guide to Swagger documentation #168

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e35acd1
Add responsible use guide to Swagger documentation
afoote-mitre Oct 7, 2026
c4961ba
Bump version to 1.0.1-beta
afoote-mitre Oct 7, 2026
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
4 changes: 2 additions & 2 deletions api-docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"openapi": "3.0.2",
"info": {
"version": "1.0.0-beta",
"version": "1.0.1-beta",
"title": "CVE Search API",
"description": "CVE Search API to retrieve all matching CVE records after applying request inputs as filters.",
"description": "CVE Search API to retrieve all matching CVE records after applying request inputs as filters.\n\nResponsible Use Guide: [https://cveproject.github.io/search-api-responsible-use](https://cveproject.github.io/search-api-responsible-use \"https://cveproject.github.io/search-api-responsible-use\")",
"contact": {
"name": "CVE Overview",
"url": "https://www.cve.org/"
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "cve-search-api",
"version": "1.0.0-beta",
"version": "1.0.1-beta",
"scripts": {
"dev": "node routes/swagger.js && nodemon server.js",
"coverage": "jest --coverage",
Expand Down
3 changes: 2 additions & 1 deletion routes/swagger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -340,7 +340,8 @@ const doc = {
info: {
version: packageInfo.version,
title: 'CVE Search API',
description: 'CVE Search API to retrieve all matching CVE records after applying request inputs as filters.',
description:
'CVE Search API to retrieve all matching CVE records after applying request inputs as filters.\n\nResponsible Use Guide: [https://cveproject.github.io/search-api-responsible-use](https://cveproject.github.io/search-api-responsible-use "https://cveproject.github.io/search-api-responsible-use")',
contact: {
name: 'CVE Overview',
url: 'https://www.cve.org/'
Expand Down
Loading