[DataStorage] APIs to add Event and delete Events from database based on event ids

[nitu-s-gupta]

Signed-off-by: Nitu Gupta [email protected]

Description

Currently DataStorage has APIs to add data to the database or get the reading. API to delete a record from database is not present. This PR will add an API to delete record from CoreData given the Event ID

Usage Example
Add an Event
curl --location --request POST 'http://{DeviceServiceIP:Port}/api/v1/event'
Delete an Event
curl --location --request DELETE 'http://192.168.1.107:49986/api/v1/event/id/{EventID}"

Fixes # (issue)

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

1. Run the Docker container for Edge-orchestration

docker run -it -d --privileged --network="host" --name edge-orchestration  -v /var/edge-orchestration/:/var/edge-orchestration/:rw -v /var/run/docker.sock:/var/run/docker.sock:rw -v /proc/:/process/:ro  lfedge/edge-home-orchestration-go:latest

2. Post an event by calling the API
   curl --location --request POST 'http://192.168.1.107:49986/api/v1/event'
   --header 'Content-Type: text/plain'
   --data-raw '{
   "device":"camera",
   "readings":[{
   "name":"cowcount",
   "value":"9"
   }]
   }'
   This will return an id of the event (In this example it returned 0d8d6738-5968-4b6c-92eb-1d45b2b3740a)

3. Call the delete API using
   curl --location --request DELETE 'http://192.168.1.107:49986/api/v1/event/id/0d8d6738-5968-4b6c-92eb-1d45b2b3740a'

This will return true in case of success

Test Configuration:

• OS type & version: (Ubuntu 20.04)
• Hardware: (x86-64)
• Edge Orchestration Release: (v1.1.0)

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[tiokim]

LGTM
By the way, how to get the information inserted with add event API?

[nitu-s-gupta]

LGTM By the way, how to get the information inserted with add event API?

information of what? Addevent will return the id of the event inserted

[tiokim]

LGTM By the way, how to get the information inserted with add event API?

information of what? Addevent will return the id of the event inserted

Input from service application such as { "device":"camera", "readings":[{ "name":"cowcount", "value":"9" }] }

[nitu-s-gupta]

LGTM By the way, how to get the information inserted with add event API?

information of what? Addevent will return the id of the event inserted

Input from service application such as { "device":"camera", "readings":[{ "name":"cowcount", "value":"9" }] }

This information can be obtained from database using the reading API or by calling the api in coredatabase to get all the events

[tiokim]

LGTM By the way, how to get the information inserted with add event API?

information of what? Addevent will return the id of the event inserted

Input from service application such as { "device":"camera", "readings":[{ "name":"cowcount", "value":"9" }] }

This information can be obtained from database using the reading API or by calling the api in coredatabase to get all the events

Can a service application fetch the information through DataStroage REST API at the moment?

[nitu-s-gupta]

LGTM By the way, how to get the information inserted with add event API?

information of what? Addevent will return the id of the event inserted

Input from service application such as { "device":"camera", "readings":[{ "name":"cowcount", "value":"9" }] }

This information can be obtained from database using the reading API or by calling the api in coredatabase to get all the events

Can a service application fetch the information through DataStroage REST API at the moment?

Yes reading API

LGTM By the way, how to get the information inserted with add event API?

information of what? Addevent will return the id of the event inserted

Input from service application such as { "device":"camera", "readings":[{ "name":"cowcount", "value":"9" }] }

This information can be obtained from database using the reading API or by calling the api in coredatabase to get all the events

Can a service application fetch the information through DataStroage REST API at the moment?

For readings fetching Service application can call /api/v1/device/{deviceNameKey}/resource/{resourceNameKey} Get API
For event fetching no API exits as provided by homeedge

[tiokim]

For readings fetching Service application can call /api/v1/device/{deviceNameKey}/resource/{resourceNameKey} Get API For event fetching no API exits as provided by homeedge

@nitu-s-gupta Thank you for the answer! I opened an issue #505 for the later implementation.

[suresh-lc]

+1

[tdrozdovsky]

LGTM

[MoonkiHong]

Looks good to me.