File: parameters.yaml

package info (click to toggle)
adjutant 11.0.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,452 kB
  • sloc: python: 13,364; makefile: 44; sh: 32
file content (165 lines) | stat: -rw-r--r-- 3,852 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
# variables in header
X-Auth-Token:
    description: |
      A valid authentication token for a user.
    in: header
    required: true
    type: string

# Path parameters
notification_id:
    description: |
        The notification UUID, as given on list endpoints and in email correspondence.
    in: path
    required: true
    type: string
task_id:
    description: |
      The task UUID as given in the task list and email correspondence.
    in: path
    required: true
    type: string
token_id:
    description: |
        The token UUID, as given on the lists and in email correspondence.
    in: path
    required: true
    type: string
user_id:
    description: |
      The user id, as seen on the ../v1/openstack/users page. Note that this
      is the openstack user id for confirmed users and the task ID for invited
      users.
    in: path
    required: true
    type: string


# Query Parameters
filters:
    description: |
        Django style filters for task, token and notification endpoints.
        See section `Filters` for details.
    in: query
    required: false
    type: dictionary
page:
    description: |
        Page number to access, starts at and defaults to 1.
    in: query
    required: false
    type: int
project_name:
    description: |
        Name for the new project.
    in: query
    required: true
    type: string
region:
    description: |
        Region to perform actions in.
    in: query
    required: true
    type: string
setup_network:
    description: |
        Whether or not to setup a default network for a new project
    in: query
    required: true
    type: boolean
tasks_per_page:
    description: |
        Limit on the tasks viewed on each page.
    in: query
    required: false
    type: int


# Body Parameters
acknowledged:
    description: |
        Confirmation for acknowledging a notification.
    in: body
    required: true
    type: boolean
approved:
    description: |
        Confirmation to approve a task.
    in: body
    required: true
    type: boolean
email:
    description: |
      New user email address.
    in: body
    required: true
    type: string
email_password:
    description: |
        Email address for the user whose password needs resetting
    in: body
    required: true
    type: string
email_signup:
    description: |
        Email address for the default user and project admin.
    in: body
    required: true
    type: string
notifications:
    description: |
        List of notification UUIDs to acknowledge
    in: body
    required: true
    type: array
regions:
    description: |
        Regions to perform actions in.
    in: body
    required: false
    type: array
roles:
    description: |
      List of roles for the user.
    in: body
    required: true
    type: array
size:
    description: |
        Which size out of the selections shown in the quota get request should
        the region(s) be updated to.
    in: body
    required: true
    type: string
task_data:
    description: |
        A dictionary replacing all the data for a task. See the task details
        for what values should be included
    in: body
    required: true
    type: dictionary
task_id_body:
    description: |
      The task UUID as given in the task list and email correspondence.
    in: body
    required: true
    type: int
token_data:
    description: |
        A dictionary replacing all the data for a task. Use the token get request
        to see what should needs to be included.
    in: body
    required: true
    type: dictionary
username:
    description: |
      New user username, required only if USERNAME_IS_EMAIL is false.
    in: body
    required: false
    type: string
username_password:
    description: |
        Username, required only if USERNAME_IS_EMAIL is false.
    in: body
    required: false
    type: string