Add swagger support for Rest API
[functest.git] / functest / api / swagger / creds_action.yaml
1 Update openrc
2
3 This api offers the interface to Update openstack.creds.
4
5 action: update_openrc
6 ---
7 tags:
8   - Creds
9 parameters:
10   - in: body
11     name: body
12     description: this is the input json dict
13     schema:
14       required:
15         - action
16         - args
17       properties:
18         action:
19           type: string
20           description: this is action for creds
21           default: update_openrc
22         args:
23           schema:
24             required:
25               - openrc
26             properties:
27               openrc:
28                 type: string
29                 description: this is the test case name
30                 default:
31                   "OS_AUTH_URL": "http://192.16.1.222:5000/v3"
32                   "OS_ENDPOINT_TYPE": "publicURL"
33                   "OS_IDENTITY_API_VERSION": "3"
34                   "OS_INTERFACE": "publicURL"
35                   "OS_PASSWORD": "admn"
36                   "OS_PROJECT_DOMAIN_NAME": "Default"
37                   "OS_PROJECT_NAME": "admin"
38                   "OS_REGION_NAME": "RegionOne"
39                   "OS_TENANT_NAME": "admin"
40                   "OS_USERNAME": "admin"
41                   "OS_USER_DOMAIN_NAME": "Default"
42 definitions:
43   Credentials:
44     type: object
45     properties:
46       creds_name:
47           $ref: '#/definitions/Name'
48   Name:
49     type: dict
50 responses:
51   200:
52     description: Update openrc
53     schema:
54       $ref: '#/definitions/Credentials'
55     examples:
56       'status': 0
57       'result': 'Update openrc successfully'