Backend: add variables collection and needed endpoints for the personalization variables

[omar-bear]

Description / Why this is needed?

The aim of this feature is to allow users to insert their ESP's personalization variables without the need to type them manually.

Links / Resources

Link of the US

Current State / Investigations

Front:

• Currently, the LePatron interface doesn't have the ability to insert personalization variables.

Back:

• We have groups endpoints under /api/groups but nothing yet for the personalized variables.

How?

In the server directory, we will do the following:

• [ ] Create a new folder personalized-variables with the necessary endpoints.
• [ ] Add new personalized-variable collection with fields label, variable and group. The group field will hold the id of the group the personalized variable belongs to, to establish a relation and ensure we can retrieve variables for a specific group
• [ ] Create a new schema personalized-variable.schema.js inside personalized-variables folder .
• [ ] Add the controller functions inside packages/server/group/group.controller.js for handling the API endpoints.

• [ ] Add new API endpoints under /api/groups/:groupId/personalized-variables to get, create, update and delete personalized variables. These endpoints will be accessible only to group admins, except for the GET endpoint which can also be accessed by regular users. inside packages/server/group/group.routes.js

  • GET /api/groups/:groupId/personalized-variables - this endpoint will return all personalized variables associated with the specified group ID.

  • POST /api/groups/:groupId/personalized-variables - this endpoint will be used to create a list of personalized variable or update a list in the specified group. The request body should contain the details of the personalized variable array to be created or updated (i.e., label and variable).

  • DELETE /api/groups/:groupId/personalized-variables/:variableId - this endpoint will be used to delete a personalized variable from the specified group.

  • [ ] Create a new service personalized-variable.service.js inside personalized-variables which contain services for the diffrents endpoints

Finally, how long will it take?

1-2 days

[sonarcloud[bot]]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication