Merge pull request #1118 from CVEProject/dev

Updating INT from DEV
CVEProject · Aug 21, 2023 · bff6c01 · bff6c01
2 parents 4e32141 + f141bf6
commit bff6c01
Show file tree

Hide file tree

Showing 29 changed files with 5,631 additions and 187 deletions.
diff --git a/api-docs/openapi.json b/api-docs/openapi.json
@@ -696,7 +696,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "../schemas/cve/create-full-cve-record-request.json"
+                "$ref": "../schemas/cve/create-cve-record-secretariat-request.json"
               }
             }
           }
@@ -796,7 +796,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "../schemas/cve/create-full-cve-record-request.json"
+                "$ref": "../schemas/cve/create-cve-record-secretariat-request.json"
               }
             }
           }
@@ -904,6 +904,113 @@
         }
       }
     },
+    "/cve_cursor": {
+      "get": {
+        "tags": [
+          "CVE Record"
+        ],
+        "summary": "Retrieves all CVE Records after applying the query parameters as filters. Uses cursor pagination to paginate results (accessible to Secretariat)",
+        "description": "  <h2>Access Control</h2>  <p>User must belong to an organization with the <b>Secretariat</b> role</p>  <h2>Expected Behavior</h2>  <p><b>Secretariat:</b> Retrieves all CVE records for all organizations</p>",
+        "operationId": "cveGetFilteredCursor",
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/cveRecordFilteredTimeModifiedLt"
+          },
+          {
+            "$ref": "#/components/parameters/cveRecordFilteredTimeModifiedGt"
+          },
+          {
+            "$ref": "#/components/parameters/cveState"
+          },
+          {
+            "$ref": "#/components/parameters/countOnly"
+          },
+          {
+            "$ref": "#/components/parameters/assignerShortName"
+          },
+          {
+            "$ref": "#/components/parameters/assigner"
+          },
+          {
+            "$ref": "#/components/parameters/cnaModified"
+          },
+          {
+            "$ref": "#/components/parameters/adpShortName"
+          },
+          {
+            "$ref": "#/components/parameters/nextPage"
+          },
+          {
+            "$ref": "#/components/parameters/previousPage"
+          },
+          {
+            "$ref": "#/components/parameters/limit"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "A filtered list of CVE Records, along with pagination fields if results span multiple pages of data",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "oneOf": [
+                    {
+                      "$ref": "../schemas/cve/cursor-cve-records-response.json"
+                    },
+                    {
+                      "$ref": "../schemas/cve/create-cve-record-rejection-response.json"
+                    }
+                  ]
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Bad Request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "../schemas/errors/bad-request.json"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized"
+          },
+          "403": {
+            "description": "Forbidden",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "../schemas/errors/generic.json"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not Found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "../schemas/errors/generic.json"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Internal Server Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "../schemas/errors/generic.json"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/cve/{id}/cna": {
       "post": {
         "tags": [
@@ -1000,7 +1107,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "../schemas/cve/cve-record-minimum-request.json"
+                "$ref": "../schemas/cve/create-cve-record-cna-request.json"
               }
             }
           }
@@ -1101,7 +1208,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "../schemas/cve/cve-record-minimum-request.json"
+                "$ref": "../schemas/cve/create-cve-record-cna-request.json"
               }
             }
           }
@@ -1408,7 +1515,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "$ref": "/schemas/cve/adp-minimum-request.json"
+                "$ref": "/schemas/cve/create-adp-record-adp-request.json"
               }
             }
           }
@@ -2650,6 +2757,33 @@
           "type": "boolean"
         }
       },
+      "nextPage": {
+        "in": "query",
+        "name": "next_page",
+        "description": "Key returned by a GET /cve_cursor call that must be used to get the next page of results in a subsequent call",
+        "required": false,
+        "schema": {
+          "type": "string"
+        }
+      },
+      "previousPage": {
+        "in": "query",
+        "name": "previous_page",
+        "description": "Key returned by a GET /cve_cursor call that must be used to get the previous page of results in a subsequent call",
+        "required": false,
+        "schema": {
+          "type": "string"
+        }
+      },
+      "limit": {
+        "in": "query",
+        "name": "limit",
+        "description": "CVE records to return per page. Must be between 1-500. ",
+        "required": false,
+        "schema": {
+          "type": "integer"
+        }
+      },
       "cnaModified": {
         "in": "query",
         "name": "cna_modified",
@@ -2662,7 +2796,7 @@
       "adpShortName": {
         "in": "query",
         "name": "adp_short_name",
-        "description": "Only get CVE records that have an adpContainer owned by this org and that has been modified/created within the set time_modified range. Requires at least one time_modified parameter set",
+        "description": "Only get CVE records that have an adpContainer owned by this org.",
         "required": false,
         "schema": {
           "type": "string"