update ns --> gw in API endpoint names and descriptions

* rename namespace-profile endpoint * update ns --> gw in API descriptions * delete routes.ts and openapi.yaml (generated during build)
bcgov · Dec 17, 2024 · 091b77e · 091b77e
1 parent cc306eb
commit 091b77e
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 3,468 deletions.
diff --git a/src/controllers/v3/DatasetController.ts b/src/controllers/v3/DatasetController.ts
@@ -40,7 +40,7 @@ export class DatasetController extends Controller {
 
   /**
    * Update metadata about a Dataset
-   * > `Required Scope:` Namespace.Manage
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Update Dataset
    */
@@ -66,7 +66,7 @@ export class DatasetController extends Controller {
 
   /**
    * Get metadata about a Dataset
-   * > `Required Scope:` Namespace.Manage
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Get Dataset
    */

diff --git a/src/controllers/v3/GatewayController.ts b/src/controllers/v3/GatewayController.ts
@@ -121,15 +121,15 @@ export class NamespaceController extends Controller {
 
   /**
    * Get details about the gateway, such as permissions for what the gateway is setup with.
-   * > `Required Scope:` Namespace.Manage
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Gateway Summary
    * @param ns
    * @param request
    * @returns
    */
   @Get('/{gatewayId}')
-  @OperationId('namespace-profile')
+  @OperationId('gateway-profile')
   @Security('jwt', ['Namespace.Manage'])
   public async profile(
     @Path() gatewayId: string,
@@ -174,7 +174,7 @@ export class NamespaceController extends Controller {
         errors[`d${ind}`] = { message: err.message };
       });
       logger.error('%j', result);
-      throw new ValidateError(errors, 'Unable to create namespace');
+      throw new ValidateError(errors, 'Unable to create Gateway');
     }
     return {
       gatewayId: result.data.createNamespace.name,
@@ -184,15 +184,15 @@ export class NamespaceController extends Controller {
 
   /**
    * Delete the gateway
-   * > `Required Scope:` Namespace.Manage
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Delete Gateway
    * @param ns
    * @param request
    * @returns
    */
   @Delete('/{gatewayId}')
-  @OperationId('delete-namespace')
+  @OperationId('delete-gateway')
   @Security('jwt', ['Namespace.Manage'])
   public async delete(
     @Path() gatewayId: string,
@@ -218,9 +218,9 @@ export class NamespaceController extends Controller {
   }
 
   /**
-   * > `Required Scope:` Namespace.View
+   * > `Required Scope:` Gateway.View
    *
-   * @summary Get administration activity for this gateway
+   * @summary Get administration activity for this Gateway
    * @param ns
    * @param first
    * @param skip
@@ -251,7 +251,7 @@ export class NamespaceController extends Controller {
 
   /**
    * Get a summary of your endpoints
-   * > `Required Scope:` Namespace.Manage
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Get endpoints
    */

diff --git a/src/controllers/v3/GatewayDirectoryController.ts b/src/controllers/v3/GatewayDirectoryController.ts
@@ -61,7 +61,7 @@ export class GatewayDirectoryController extends Controller {
 
   /**
    * Used primarily for "Preview Mode"
-   * List the datasets belonging to a particular namespace
+   * List the datasets belonging to a particular Gateway
    *
    * @param ns
    * @param name

diff --git a/src/controllers/v3/GatewayServicesController.ts b/src/controllers/v3/GatewayServicesController.ts
@@ -47,7 +47,7 @@ export class GatewayController extends Controller {
 
   /**
    * Get a summary of your Gateway Services
-   * > `Required Scope:` Namespace.Manage
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Get Gateway Services
    */

diff --git a/src/controllers/v3/IssuerController.ts b/src/controllers/v3/IssuerController.ts
@@ -60,8 +60,8 @@ export class IssuerController extends Controller {
   }
 
   /**
-   * Get Authorization Profiles setup in this namespace
-   * > `Required Scope:` Namespace.Manage
+   * Get Authorization Profiles setup in this Gateway
+   * > `Required Scope:` Gateway.Manage
    *
    * @summary Get Authorization Profiles
    */

diff --git a/src/controllers/v3/OrganizationController.ts b/src/controllers/v3/OrganizationController.ts
@@ -181,7 +181,7 @@ export class OrganizationController extends Controller {
   }
 
   /**
-   * > `Required Scope:` Namespace.Assign
+   * > `Required Scope:` Gateway.Assign
    */
   @Get('{org}/gateways')
   @OperationId('organization-gateways')
@@ -196,7 +196,7 @@ export class OrganizationController extends Controller {
   }
 
   /**
-   * > `Required Scope:` Namespace.Assign
+   * > `Required Scope:` Gateway.Assign
    */
   @Put('{org}/{orgUnit}/gateways/{gatewayId}')
   @OperationId('assign-namespace-to-organization')
@@ -231,7 +231,7 @@ export class OrganizationController extends Controller {
   }
 
   /**
-   * > `Required Scope:` Namespace.Assign
+   * > `Required Scope:` Gateway.Assign
    */
   @Delete('{org}/{orgUnit}/gateways/{gatewayId}')
   @OperationId('unassign-namespace-from-organization')
@@ -265,16 +265,16 @@ export class OrganizationController extends Controller {
   }
 
   /**
-   * > `Required Scope:` Namespace.Assign
+   * > `Required Scope:` Gateway.Assign
    *
-   * @summary Get administration activity for gateways associated with this Organization
+   * @summary Get administration activity for Gateways associated with this Organization
    * @param org
    * @param first
    * @param skip
    * @returns Activity[]
    */
   @Get('{org}/activity')
-  @OperationId('org-namespace-activity')
+  @OperationId('org-gateway-activity')
   @Security('jwt', ['Namespace.Assign'])
   public async namespaceActivity(
     @Path() org: string,