Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Interface Name

Purpose Reason For Use

Version(s)API Spec (swagger)
SOInterface to Service Orchestrator (SO) for various Operations - for example orchestrating a new VNF.
https://docs.onap.org/projects/onap-so/en/latest/_downloads/e3bc7468795fb200d2dc59b2e4801dab/swagger.jsonSO API
SDCInterface to Service Design Catalog (SDC) for getting Service Model
SDC API
A&AIInterface to Active & Available Inventory (A&AI) for managing Service Instances - For example for Change Management.

Consumed APIs

...

Offered APIs

EntityMethodPath InfoDescription
Health CheckGET/healthCheckThe Health Status of the application checks the DB connection.



Used by IDNS for redundancy

return response entity:
- statusCode Either 200 or 500
- detailedMsg of the result, in case of failure particular error message

Expected:

{
  "statusCode": 200,
  "detailedMsg": "health check succeeded",
  "date": current date
}
Health CheckGETrest/healthCheck/{User-Agent}/{X-ECOMP-RequestID}The Health Status of the application checks the DB connection



return response entity:
- statusCode Either 200 or 500
- detailedMsg of the result, in case of failure particular error message
- date string indicating the current date & time

Expected:

{
  "statusCode": 200,
  "detailedMsg": "health check succeeded",
  "date": current date
}
Commit VersionGET/commitInfoDisplays info about the last commit of the running build



return response entity:
- commitId full id of the commit
- commitMessageShort short message from the commit
- commitTime time of the commit

Expected:

{
  "commitId": id of the last commit
  "commitMessageShort": short message of the last commit
  "commitTime": time of the last commit
}

...

6. New Release Capabilities

...

Jira
serverONAP JIRA
serverId425b2b0a-557c-3c0c-b515-579789cceedb
keyREQ-430

...

7. References

  1. https://docs.onap.org/en/elalto/submodules/vid.git/docs/consumedapis.html
  2. VID R4 M3 Architecture Review

...