ammar/backend
1
0
Fork 0
mirror of https://github.com/SyncrowIOT/backend.git synced 2025-11-27 09:34:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

add route and api summary and details for project

Browse Source
This commit is contained in:
hannathkadher
2024-12-09 12:27:40 +04:00
parent 768ea7cad8
commit bab57ff5eb
1 changed files with 53 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
libs/common/src/constants/controller-route.ts
View File

@ -1,4 +1,29 @@
export class ControllerRoute { export class ControllerRoute {
static PROJECT = class {
public static readonly ROUTE = 'projects';
static ACTIONS = class {
public static readonly CREATE_PROJECT_SUMMARY = 'Create a new project';
public static readonly CREATE_PROJECT_DESCRIPTION =
'This endpoint allows you to create a new project by providing the required project details.';
public static readonly GET_PROJECT_SUMMARY = 'Retrieve project details';
public static readonly GET_PROJECT_DESCRIPTION =
'This endpoint retrieves the details of a project by its unique identifier (UUID).';
public static readonly UPDATE_PROJECT_SUMMARY = 'Update project details';
public static readonly UPDATE_PROJECT_DESCRIPTION =
'This endpoint updates the details of an existing project using its unique identifier (UUID).';
public static readonly LIST_PROJECTS_SUMMARY = 'List all projects';
public static readonly LIST_PROJECTS_DESCRIPTION =
'This endpoint retrieves a list of all existing projects, including their details.';
public static readonly DELETE_PROJECT_SUMMARY = 'Delete a project';
public static readonly DELETE_PROJECT_DESCRIPTION =
'This endpoint deletes an existing project by its unique identifier (UUID).';
};
};
static REGION = class { static REGION = class {
public static readonly ROUTE = 'region'; public static readonly ROUTE = 'region';
static ACTIONS = class { static ACTIONS = class {
@ -649,7 +674,6 @@ export class ControllerRoute {
public static readonly UPDATE_DEVICE_SCHEDULE_DESCRIPTION = public static readonly UPDATE_DEVICE_SCHEDULE_DESCRIPTION =
'This endpoint updates the schedule for a specific device.'; 'This endpoint updates the schedule for a specific device.';
}; };
};
static DEVICE_STATUS_FIREBASE = class { static DEVICE_STATUS_FIREBASE = class {
public static readonly ROUTE = 'device-status-firebase'; public static readonly ROUTE = 'device-status-firebase';
@ -685,4 +709,5 @@ export class ControllerRoute {
'This endpoint deletes a user’s subscription for device messages.'; 'This endpoint deletes a user’s subscription for device messages.';
}; };
}; };
};
} }