rsp-sw-toolkit-im-suite-product-data-service

README

DISCONTINUATION OF PROJECT.

This project will no longer be maintained by Intel.

This project has been identified as having known security escapes.

Intel has ceased development and contributions including, but not limited to, maintenance, bug fixes, new releases, or updates, to this project.

Intel no longer accepts patches to this project.

Intel® Inventory Suite product-data-service

Product data service is a microservice in the Intel® Inventory Suite that provides persistence and retrieval for enterprise data. Enterprise data is ingested through EdgeX platform and consumed by product data service using EdgeX's app functions SDK. Product data service transforms and persists enterprise data in PostgreSQL and exposes RESTfUl APIs to retrieve data using odata protocol.

Install and Deploy via Docker Container

Prerequisites

• Docker & make:

sudo apt install -y docker.io build-essential

• Docker-compose:

sudo curl \
    -L "https://github.com/docker/compose/releases/download/1.24.0/docker-compose-$(uname -s)-$(uname -m)" \
    -o /usr/local/bin/docker-compose && \
    sudo chmod a+x /usr/local/bin/docker-compose

• EdgeX Edinburgh:

wget https://raw.githubusercontent.com/edgexfoundry/developer-scripts/master/releases/edinburgh/compose-files/docker-compose-edinburgh-no-secty-1.0.1.yml
sudo docker-compose -f docker-compose-edinburgh-no-secty-1.0.1.yml up -d

Installation

sudo make build deploy

Incoming Schema example

[
    {
        "exitError":0.0789,
        "becomingReadable":0.0456,
        "beingRead":0,
        "dailyTurn":0.0121,
        "upc":"889319388921",        
        "sku":"11889966"
        "metadata": {
            "color":"red"			
        }
    }
]

Endpoint

GET http://127.0.0.1:8080/skus

Results

{
    "results": [
        {
            "sku": "11889966",
            "productList": [
                {
                    "productId": "889319388921",
                    "beingRead": 0,
                    "becomingReadable": 0.0456,
                    "exitError": 0.0789,
                    "dailyTurn": 0.0121,
                    "metadata": {
                        "color": "red"
                    }
                }
            ]
        }
    ]
}

OData example

GET http://127.0.0.1:8080/skus?$filter=sku eq '123ABC'

Results

{
    "results": [
        {
            "sku": "123ABC",
            "productList": [
                {
                    "productId": "889319388921",
                    "beingRead": 0,
                    "becomingReadable": 0.0456,
                    "exitError": 0.0789,
                    "dailyTurn": 0.0121,
                    "metadata": {
                        "color": "red"
                    }
                }
            ]
        }
    ]
}

For more information about odata, visit OData.org and go-odata.

API Documentation

Go to https://editor.swagger.io and import product-data-service.yml file.