Page Status: Copied from Guilin-R7 - Aug-24-2020
...
| Drawio | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
2. Component API definitions
VID Interacts with the following components
| Interface Name | Purpose Reason For Use | Version(s) | API Spec (swagger) |
|---|---|---|---|
| SO | Interface to Service Orchestrator (SO) for various Operations - for example orchestrating a new VNF. | ||
| SDC | Interface to Service Design Catalog (SDC) for getting Service Model | ||
| A&AI | Interface to Active & Available Inventory (A&AI) for managing Service Instances - For example for Change Management. | ||
Consumed APIs
https://docs.onap.org/en/elalto/submodules/vid.git/docs/consumedapis.html
Offered APIs
| Entity | Method | Path Info | Description |
|---|---|---|---|
| Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. |
Used by IDNS for redundancy return response entity: Expected: { "statusCode": 200, "detailedMsg": "health check succeeded", "date": current date } | |||
| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection |
return response entity: Expected: { "statusCode": 200, "detailedMsg": "health check succeeded", "date": current date } | |||
| Commit Version | GET | /commitInfo | Displays info about the last commit of the running build |
return response entity: Expected: { "commitId": id of the last commit "commitMessageShort": short message of the last commit "commitTime": time of the last commit } |
Maintenance APIs
| Maintenance: Category Parameters | POST | /maintenance/category_parameter/{categoryName} | Populate VID Project/Owning entity/Line of Business/Platform drop downs |
POST body: { "options": [ <list of strings> ] } |
3. Component Description:
...