1parameters:
2
3 RequiredGiantSwarmAuthorizationHeader:
4 name: Authorization
5 type: string
6 in: header
7 required: true
8 description: As described in the [authentication](#section/Authentication) section
9
10 ClusterIdPathParameter:
11 name: cluster_id
12 in: path
13 required: true
14 type: string
15 description: Cluster ID
16
17 UserEmailPathParameter:
18 name: email
19 in: path
20 required: true
21 type: string
22 description: The user's email address
23
24 OrganizationIdPathParameter:
25 name: organization_id
26 in: path
27 required: true
28 type: string
29 description: |
30 An ID for the organization.
31 This ID must be unique and match this regular
32 expression: ^[a-z0-9_]{4,30}$
33
34 XRequestIDHeader:
35 name: X-Request-ID
36 in: header
37 type: string
38 required: false
39 description: |
40 A randomly generated key that can be used to track a request throughout
41 services of Giant Swarm.
42
43 XGiantSwarmActivityHeader:
44 name: X-Giant-Swarm-Activity
45 in: header
46 type: string
47 required: false
48 description: |
49 Name of an activity to track, like "list-clusters". This allows to
50 analyze several API requests sent in context and gives an idea on
51 the purpose.
52
53 XGiantSwarmCmdLineHeader:
54 name: X-Giant-Swarm-CmdLine
55 in: header
56 type: string
57 required: false
58 description: |
59 If activity has been issued by a CLI, this header can contain the
60 command line
61
View as plain text