ammar/backend
1
0
Fork 0
mirror of https://github.com/SyncrowIOT/backend.git synced 2025-11-26 22:04:53 +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

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

@ -1,4 +1,29 @@
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 {
public static readonly ROUTE = 'region';
static ACTIONS = class {
@ -649,40 +674,40 @@ export class ControllerRoute {
public static readonly UPDATE_DEVICE_SCHEDULE_DESCRIPTION =
'This endpoint updates the schedule for a specific device.';
};
};
static DEVICE_STATUS_FIREBASE = class {
public static readonly ROUTE = 'device-status-firebase';
static DEVICE_STATUS_FIREBASE = class {
public static readonly ROUTE = 'device-status-firebase';
static ACTIONS = class {
public static readonly ADD_DEVICE_STATUS_SUMMARY =
'Add device status to Firebase';
public static readonly ADD_DEVICE_STATUS_DESCRIPTION =
'This endpoint adds a device status in Firebase based on the provided device UUID.';
static ACTIONS = class {
public static readonly ADD_DEVICE_STATUS_SUMMARY =
'Add device status to Firebase';
public static readonly ADD_DEVICE_STATUS_DESCRIPTION =
'This endpoint adds a device status in Firebase based on the provided device UUID.';
public static readonly GET_DEVICE_STATUS_SUMMARY =
'Get device status from Firebase';
public static readonly GET_DEVICE_STATUS_DESCRIPTION =
'This endpoint retrieves a device status from Firebase using the device UUID.';
public static readonly GET_DEVICE_STATUS_SUMMARY =
'Get device status from Firebase';
public static readonly GET_DEVICE_STATUS_DESCRIPTION =
'This endpoint retrieves a device status from Firebase using the device UUID.';
};
};
};
static DEVICE_MESSAGES_SUBSCRIPTION = class {
public static readonly ROUTE = 'device-messages/subscription';
static DEVICE_MESSAGES_SUBSCRIPTION = class {
public static readonly ROUTE = 'device-messages/subscription';
static ACTIONS = class {
public static readonly ADD_DEVICE_MESSAGES_SUBSCRIPTION_SUMMARY =
'Add device messages subscription';
public static readonly ADD_DEVICE_MESSAGES_SUBSCRIPTION_DESCRIPTION =
'This endpoint adds a subscription for device messages.';
static ACTIONS = class {
public static readonly ADD_DEVICE_MESSAGES_SUBSCRIPTION_SUMMARY =
'Add device messages subscription';
public static readonly ADD_DEVICE_MESSAGES_SUBSCRIPTION_DESCRIPTION =
'This endpoint adds a subscription for device messages.';
public static readonly GET_DEVICE_MESSAGES_SUBSCRIPTION_SUMMARY =
'Get device messages subscription';
public static readonly GET_DEVICE_MESSAGES_SUBSCRIPTION_DESCRIPTION =
'This endpoint fetches a user’s subscription for a specific device.';
public static readonly GET_DEVICE_MESSAGES_SUBSCRIPTION_SUMMARY =
'Get device messages subscription';
public static readonly GET_DEVICE_MESSAGES_SUBSCRIPTION_DESCRIPTION =
'This endpoint fetches a user’s subscription for a specific device.';
public static readonly DELETE_DEVICE_MESSAGES_SUBSCRIPTION_SUMMARY =
'Delete device messages subscription';
public static readonly DELETE_DEVICE_MESSAGES_SUBSCRIPTION_DESCRIPTION =
'This endpoint deletes a user’s subscription for device messages.';
public static readonly DELETE_DEVICE_MESSAGES_SUBSCRIPTION_SUMMARY =
'Delete device messages subscription';
public static readonly DELETE_DEVICE_MESSAGES_SUBSCRIPTION_DESCRIPTION =
'This endpoint deletes a user’s subscription for device messages.';
};
};
};
}