Gitiles
Code Review Sign In
gerrit.nordix.org / onap / vid / 56f2ad282e7a8d316b92878ae151767fea847265 / . / docs / offeredapis.rst
blob: 4ee12612d6bf3c694732575b47022416719802b9 [file] [log] [blame]
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]1.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]4Offered APIs
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]5=================
6
7+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
8| Entity | Method | Path Info | Description |
9+=====================+==========+=======================================================+===========================================================================================================================================================================================+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]10| Health Check | GET | /healthCheck | The Health Status of the application checks the DB connection. |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]11+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
12| | | | Used by IDNS for redundancy |
13+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
14| | | | |
15+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
16| | | | return response entity: |
17+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
18| | | | - statusCode Either 200 or 500 |
19+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]20| | | | - detailedMsg of the result, in case of failure particular error message |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]21+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
22| | | | |
23+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
24| | | | Expected: |
25+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
26| | | | { |
27+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]28| | | | “statusCode”: 200, |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]29+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]30| | | | “detailedMsg”: “health check succeeded”, |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]31+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]32| | | | “date”: current date |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]33+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
34| | | | } |
35+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
36| | | | |
37+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
38| | | | |
39+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
40| | | | |
41+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]42| Health Check | GET | rest/healthCheck/{User-Agent}/{X-ECOMP-RequestID} | The Health Status of the application checks the DB connection |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]43+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
44| | | | |
45+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
46| | | | return response entity: |
47+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
48| | | | - statusCode Either 200 or 500 |
49+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]50| | | | - detailedMsg of the result, in case of failure particular error message |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]51+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]52| | | | - date string indicating the current date & time |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]53+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
54| | | | |
55+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
56| | | | Expected: |
57+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
58| | | | { |
59+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]60| | | | “statusCode”: 200, |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]61+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]62| | | | “detailedMsg”: “health check succeeded”, |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]63+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
64| | | | “date”: current date |
65+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
66| | | | } |
67+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
68| | | | |
69+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
70| | | | |
71+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Joanna Jeremicz56f2ad22018-09-19 14:35:00 +0200[diff] [blame^]72| Commit Version | GET | /commitInfo | Displays info about the last commit of the running build |
73+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
74| | | | |
75+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
76| | | | return response entity: |
77+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
78| | | | - commitId full id of the commit |
79+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
80| | | | - commitMessageShort short message from the commit |
81+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
82| | | | - commitTime time of the commit |
83+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
84| | | | |
85+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
86| | | | Expected: |
87+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
88| | | | { |
89+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
90| | | | “commitId”: id of the last commit |
91+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
92| | | | “commitMessageShort”: short message of the last commit |
93+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
94| | | | “commitTime”: time of the last commit |
95+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
96| | | | } |
97+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
98| | | | |
99+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
100| | | | |
101+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
102| | | | |
103+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]104| Change management | GET | change-management/workflow {vnfStringsList} | Get Workflow details for the VNFs list |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]105+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
106| | | | |
107+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
108| | | | Expected HTTP Code 200 |
109+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
110| | | | |
111+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]112| Change management | GET | change-management/mso | Get MSO Change Management details |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]113+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
114| | | | |
115+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
116| | | | [{“requestId”:“”,“requestScope”:“vnf”,“requestStatus”:{“percentProgress”:, |
117+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
118| | | | “requestState”:“FAILED”, |
119+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
120| | | | “statusMessage”:“Service request FAILED schema validation. No valid vnf-id is specified”, |
121+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
122| | | | “finishTime”:“Fri, 20 May 2016 13:36:53 GMT”}, |
123+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
124| | | | “requestType”:“updateInstance”, |
125+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
126| | | | “startTime”:“Fri, 20 May 2016 13:36:53 GMT”, |
127+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
128| | | | “instanceReferences”:{“vnfInstanceName”:“ZRDM1PCRF01”,“vfModuleInstanceName”:“ZRDM1PCRF01-PCRF::base::module-0”,“volumeGroupInstanceId”:“1cc27274-1376-4168-af5d-3e35d1365a4c”}}, {…}…] |
129+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
130| | | | |
131+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
132| | | | Expected HTTP Code 200 |
133+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
134| | | | |
135+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
136| Change management | POST | change-management/workflow/{vnfName} | Post workflow request for vnf |
137+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
138| | | | |
139+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
140| | | | Request body: |
141+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
142| | | | |
143+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
144| | | | requestDetails:{ |
145+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
146| | | | vnfName: vnfNAME |
147+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
148| | | | vnfInstanceId: ID |
149+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
150| | | | RelatedInstanceList:[ ] |
151+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
152| | | | } |
153+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
154| | | | requestType: |
155+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
156| | | | |
157+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
158| | | | Expected HTTP Code 200 |
159+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
160| | | | |
161+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]162| Change management | GET | change-management/scheduler | Get Scheduler Change Management Details |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]163+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
164| | | | |
165+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
166| | | | Expected |
167+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
168| | | | HTTP Code 200 |
169+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Ofir Sonsino0e1e6a92017-11-08 11:31:34 +0200[diff] [blame]170| | | | response: Scheduler details in json |
Ofir Sonsinod33c93a2017-10-02 17:23:52 +0300[diff] [blame]171+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
172| | | | |
173+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
174| | | | Explicit HTTP Error Codes |
175+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
176| | | | 404, 406 |
177+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
178| | | | |
179+---------------------+----------+-------------------------------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+