id_quota stuff

Author: david-rocca

src/controller/org.controller/index.js

@@ -33,6 +33,77 @@ router.get('/registry/org/:shortname/users',
   controller.USER_ALL)
 
 router.get('/registry/org/:shortname/id_quota',
+  /*
+  #swagger.tags = ['Registry Organization']
+  #swagger.operationId = 'orgIdQuota'
+  #swagger.summary = "Retrieves an organization's CVE ID quota (accessible to all registered users)"
+  #swagger.description = "
+        <h2>Access Control</h2>
+        <p>All registered users can access this endpoint</p>
+        <h2>Expected Behavior</h2>
+        <p><b>Regular, CNA & Admin Users:</b> Retrieves the CVE ID quota for the user's organization</p>
+        <p><b>Secretariat:</b> Retrieves the CVE ID quota for any organization</p>"
+  #swagger.parameters['shortname'] = { description: 'The shortname of the organization' }
+  #swagger.parameters['$ref'] = [
+    '#/components/parameters/registry',
+    '#/components/parameters/apiEntityHeader',
+    '#/components/parameters/apiUserHeader',
+    '#/components/parameters/apiSecretHeader'
+  ]
+  #swagger.responses[200] = {
+    description: 'Returns the CVE ID quota for an organization',
+    content: {
+      "application/json": {
+        schema: {
+          oneOf: [
+            { $ref: '../schemas/org/get-org-quota-response.json' },
+            { $ref: '../schemas/registry-org/get-registry-org-quota-response.json' }
+          ]
+        }
+      }
+    }
+  }
+  #swagger.responses[400] = {
+    description: 'Bad Request',
+    content: {
+      "application/json": {
+        schema: { $ref: '../schemas/errors/bad-request.json' }
+      }
+    }
+  }
+  #swagger.responses[401] = {
+    description: 'Not Authenticated',
+    content: {
+      "application/json": {
+        schema: { $ref: '../schemas/errors/generic.json' }
+      }
+    }
+  }
+  #swagger.responses[403] = {
+    description: 'Forbidden',
+    content: {
+      "application/json": {
+        schema: { $ref: '../schemas/errors/generic.json' }
+      }
+    }
+  }
+  #swagger.responses[404] = {
+    description: 'Not Found',
+    content: {
+      "application/json": {
+        schema: { $ref: '../schemas/errors/generic.json' }
+      }
+    }
+  }
+  #swagger.responses[500] = {
+    description: 'Internal Server Error',
+    content: {
+      "application/json": {
+        schema: { $ref: '../schemas/errors/generic.json' }
+      }
+    }
+  }
+  */
   mw.useRegistry(),
   mw.validateUser,
   param(['shortname']).isString().trim().notEmpty().isLength({ min: CONSTANTS.MIN_SHORTNAME_LENGTH, max: CONSTANTS.MAX_SHORTNAME_LENGTH }),

src/controller/registry-org.controller/index.js

@@ -13,6 +13,7 @@ router.get('/registryOrg',
   /*
   #swagger.tags = ['Registry Organization']
   #swagger.operationId = 'getAllRegistryOrgs'
+  #swagger.ignore = true
   #swagger.summary = "Retrieves information about all registry organizations (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -80,6 +81,7 @@ router.get('/registryOrg/:identifier',
   /*
   #swagger.tags = ['Registry Organization']
   #swagger.operationId = 'getSingleRegistryOrg'
+  #swagger.ignore = true
   #swagger.summary = "Retrieves information about a specific registry organization"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -150,6 +152,7 @@ router.post('/registryOrg',
   /*
   #swagger.tags = ['Registry Organization']
   #swagger.operationId = 'createRegistryOrg'
+  #swagger.ignore = true
   #swagger.summary = "Creates a new registry organization (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -254,6 +257,7 @@ router.put('/registryOrg/:shortname',
   /*
   #swagger.tags = ['Registry Organization']
   #swagger.operationId = 'updateRegistryOrg'
+  #swagger.ignore = true
   #swagger.summary = "Updates an existing registry organization (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -374,6 +378,7 @@ router.delete('/registryOrg/:identifier',
   /*
   #swagger.tags = ['Registry Organization']
   #swagger.operationId = 'deleteRegistryOrg'
+  #swagger.ignore = true
   #swagger.summary = "Deletes an existing registry organization (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -455,6 +460,7 @@ router.get('/registryOrg/:shortname/users',
   /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'registryUserOrgAll'
+  #swagger.ignore = true
   #swagger.summary = "Retrieves all users for the organization with the specified short name (accessible to all registered users)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -530,6 +536,7 @@ router.post('/registryOrg/:shortname/user',
   /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'RegistryUserCreateSingle'
+  #swagger.ignore = true
   #swagger.summary = "Create a user with the provided short name as the owning organization (accessible to Admins and Secretariats)"
   #swagger.description = "
         <h2>Access Control</h2>

src/controller/registry-user.controller/index.js

@@ -11,6 +11,7 @@ router.get('/registryUser',
   /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'getAllRegistryUsers'
+  #swagger.ignore = true
   #swagger.summary = "Retrieves information about all registry users (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -77,6 +78,7 @@ router.get('/registryUser/:identifier',
 /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'getSingleRegistryUser'
+  #swagger.ignore = true
   #swagger.summary = "Retrieves information about a specific registry user"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -147,6 +149,7 @@ router.post('/registryUser',
   /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'createRegistryUser'
+  #swagger.ignore = true
   #swagger.summary = "Creates a new registry user (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -220,6 +223,7 @@ router.put('/registryUser/:identifier',
   /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'updateRegistryUser'
+  #swagger.ignore = true
   #swagger.summary = "Updates an existing registry user (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>
@@ -308,6 +312,7 @@ router.delete(
   /*
   #swagger.tags = ['Registry User']
   #swagger.operationId = 'deleteRegistryUser'
+  #swagger.ignore = true
   #swagger.summary = "Deletes an existing registry user (accessible to Secretariat only)"
   #swagger.description = "
         <h2>Access Control</h2>