Integration of new Features & removal of registry user and org.

api-docs/openapi.json

@@ -1974,18 +1974,12 @@
       },
       "post": {
         "tags": [
-          "Organization"
+          "Registry Organization"
         ],
-        "summary": "Retrieves all organizations (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 information about all organizations</p>",
-        "operationId": "orgAll",
+        "summary": "Creates an organization (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> Creates a new organization</p>",
+        "operationId": "orgCreateSingle",
         "parameters": [
-          {
-            "$ref": "#/components/parameters/pageQuery"
-          },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -2057,6 +2051,29 @@
               }
             }
           }
+        },
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "anyOf": [
+                  {
+                    "$ref": "../schemas/registry-org/SecretariatOrg.json"
+                  },
+                  {
+                    "$ref": "../schemas/registry-org/CNAOrg.json"
+                  },
+                  {
+                    "$ref": "../schemas/registry-org/ADPOrg.json"
+                  },
+                  {
+                    "$ref": "../schemas/registry-org/BulkDownloadOrg.json"
+                  }
+                ]
+              }
+            }
+          }
         }
       }
     },
@@ -2597,9 +2614,6 @@
           {
             "$ref": "#/components/parameters/active_roles_remove"
           },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -2887,10 +2901,14 @@
         "operationId": "orgAll",
         "parameters": [
           {
-            "$ref": "#/components/parameters/pageQuery"
+            "name": "registry",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
           },
           {
-            "$ref": "#/components/parameters/registry"
+            "$ref": "#/components/parameters/pageQuery"
           },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
@@ -2980,9 +2998,6 @@
         "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> Creates an organization</p>  ",
         "operationId": "orgCreateSingle",
         "parameters": [
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -3067,14 +3082,7 @@
           "content": {
             "application/json": {
               "schema": {
-                "oneOf": [
-                  {
-                    "$ref": "../schemas/org/create-org-request.json"
-                  },
-                  {
-                    "$ref": "../schemas/registry-org/create-registry-org-request.json"
-                  }
-                ]
+                "$ref": "../schemas/org/create-org-request.json"
               }
             }
           }
@@ -3099,9 +3107,6 @@
             },
             "description": "The shortname or UUID of the organization"
           },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -3118,14 +3123,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "oneOf": [
-                    {
-                      "$ref": "../schemas/org/get-org-response.json"
-                    },
-                    {
-                      "$ref": "../schemas/registry-org/get-registry-org-response.json"
-                    }
-                  ]
+                  "$ref": "../schemas/org/get-org-response.json"
                 }
               }
             }
@@ -3201,6 +3199,13 @@
             },
             "description": "The shortname of the organization"
           },
+          {
+            "name": "registry",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "$ref": "#/components/parameters/id_quota"
           },
@@ -3216,9 +3221,6 @@
           {
             "$ref": "#/components/parameters/active_roles_remove"
           },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -3235,14 +3237,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "oneOf": [
-                    {
-                      "$ref": "../schemas/org/update-org-response.json"
-                    },
-                    {
-                      "$ref": "../schemas/registry-org/update-registry-org-response.json"
-                    }
-                  ]
+                  "$ref": "../schemas/org/update-org-response.json"
                 }
               }
             }
@@ -3318,9 +3313,6 @@
             },
             "description": "The shortname of the organization"
           },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -3337,14 +3329,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "oneOf": [
-                    {
-                      "$ref": "../schemas/org/get-org-quota-response.json"
-                    },
-                    {
-                      "$ref": "../schemas/registry-org/get-registry-org-quota-response.json"
-                    }
-                  ]
+                  "$ref": "../schemas/org/get-org-quota-response.json"
                 }
               }
             }
@@ -3421,10 +3406,14 @@
             "description": "The shortname of the organization"
           },
           {
-            "$ref": "#/components/parameters/pageQuery"
+            "name": "registry",
+            "in": "query",
+            "schema": {
+              "type": "string"
+            }
           },
           {
-            "$ref": "#/components/parameters/registry"
+            "$ref": "#/components/parameters/pageQuery"
           },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
@@ -3442,14 +3431,7 @@
             "content": {
               "application/json": {
                 "schema": {
-                  "oneOf": [
-                    {
-                      "$ref": "../schemas/user/list-users-response.json"
-                    },
-                    {
-                      "$ref": "../schemas/registry-user/list-registry-users-response.json"
-                    }
-                  ]
+                  "$ref": "../schemas/user/list-users-response.json"
                 }
               }
             }
@@ -3525,9 +3507,6 @@
             },
             "description": "The shortname of the organization"
           },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },
@@ -3765,9 +3744,6 @@
           {
             "$ref": "#/components/parameters/orgShortname"
           },
-          {
-            "$ref": "#/components/parameters/registry"
-          },
           {
             "$ref": "#/components/parameters/apiEntityHeader"
           },

schemas/registry-org/ADPOrg.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "ADPOrg",
+  "type": "object",
+  "title": "CVE ADP Organization",
+  "description": "Schema for a CVE ADP Organization",
+  "allOf": [
+    { "$ref": "./BaseOrg.json" },
+    {
+      "properties": {
+        "authority": {
+          "const": ["ADP"]
+        }
+      }
+    }
+  ]
+}

schemas/registry-org/BaseOrg.json

@@ -0,0 +1,121 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "./BaseOrg.json",
+  "type": "object",
+  "title": "CVE Base Organization",
+  "description": "Base schema for a CVE Organization",
+  "definitions": {
+    "uuidType": {
+      "description": "A version 4 (random) universally unique identifier (UUID) as defined by [RFC 4122](https://tools.ietf.org/html/rfc4122#section-4.1.3).",
+      "type": "string",
+      "format": "uuid",
+      "pattern": "^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$"
+    },
+    "uriType": {
+      "description": "A universal resource identifier (URI), according to [RFC 3986](https://tools.ietf.org/html/rfc3986).",
+      "type": "string",
+      "format": "uri",
+      "pattern": "^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\\?([^#]*))?(#(.*))?",
+      "minLength": 1,
+      "maxLength": 2048
+    },
+    "shortName": {
+      "description": "A 2-32 character name that can be used to complement an organization's UUID.",
+      "type": "string",
+      "minLength": 2,
+      "maxLength": 32
+    },
+    "longName": {
+      "description": "A 1-256 character name that can be used to complement an organization's short_name.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 256
+    },
+    "authority": {
+      "description": "The authority (role) of this organization within the CVE program",
+      "type": "string",
+      "enum": ["CNA", "SECRETARIAT", "BULK_DOWNLOAD", "ADP"]
+    }
+  },
+  "properties": {
+    "UUID": {
+      "$ref": "#/definitions/uuidType"
+    },
+    "short_name": {
+      "$ref": "#/definitions/shortName"
+    },
+    "long_name": {
+      "$ref": "#/definitions/longName"
+    },
+    "aliases": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "type": "string"
+      }
+    },
+    "authority": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/definitions/authority"
+      }
+    },
+    "root_or_tlr": {
+      "type": "boolean"
+    },
+    "reports_to": {
+      "$ref": "#/definitions/uuidType"
+    },
+    "users": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/definitions/uuidType"
+      }
+    },
+    "admins": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "$ref": "#/definitions/uuidType"
+      }
+    },
+    "contact_info": {
+      "type": "object",
+      "properties": {
+        "additional_contact_users": {
+          "type": "array",
+          "uniqueItems": true,
+          "items": {
+            "$ref": "#/definitions/uuidType"
+          }
+        },
+        "poc": {
+          "type": "string"
+        },
+        "poc_email": {
+          "type": "string",
+          "format": "email"
+        },
+        "poc_phone": {
+          "type": "string"
+        },
+        "org_email": {
+          "type": "string",
+          "format": "email"
+        },
+        "website": {
+          "type": "string",
+          "format": "uri",
+          "description": "Organization's website URL"
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": [
+    "short_name",
+    "long_name"
+  ]
+}