@epilot/sdk 2.20.25 → 2.20.27
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/definitions/access-token-runtime.json +1 -0
- package/definitions/access-token.json +1025 -0
- package/definitions/address-runtime.json +1 -0
- package/definitions/address-suggestions-runtime.json +1 -0
- package/definitions/address-suggestions.json +582 -0
- package/definitions/address.json +578 -0
- package/definitions/ai-agents-runtime.json +1 -0
- package/definitions/ai-agents.json +2863 -0
- package/definitions/app-runtime.json +1 -0
- package/definitions/app.json +5994 -0
- package/definitions/audit-logs-runtime.json +1 -0
- package/definitions/audit-logs.json +305 -0
- package/definitions/automation-runtime.json +1 -0
- package/definitions/automation.json +5979 -0
- package/definitions/billing-runtime.json +1 -0
- package/definitions/billing.json +2394 -0
- package/definitions/blueprint-manifest-runtime.json +1 -0
- package/definitions/blueprint-manifest.json +7817 -0
- package/definitions/calendar-runtime.json +1 -0
- package/definitions/calendar.json +2904 -0
- package/definitions/chat-runtime.json +1 -0
- package/definitions/chat.json +2909 -0
- package/definitions/configuration-hub-runtime.json +1 -0
- package/definitions/configuration-hub.json +2250 -0
- package/definitions/consent-runtime.json +1 -0
- package/definitions/consent.json +344 -0
- package/definitions/customer-portal-runtime.json +1 -0
- package/definitions/customer-portal.json +21181 -0
- package/definitions/dashboard-runtime.json +1 -0
- package/definitions/dashboard.json +1355 -0
- package/definitions/data-governance-runtime.json +1 -0
- package/definitions/data-governance.json +1126 -0
- package/definitions/deduplication-runtime.json +1 -0
- package/definitions/deduplication.json +782 -0
- package/definitions/design-runtime.json +1 -0
- package/definitions/design.json +1827 -0
- package/definitions/document-runtime.json +1 -0
- package/definitions/document.json +972 -0
- package/definitions/email-settings-runtime.json +1 -0
- package/definitions/email-settings.json +3736 -0
- package/definitions/email-template-runtime.json +1 -0
- package/definitions/email-template.json +1441 -0
- package/definitions/entity-mapping-runtime.json +1 -0
- package/definitions/entity-mapping.json +1852 -0
- package/definitions/entity-runtime.json +1 -0
- package/definitions/entity.json +11546 -0
- package/definitions/environments-runtime.json +1 -0
- package/definitions/environments.json +988 -0
- package/definitions/erp-integration-runtime.json +1 -0
- package/definitions/erp-integration.json +7936 -0
- package/definitions/event-catalog-runtime.json +1 -0
- package/definitions/event-catalog.json +2014 -0
- package/definitions/file-runtime.json +1 -0
- package/definitions/file.json +4298 -0
- package/definitions/iban-runtime.json +1 -0
- package/definitions/iban.json +132 -0
- package/definitions/integration-toolkit-runtime.json +1 -0
- package/definitions/integration-toolkit.json +13106 -0
- package/definitions/journey-runtime.json +1 -0
- package/definitions/journey.json +3663 -0
- package/definitions/kanban-runtime.json +1 -0
- package/definitions/kanban.json +1506 -0
- package/definitions/message-runtime.json +1 -0
- package/definitions/message.json +3667 -0
- package/definitions/metering-runtime.json +1 -0
- package/definitions/metering.json +3132 -0
- package/definitions/notes-runtime.json +1 -0
- package/definitions/notes.json +1698 -0
- package/definitions/notification-runtime.json +1 -0
- package/definitions/notification.json +1439 -0
- package/definitions/organization-runtime.json +1 -0
- package/definitions/organization.json +1192 -0
- package/definitions/partner-directory-runtime.json +1 -0
- package/definitions/partner-directory.json +2284 -0
- package/definitions/permissions-runtime.json +1 -0
- package/definitions/permissions.json +1598 -0
- package/definitions/pricing-runtime.json +1 -0
- package/definitions/pricing-tier-runtime.json +1 -0
- package/definitions/pricing-tier.json +105 -0
- package/definitions/pricing.json +14369 -0
- package/definitions/purpose-runtime.json +1 -0
- package/definitions/purpose.json +524 -0
- package/definitions/query-runtime.json +1 -0
- package/definitions/query.json +3178 -0
- package/definitions/sandbox-runtime.json +1 -0
- package/definitions/sandbox.json +453 -0
- package/definitions/sharing-runtime.json +1 -0
- package/definitions/sharing.json +956 -0
- package/definitions/snapshot-runtime.json +1 -0
- package/definitions/snapshot.json +1103 -0
- package/definitions/submission-runtime.json +1 -0
- package/definitions/submission.json +313 -0
- package/definitions/targeting-runtime.json +1 -0
- package/definitions/targeting.json +2285 -0
- package/definitions/template-variables-runtime.json +1 -0
- package/definitions/template-variables.json +1416 -0
- package/definitions/user-runtime.json +1 -0
- package/definitions/user.json +3051 -0
- package/definitions/validation-rules-runtime.json +1 -0
- package/definitions/validation-rules.json +2642 -0
- package/definitions/webhooks-runtime.json +1 -0
- package/definitions/webhooks.json +1875 -0
- package/definitions/workflow-definition-runtime.json +1 -0
- package/definitions/workflow-definition.json +3592 -0
- package/definitions/workflow-runtime.json +1 -0
- package/definitions/workflow.json +4669 -0
- package/dist/apis/access-token.cjs +6 -6
- package/dist/apis/access-token.js +1 -1
- package/dist/apis/address-suggestions.cjs +6 -6
- package/dist/apis/address-suggestions.js +1 -1
- package/dist/apis/address.cjs +6 -6
- package/dist/apis/address.js +1 -1
- package/dist/apis/ai-agents.cjs +6 -6
- package/dist/apis/ai-agents.js +1 -1
- package/dist/apis/app.cjs +6 -6
- package/dist/apis/app.js +1 -1
- package/dist/apis/audit-logs.cjs +6 -6
- package/dist/apis/audit-logs.js +1 -1
- package/dist/apis/automation.cjs +6 -6
- package/dist/apis/automation.js +1 -1
- package/dist/apis/billing.cjs +6 -6
- package/dist/apis/billing.js +1 -1
- package/dist/apis/blueprint-manifest.cjs +6 -6
- package/dist/apis/blueprint-manifest.js +1 -1
- package/dist/apis/calendar.cjs +6 -6
- package/dist/apis/calendar.js +1 -1
- package/dist/apis/chat.cjs +6 -6
- package/dist/apis/chat.js +1 -1
- package/dist/apis/configuration-hub.cjs +6 -6
- package/dist/apis/configuration-hub.d.cts +2 -2
- package/dist/apis/configuration-hub.d.ts +2 -2
- package/dist/apis/configuration-hub.js +1 -1
- package/dist/apis/consent.cjs +6 -6
- package/dist/apis/consent.js +1 -1
- package/dist/apis/customer-portal.cjs +6 -6
- package/dist/apis/customer-portal.js +1 -1
- package/dist/apis/dashboard.cjs +6 -6
- package/dist/apis/dashboard.js +1 -1
- package/dist/apis/data-governance.cjs +6 -6
- package/dist/apis/data-governance.js +1 -1
- package/dist/apis/deduplication.cjs +6 -6
- package/dist/apis/deduplication.js +1 -1
- package/dist/apis/design.cjs +6 -6
- package/dist/apis/design.js +1 -1
- package/dist/apis/document.cjs +8 -8
- package/dist/apis/document.d.cts +2 -2
- package/dist/apis/document.d.ts +2 -2
- package/dist/apis/document.js +2 -2
- package/dist/apis/email-settings.cjs +6 -6
- package/dist/apis/email-settings.js +1 -1
- package/dist/apis/email-template.cjs +6 -6
- package/dist/apis/email-template.js +1 -1
- package/dist/apis/entity-mapping.cjs +6 -6
- package/dist/apis/entity-mapping.js +1 -1
- package/dist/apis/entity.cjs +6 -6
- package/dist/apis/entity.js +1 -1
- package/dist/apis/environments.cjs +6 -6
- package/dist/apis/environments.js +1 -1
- package/dist/apis/event-catalog.cjs +6 -6
- package/dist/apis/event-catalog.js +1 -1
- package/dist/apis/file.cjs +6 -6
- package/dist/apis/file.js +1 -1
- package/dist/apis/iban.cjs +6 -6
- package/dist/apis/iban.js +1 -1
- package/dist/apis/integration-toolkit.cjs +6 -6
- package/dist/apis/integration-toolkit.js +1 -1
- package/dist/apis/journey.cjs +6 -6
- package/dist/apis/journey.d.cts +2 -2
- package/dist/apis/journey.d.ts +2 -2
- package/dist/apis/journey.js +1 -1
- package/dist/apis/kanban.cjs +6 -6
- package/dist/apis/kanban.js +1 -1
- package/dist/apis/message.cjs +6 -6
- package/dist/apis/message.js +1 -1
- package/dist/apis/metering.cjs +6 -6
- package/dist/apis/metering.js +1 -1
- package/dist/apis/notes.cjs +6 -6
- package/dist/apis/notes.js +1 -1
- package/dist/apis/notification.cjs +6 -6
- package/dist/apis/notification.js +1 -1
- package/dist/apis/organization.cjs +6 -6
- package/dist/apis/organization.js +1 -1
- package/dist/apis/partner-directory.cjs +6 -6
- package/dist/apis/partner-directory.js +1 -1
- package/dist/apis/permissions.cjs +6 -6
- package/dist/apis/permissions.js +1 -1
- package/dist/apis/pricing-tier.cjs +6 -6
- package/dist/apis/pricing-tier.js +1 -1
- package/dist/apis/pricing.cjs +6 -6
- package/dist/apis/pricing.js +1 -1
- package/dist/apis/purpose.cjs +6 -6
- package/dist/apis/purpose.js +1 -1
- package/dist/apis/query.cjs +6 -6
- package/dist/apis/query.js +1 -1
- package/dist/apis/sandbox.cjs +6 -6
- package/dist/apis/sandbox.js +1 -1
- package/dist/apis/sharing.cjs +6 -6
- package/dist/apis/sharing.js +1 -1
- package/dist/apis/snapshot.cjs +6 -6
- package/dist/apis/snapshot.js +1 -1
- package/dist/apis/submission.cjs +6 -6
- package/dist/apis/submission.js +1 -1
- package/dist/apis/target.cjs +6 -6
- package/dist/apis/target.js +1 -1
- package/dist/apis/targeting.cjs +6 -6
- package/dist/apis/targeting.js +1 -1
- package/dist/apis/template-variables.cjs +6 -6
- package/dist/apis/template-variables.js +1 -1
- package/dist/apis/user.cjs +6 -6
- package/dist/apis/user.js +1 -1
- package/dist/apis/validation-rules.cjs +6 -6
- package/dist/apis/validation-rules.js +1 -1
- package/dist/apis/webhooks.cjs +6 -6
- package/dist/apis/webhooks.js +1 -1
- package/dist/apis/workflow-definition.cjs +6 -6
- package/dist/apis/workflow-definition.js +1 -1
- package/dist/apis/workflow.cjs +6 -6
- package/dist/apis/workflow.js +1 -1
- package/dist/{chunk-M56QQHVA.cjs → chunk-E2EHXQRP.cjs} +1 -1
- package/dist/{chunk-75EI2Q64.js → chunk-LR7LGGRU.js} +1 -1
- package/dist/{chunk-PZ4TXAF5.cjs → chunk-UM53DB6T.cjs} +3 -3
- package/dist/{chunk-X742W7MI.js → chunk-W5PMKQO7.js} +3 -3
- package/dist/{configuration-hub.d-Dv41yC3b.d.cts → configuration-hub.d-DhPrjJkE.d.cts} +142 -142
- package/dist/{configuration-hub.d-Dv41yC3b.d.ts → configuration-hub.d-DhPrjJkE.d.ts} +142 -142
- package/dist/document-UGT6DAXC.cjs +7 -0
- package/dist/document-UR5WWZEA.js +7 -0
- package/dist/{document-runtime-GFEBGNMS.js → document-runtime-LFOBMSE4.js} +1 -1
- package/dist/{document-runtime-RG3F4R6O.cjs → document-runtime-QM4H7DLT.cjs} +2 -2
- package/dist/{document.d-DN37pjdx.d.cts → document.d-B0zC-R8x.d.cts} +235 -7
- package/dist/{document.d-DN37pjdx.d.ts → document.d-B0zC-R8x.d.ts} +235 -7
- package/dist/index.cjs +10 -10
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +2 -2
- package/dist/journey-IVIBYU5V.js +7 -0
- package/dist/journey-ZN46FFPM.cjs +7 -0
- package/dist/{journey.d-DvwLALwc.d.cts → journey.d-Dj93v-Lw.d.cts} +54 -5
- package/dist/{journey.d-DvwLALwc.d.ts → journey.d-Dj93v-Lw.d.ts} +54 -5
- package/dist/js-yaml-DLCVPJ7G.js +0 -0
- package/docs/document.md +145 -6
- package/docs/journey.md +47 -2
- package/package.json +12 -11
- package/dist/document-CY2A2OE7.js +0 -7
- package/dist/document-RYQ7MF6U.cjs +0 -7
- package/dist/journey-LIJDXSEC.js +0 -7
- package/dist/journey-LNA7JFP3.cjs +0 -7
|
@@ -0,0 +1,988 @@
|
|
|
1
|
+
{
|
|
2
|
+
"openapi": "3.0.3",
|
|
3
|
+
"info": {
|
|
4
|
+
"title": "Environments API",
|
|
5
|
+
"description": "API for managing organization environment variables and secrets",
|
|
6
|
+
"version": "1.0.1"
|
|
7
|
+
},
|
|
8
|
+
"tags": [
|
|
9
|
+
{
|
|
10
|
+
"name": "environments",
|
|
11
|
+
"description": "Environment variables and secrets management"
|
|
12
|
+
}
|
|
13
|
+
],
|
|
14
|
+
"security": [
|
|
15
|
+
{
|
|
16
|
+
"EpilotAuth": []
|
|
17
|
+
}
|
|
18
|
+
],
|
|
19
|
+
"paths": {
|
|
20
|
+
"/v1/environments": {
|
|
21
|
+
"get": {
|
|
22
|
+
"operationId": "listEnvironmentVariables",
|
|
23
|
+
"summary": "listEnvironmentVariables",
|
|
24
|
+
"description": "List all environment variables for the organization. Returns metadata only, no secret values.",
|
|
25
|
+
"tags": [
|
|
26
|
+
"environments"
|
|
27
|
+
],
|
|
28
|
+
"responses": {
|
|
29
|
+
"200": {
|
|
30
|
+
"description": "List of environment variables",
|
|
31
|
+
"content": {
|
|
32
|
+
"application/json": {
|
|
33
|
+
"schema": {
|
|
34
|
+
"$ref": "#/components/schemas/EnvironmentVariableList"
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
},
|
|
39
|
+
"401": {
|
|
40
|
+
"description": "Unauthorized"
|
|
41
|
+
},
|
|
42
|
+
"403": {
|
|
43
|
+
"description": "Forbidden"
|
|
44
|
+
},
|
|
45
|
+
"500": {
|
|
46
|
+
"description": "Internal server error"
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"post": {
|
|
51
|
+
"operationId": "createEnvironmentVariable",
|
|
52
|
+
"summary": "createEnvironmentVariable",
|
|
53
|
+
"description": "Create a new environment variable or secret for the organization. If `group` is provided and the group does not yet exist, it is created automatically.",
|
|
54
|
+
"tags": [
|
|
55
|
+
"environments"
|
|
56
|
+
],
|
|
57
|
+
"requestBody": {
|
|
58
|
+
"required": true,
|
|
59
|
+
"content": {
|
|
60
|
+
"application/json": {
|
|
61
|
+
"schema": {
|
|
62
|
+
"$ref": "#/components/schemas/EnvironmentVariableCreateRequest"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
},
|
|
67
|
+
"responses": {
|
|
68
|
+
"201": {
|
|
69
|
+
"description": "Created environment variable",
|
|
70
|
+
"content": {
|
|
71
|
+
"application/json": {
|
|
72
|
+
"schema": {
|
|
73
|
+
"$ref": "#/components/schemas/EnvironmentVariable"
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
},
|
|
78
|
+
"400": {
|
|
79
|
+
"description": "Invalid request"
|
|
80
|
+
},
|
|
81
|
+
"401": {
|
|
82
|
+
"description": "Unauthorized"
|
|
83
|
+
},
|
|
84
|
+
"403": {
|
|
85
|
+
"description": "Forbidden"
|
|
86
|
+
},
|
|
87
|
+
"409": {
|
|
88
|
+
"description": "Environment variable with this key already exists"
|
|
89
|
+
},
|
|
90
|
+
"500": {
|
|
91
|
+
"description": "Internal server error"
|
|
92
|
+
}
|
|
93
|
+
}
|
|
94
|
+
}
|
|
95
|
+
},
|
|
96
|
+
"/v1/environments/groups": {
|
|
97
|
+
"get": {
|
|
98
|
+
"operationId": "listEnvironmentGroups",
|
|
99
|
+
"summary": "listEnvironmentGroups",
|
|
100
|
+
"description": "List all environment groups for the organization.",
|
|
101
|
+
"tags": [
|
|
102
|
+
"environments"
|
|
103
|
+
],
|
|
104
|
+
"responses": {
|
|
105
|
+
"200": {
|
|
106
|
+
"description": "List of environment groups",
|
|
107
|
+
"content": {
|
|
108
|
+
"application/json": {
|
|
109
|
+
"schema": {
|
|
110
|
+
"$ref": "#/components/schemas/EnvironmentGroupList"
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
}
|
|
114
|
+
},
|
|
115
|
+
"401": {
|
|
116
|
+
"description": "Unauthorized"
|
|
117
|
+
},
|
|
118
|
+
"403": {
|
|
119
|
+
"description": "Forbidden"
|
|
120
|
+
},
|
|
121
|
+
"500": {
|
|
122
|
+
"description": "Internal server error"
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
}
|
|
126
|
+
},
|
|
127
|
+
"/v1/environments/groups/{name}": {
|
|
128
|
+
"parameters": [
|
|
129
|
+
{
|
|
130
|
+
"name": "name",
|
|
131
|
+
"in": "path",
|
|
132
|
+
"required": true,
|
|
133
|
+
"schema": {
|
|
134
|
+
"type": "string"
|
|
135
|
+
}
|
|
136
|
+
}
|
|
137
|
+
],
|
|
138
|
+
"put": {
|
|
139
|
+
"operationId": "putEnvironmentGroup",
|
|
140
|
+
"summary": "putEnvironmentGroup",
|
|
141
|
+
"description": "Create or update an environment group by name. Acts as an upsert — creates the group if it does not exist.",
|
|
142
|
+
"tags": [
|
|
143
|
+
"environments"
|
|
144
|
+
],
|
|
145
|
+
"requestBody": {
|
|
146
|
+
"required": true,
|
|
147
|
+
"content": {
|
|
148
|
+
"application/json": {
|
|
149
|
+
"schema": {
|
|
150
|
+
"$ref": "#/components/schemas/EnvironmentGroupUpsertRequest"
|
|
151
|
+
}
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
},
|
|
155
|
+
"responses": {
|
|
156
|
+
"200": {
|
|
157
|
+
"description": "Updated group",
|
|
158
|
+
"content": {
|
|
159
|
+
"application/json": {
|
|
160
|
+
"schema": {
|
|
161
|
+
"$ref": "#/components/schemas/EnvironmentGroup"
|
|
162
|
+
}
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
},
|
|
166
|
+
"201": {
|
|
167
|
+
"description": "Created group",
|
|
168
|
+
"content": {
|
|
169
|
+
"application/json": {
|
|
170
|
+
"schema": {
|
|
171
|
+
"$ref": "#/components/schemas/EnvironmentGroup"
|
|
172
|
+
}
|
|
173
|
+
}
|
|
174
|
+
}
|
|
175
|
+
},
|
|
176
|
+
"401": {
|
|
177
|
+
"description": "Unauthorized"
|
|
178
|
+
},
|
|
179
|
+
"403": {
|
|
180
|
+
"description": "Forbidden"
|
|
181
|
+
},
|
|
182
|
+
"500": {
|
|
183
|
+
"description": "Internal server error"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
},
|
|
187
|
+
"delete": {
|
|
188
|
+
"operationId": "deleteEnvironmentGroup",
|
|
189
|
+
"summary": "deleteEnvironmentGroup",
|
|
190
|
+
"description": "Deletes a group. Variables assigned to this group become ungrouped.",
|
|
191
|
+
"tags": [
|
|
192
|
+
"environments"
|
|
193
|
+
],
|
|
194
|
+
"responses": {
|
|
195
|
+
"204": {
|
|
196
|
+
"description": "Group deleted"
|
|
197
|
+
},
|
|
198
|
+
"401": {
|
|
199
|
+
"description": "Unauthorized"
|
|
200
|
+
},
|
|
201
|
+
"403": {
|
|
202
|
+
"description": "Forbidden"
|
|
203
|
+
},
|
|
204
|
+
"404": {
|
|
205
|
+
"description": "Group not found"
|
|
206
|
+
},
|
|
207
|
+
"500": {
|
|
208
|
+
"description": "Internal server error"
|
|
209
|
+
}
|
|
210
|
+
}
|
|
211
|
+
}
|
|
212
|
+
},
|
|
213
|
+
"/v1/environments/{key}": {
|
|
214
|
+
"parameters": [
|
|
215
|
+
{
|
|
216
|
+
"name": "key",
|
|
217
|
+
"in": "path",
|
|
218
|
+
"required": true,
|
|
219
|
+
"description": "Environment variable key",
|
|
220
|
+
"schema": {
|
|
221
|
+
"type": "string",
|
|
222
|
+
"pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
|
|
223
|
+
}
|
|
224
|
+
}
|
|
225
|
+
],
|
|
226
|
+
"get": {
|
|
227
|
+
"operationId": "getEnvironmentVariable",
|
|
228
|
+
"summary": "getEnvironmentVariable",
|
|
229
|
+
"description": "Get an environment variable by key. Returns value for non-secret types, omitted for SecretString.",
|
|
230
|
+
"tags": [
|
|
231
|
+
"environments"
|
|
232
|
+
],
|
|
233
|
+
"responses": {
|
|
234
|
+
"200": {
|
|
235
|
+
"description": "Environment variable",
|
|
236
|
+
"content": {
|
|
237
|
+
"application/json": {
|
|
238
|
+
"schema": {
|
|
239
|
+
"$ref": "#/components/schemas/EnvironmentVariable"
|
|
240
|
+
}
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
},
|
|
244
|
+
"401": {
|
|
245
|
+
"description": "Unauthorized"
|
|
246
|
+
},
|
|
247
|
+
"403": {
|
|
248
|
+
"description": "Forbidden"
|
|
249
|
+
},
|
|
250
|
+
"404": {
|
|
251
|
+
"description": "Environment variable not found"
|
|
252
|
+
},
|
|
253
|
+
"500": {
|
|
254
|
+
"description": "Internal server error"
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
},
|
|
258
|
+
"put": {
|
|
259
|
+
"operationId": "updateEnvironmentVariable",
|
|
260
|
+
"summary": "updateEnvironmentVariable",
|
|
261
|
+
"description": "Create or update an environment variable. Acts as an upsert — creates the variable if it does not exist. If `group` is provided and the group does not yet exist, it is created automatically.",
|
|
262
|
+
"tags": [
|
|
263
|
+
"environments"
|
|
264
|
+
],
|
|
265
|
+
"requestBody": {
|
|
266
|
+
"required": true,
|
|
267
|
+
"content": {
|
|
268
|
+
"application/json": {
|
|
269
|
+
"schema": {
|
|
270
|
+
"$ref": "#/components/schemas/EnvironmentVariableUpdateRequest"
|
|
271
|
+
}
|
|
272
|
+
}
|
|
273
|
+
}
|
|
274
|
+
},
|
|
275
|
+
"responses": {
|
|
276
|
+
"200": {
|
|
277
|
+
"description": "Updated environment variable",
|
|
278
|
+
"content": {
|
|
279
|
+
"application/json": {
|
|
280
|
+
"schema": {
|
|
281
|
+
"$ref": "#/components/schemas/EnvironmentVariable"
|
|
282
|
+
}
|
|
283
|
+
}
|
|
284
|
+
}
|
|
285
|
+
},
|
|
286
|
+
"201": {
|
|
287
|
+
"description": "Created environment variable",
|
|
288
|
+
"content": {
|
|
289
|
+
"application/json": {
|
|
290
|
+
"schema": {
|
|
291
|
+
"$ref": "#/components/schemas/EnvironmentVariable"
|
|
292
|
+
}
|
|
293
|
+
}
|
|
294
|
+
}
|
|
295
|
+
},
|
|
296
|
+
"400": {
|
|
297
|
+
"description": "Invalid request"
|
|
298
|
+
},
|
|
299
|
+
"401": {
|
|
300
|
+
"description": "Unauthorized"
|
|
301
|
+
},
|
|
302
|
+
"403": {
|
|
303
|
+
"description": "Forbidden"
|
|
304
|
+
},
|
|
305
|
+
"409": {
|
|
306
|
+
"description": "Cannot change the type of a variable that currently holds a value"
|
|
307
|
+
},
|
|
308
|
+
"500": {
|
|
309
|
+
"description": "Internal server error"
|
|
310
|
+
}
|
|
311
|
+
}
|
|
312
|
+
},
|
|
313
|
+
"delete": {
|
|
314
|
+
"operationId": "deleteEnvironmentVariable",
|
|
315
|
+
"summary": "deleteEnvironmentVariable",
|
|
316
|
+
"description": "Delete an environment variable by key.",
|
|
317
|
+
"tags": [
|
|
318
|
+
"environments"
|
|
319
|
+
],
|
|
320
|
+
"responses": {
|
|
321
|
+
"204": {
|
|
322
|
+
"description": "Environment variable deleted"
|
|
323
|
+
},
|
|
324
|
+
"401": {
|
|
325
|
+
"description": "Unauthorized"
|
|
326
|
+
},
|
|
327
|
+
"403": {
|
|
328
|
+
"description": "Forbidden"
|
|
329
|
+
},
|
|
330
|
+
"404": {
|
|
331
|
+
"description": "Environment variable not found"
|
|
332
|
+
},
|
|
333
|
+
"500": {
|
|
334
|
+
"description": "Internal server error"
|
|
335
|
+
}
|
|
336
|
+
}
|
|
337
|
+
}
|
|
338
|
+
}
|
|
339
|
+
},
|
|
340
|
+
"components": {
|
|
341
|
+
"securitySchemes": {
|
|
342
|
+
"EpilotAuth": {
|
|
343
|
+
"type": "http",
|
|
344
|
+
"scheme": "bearer",
|
|
345
|
+
"bearerFormat": "JWT"
|
|
346
|
+
}
|
|
347
|
+
},
|
|
348
|
+
"schemas": {
|
|
349
|
+
"EnvironmentValueType": {
|
|
350
|
+
"type": "string",
|
|
351
|
+
"description": "The structure a variable's value holds. `SecretString` is encrypted at rest and\nits value is never returned. `Text`, `Number`, `Boolean`, `Map`, `JSON` and `Link`\nmay be served to browser-facing consumers; `String` and `SecretString` may not. A\n`List` inherits this from its element type: a `List` is served only when its\n`itemType` is itself client-safe, so a `List<String>` or `List<SecretString>` is not.\n",
|
|
352
|
+
"enum": [
|
|
353
|
+
"String",
|
|
354
|
+
"SecretString",
|
|
355
|
+
"Text",
|
|
356
|
+
"Number",
|
|
357
|
+
"Boolean",
|
|
358
|
+
"Map",
|
|
359
|
+
"JSON",
|
|
360
|
+
"Link",
|
|
361
|
+
"List"
|
|
362
|
+
]
|
|
363
|
+
},
|
|
364
|
+
"StringTranslations": {
|
|
365
|
+
"description": "A string translated per language. Keys are language codes (e.g. `de`,\n`en-US`), matching the hyphen-only BCP-47 form epilot's i18n stack uses\neverywhere else: `^[a-z]{2,3}(-[A-Za-z0-9]+)*$`. The server enforces\nthat with LANGUAGE_KEY_PATTERN in src/core/value-types.ts — the two are\nnot otherwise linked. The pattern is documented rather than declared\nbecause `propertyNames` is JSON Schema / OAS 3.1 and this document is\n3.0.3, where it fails `spectral lint` (oas3-schema).\n",
|
|
366
|
+
"type": "object",
|
|
367
|
+
"minProperties": 1,
|
|
368
|
+
"additionalProperties": {
|
|
369
|
+
"type": "string",
|
|
370
|
+
"minLength": 1
|
|
371
|
+
}
|
|
372
|
+
},
|
|
373
|
+
"MapEntry": {
|
|
374
|
+
"description": "One entry of a Map. `key` is the token a journey submits; `value` is\nwhat the customer reads — either one string, or one string per\nlanguage. Every entry of a Map must agree on which of the two it uses.\n",
|
|
375
|
+
"type": "object",
|
|
376
|
+
"required": [
|
|
377
|
+
"key",
|
|
378
|
+
"value"
|
|
379
|
+
],
|
|
380
|
+
"additionalProperties": false,
|
|
381
|
+
"properties": {
|
|
382
|
+
"key": {
|
|
383
|
+
"type": "string",
|
|
384
|
+
"minLength": 1
|
|
385
|
+
},
|
|
386
|
+
"value": {
|
|
387
|
+
"oneOf": [
|
|
388
|
+
{
|
|
389
|
+
"type": "string",
|
|
390
|
+
"minLength": 1
|
|
391
|
+
},
|
|
392
|
+
{
|
|
393
|
+
"$ref": "#/components/schemas/StringTranslations"
|
|
394
|
+
}
|
|
395
|
+
]
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
},
|
|
399
|
+
"MapValue": {
|
|
400
|
+
"type": "object",
|
|
401
|
+
"required": [
|
|
402
|
+
"options"
|
|
403
|
+
],
|
|
404
|
+
"additionalProperties": false,
|
|
405
|
+
"properties": {
|
|
406
|
+
"fallbackLanguage": {
|
|
407
|
+
"type": "string",
|
|
408
|
+
"minLength": 2,
|
|
409
|
+
"default": "de"
|
|
410
|
+
},
|
|
411
|
+
"options": {
|
|
412
|
+
"type": "array",
|
|
413
|
+
"minItems": 1,
|
|
414
|
+
"items": {
|
|
415
|
+
"$ref": "#/components/schemas/MapEntry"
|
|
416
|
+
}
|
|
417
|
+
}
|
|
418
|
+
}
|
|
419
|
+
},
|
|
420
|
+
"JsonValue": {
|
|
421
|
+
"description": "Arbitrary JSON object, e.g. a flat key/value map used by integrations for\nenum translation: {\"Mr.\": 1, \"Ms. / Mrs.\": 2}. Max 32 KB serialised.\n",
|
|
422
|
+
"type": "object",
|
|
423
|
+
"additionalProperties": true
|
|
424
|
+
},
|
|
425
|
+
"LinkValue": {
|
|
426
|
+
"description": "One URL with a label and description a customer reads. `label` and\n`description` are each either a plain string or one string per language;\nthe two fields decide that independently — a plain string means \"the\nsame in every language\". A translated field must carry the fallback\nlanguage.\n\nThe URL must be absolute and `http`/`https` only. This value is served\nto browser-facing consumers, so `javascript:` and `data:` URLs are\nrejected at write time.\n\nWritten flat rather than composed from a shared field set: `allOf` plus\n`additionalProperties: false` is rejected by most validators, because\neach branch sees the sibling's properties as unknown. The composition\nlives in zod (LinkFieldsSchema) — see src/core/value-types.ts.\n\nEach translated value of `label` and `description` is also limited to\nthe same maximum as the plain-string form above — 255 characters for\n`label`, 1024 for `description`. The limit is enforced by the server\neven though the shared `StringTranslations` schema referenced below\ndoes not itself declare it.\n",
|
|
427
|
+
"type": "object",
|
|
428
|
+
"required": [
|
|
429
|
+
"url",
|
|
430
|
+
"label"
|
|
431
|
+
],
|
|
432
|
+
"additionalProperties": false,
|
|
433
|
+
"properties": {
|
|
434
|
+
"url": {
|
|
435
|
+
"type": "string",
|
|
436
|
+
"minLength": 1,
|
|
437
|
+
"maxLength": 2048
|
|
438
|
+
},
|
|
439
|
+
"label": {
|
|
440
|
+
"oneOf": [
|
|
441
|
+
{
|
|
442
|
+
"type": "string",
|
|
443
|
+
"minLength": 1,
|
|
444
|
+
"maxLength": 255
|
|
445
|
+
},
|
|
446
|
+
{
|
|
447
|
+
"$ref": "#/components/schemas/StringTranslations"
|
|
448
|
+
}
|
|
449
|
+
]
|
|
450
|
+
},
|
|
451
|
+
"description": {
|
|
452
|
+
"oneOf": [
|
|
453
|
+
{
|
|
454
|
+
"type": "string",
|
|
455
|
+
"minLength": 1,
|
|
456
|
+
"maxLength": 1024
|
|
457
|
+
},
|
|
458
|
+
{
|
|
459
|
+
"$ref": "#/components/schemas/StringTranslations"
|
|
460
|
+
}
|
|
461
|
+
]
|
|
462
|
+
},
|
|
463
|
+
"fallbackLanguage": {
|
|
464
|
+
"type": "string",
|
|
465
|
+
"minLength": 2,
|
|
466
|
+
"default": "de"
|
|
467
|
+
}
|
|
468
|
+
}
|
|
469
|
+
},
|
|
470
|
+
"LinkFields": {
|
|
471
|
+
"description": "The fields of a link, without a fallback language — the shape a `List`\nitem carries. Inside a list the fallback belongs to the wrapper, which\nowns the language tabs for every row.\n\nRestated rather than composed with `LinkValue`: `allOf` plus\n`additionalProperties: false` is rejected by most validators, because\neach branch sees the sibling's properties as unknown. zod composes\nproperly — see LinkFieldsSchema in src/core/value-types.ts.\n",
|
|
472
|
+
"type": "object",
|
|
473
|
+
"required": [
|
|
474
|
+
"url",
|
|
475
|
+
"label"
|
|
476
|
+
],
|
|
477
|
+
"additionalProperties": false,
|
|
478
|
+
"properties": {
|
|
479
|
+
"url": {
|
|
480
|
+
"type": "string",
|
|
481
|
+
"minLength": 1,
|
|
482
|
+
"maxLength": 2048
|
|
483
|
+
},
|
|
484
|
+
"label": {
|
|
485
|
+
"oneOf": [
|
|
486
|
+
{
|
|
487
|
+
"type": "string",
|
|
488
|
+
"minLength": 1,
|
|
489
|
+
"maxLength": 255
|
|
490
|
+
},
|
|
491
|
+
{
|
|
492
|
+
"$ref": "#/components/schemas/StringTranslations"
|
|
493
|
+
}
|
|
494
|
+
]
|
|
495
|
+
},
|
|
496
|
+
"description": {
|
|
497
|
+
"oneOf": [
|
|
498
|
+
{
|
|
499
|
+
"type": "string",
|
|
500
|
+
"minLength": 1,
|
|
501
|
+
"maxLength": 1024
|
|
502
|
+
},
|
|
503
|
+
{
|
|
504
|
+
"$ref": "#/components/schemas/StringTranslations"
|
|
505
|
+
}
|
|
506
|
+
]
|
|
507
|
+
}
|
|
508
|
+
}
|
|
509
|
+
},
|
|
510
|
+
"ListItemType": {
|
|
511
|
+
"description": "The element type a `List` holds — every value type except the\ncontainers. `Map` is already a keyed collection and a list of lists has\nno consumer. A list is exactly as client-safe and exactly as secret as\nits element type: a list of `SecretString` is encrypted per item and its\nvalue is never returned.\n",
|
|
512
|
+
"type": "string",
|
|
513
|
+
"enum": [
|
|
514
|
+
"String",
|
|
515
|
+
"SecretString",
|
|
516
|
+
"Text",
|
|
517
|
+
"Number",
|
|
518
|
+
"Boolean",
|
|
519
|
+
"JSON",
|
|
520
|
+
"Link"
|
|
521
|
+
]
|
|
522
|
+
},
|
|
523
|
+
"ListOfText": {
|
|
524
|
+
"type": "object",
|
|
525
|
+
"required": [
|
|
526
|
+
"itemType",
|
|
527
|
+
"items"
|
|
528
|
+
],
|
|
529
|
+
"additionalProperties": false,
|
|
530
|
+
"properties": {
|
|
531
|
+
"itemType": {
|
|
532
|
+
"type": "string",
|
|
533
|
+
"enum": [
|
|
534
|
+
"Text"
|
|
535
|
+
]
|
|
536
|
+
},
|
|
537
|
+
"items": {
|
|
538
|
+
"type": "array",
|
|
539
|
+
"minItems": 1,
|
|
540
|
+
"items": {
|
|
541
|
+
"type": "string",
|
|
542
|
+
"minLength": 1,
|
|
543
|
+
"maxLength": 32768
|
|
544
|
+
}
|
|
545
|
+
}
|
|
546
|
+
}
|
|
547
|
+
},
|
|
548
|
+
"ListOfString": {
|
|
549
|
+
"type": "object",
|
|
550
|
+
"required": [
|
|
551
|
+
"itemType",
|
|
552
|
+
"items"
|
|
553
|
+
],
|
|
554
|
+
"additionalProperties": false,
|
|
555
|
+
"properties": {
|
|
556
|
+
"itemType": {
|
|
557
|
+
"type": "string",
|
|
558
|
+
"enum": [
|
|
559
|
+
"String"
|
|
560
|
+
]
|
|
561
|
+
},
|
|
562
|
+
"items": {
|
|
563
|
+
"type": "array",
|
|
564
|
+
"minItems": 1,
|
|
565
|
+
"items": {
|
|
566
|
+
"type": "string",
|
|
567
|
+
"minLength": 1
|
|
568
|
+
}
|
|
569
|
+
}
|
|
570
|
+
}
|
|
571
|
+
},
|
|
572
|
+
"ListOfSecretString": {
|
|
573
|
+
"description": "Write-only in effect: the items are encrypted per item at rest and the\nwhole value is omitted from every read response, exactly as a\n`SecretString` variable's value is. Read `item_type` to learn what a\nlist holds when its value is withheld.\n",
|
|
574
|
+
"type": "object",
|
|
575
|
+
"required": [
|
|
576
|
+
"itemType",
|
|
577
|
+
"items"
|
|
578
|
+
],
|
|
579
|
+
"additionalProperties": false,
|
|
580
|
+
"properties": {
|
|
581
|
+
"itemType": {
|
|
582
|
+
"type": "string",
|
|
583
|
+
"enum": [
|
|
584
|
+
"SecretString"
|
|
585
|
+
]
|
|
586
|
+
},
|
|
587
|
+
"items": {
|
|
588
|
+
"type": "array",
|
|
589
|
+
"minItems": 1,
|
|
590
|
+
"items": {
|
|
591
|
+
"type": "string",
|
|
592
|
+
"minLength": 1,
|
|
593
|
+
"description": "Must be at most 4096 bytes when UTF-8 encoded — the same limit KMS\nenforces on a symmetric Encrypt call. This is a byte bound, not a\ncharacter bound: a string with multi-byte characters can be well\nunder 4096 characters long and still be rejected.\n"
|
|
594
|
+
}
|
|
595
|
+
}
|
|
596
|
+
}
|
|
597
|
+
},
|
|
598
|
+
"ListOfNumber": {
|
|
599
|
+
"type": "object",
|
|
600
|
+
"required": [
|
|
601
|
+
"itemType",
|
|
602
|
+
"items"
|
|
603
|
+
],
|
|
604
|
+
"additionalProperties": false,
|
|
605
|
+
"properties": {
|
|
606
|
+
"itemType": {
|
|
607
|
+
"type": "string",
|
|
608
|
+
"enum": [
|
|
609
|
+
"Number"
|
|
610
|
+
]
|
|
611
|
+
},
|
|
612
|
+
"items": {
|
|
613
|
+
"type": "array",
|
|
614
|
+
"minItems": 1,
|
|
615
|
+
"items": {
|
|
616
|
+
"type": "number"
|
|
617
|
+
}
|
|
618
|
+
}
|
|
619
|
+
}
|
|
620
|
+
},
|
|
621
|
+
"ListOfBoolean": {
|
|
622
|
+
"type": "object",
|
|
623
|
+
"required": [
|
|
624
|
+
"itemType",
|
|
625
|
+
"items"
|
|
626
|
+
],
|
|
627
|
+
"additionalProperties": false,
|
|
628
|
+
"properties": {
|
|
629
|
+
"itemType": {
|
|
630
|
+
"type": "string",
|
|
631
|
+
"enum": [
|
|
632
|
+
"Boolean"
|
|
633
|
+
]
|
|
634
|
+
},
|
|
635
|
+
"items": {
|
|
636
|
+
"type": "array",
|
|
637
|
+
"minItems": 1,
|
|
638
|
+
"items": {
|
|
639
|
+
"type": "boolean"
|
|
640
|
+
}
|
|
641
|
+
}
|
|
642
|
+
}
|
|
643
|
+
},
|
|
644
|
+
"ListOfJson": {
|
|
645
|
+
"type": "object",
|
|
646
|
+
"required": [
|
|
647
|
+
"itemType",
|
|
648
|
+
"items"
|
|
649
|
+
],
|
|
650
|
+
"additionalProperties": false,
|
|
651
|
+
"properties": {
|
|
652
|
+
"itemType": {
|
|
653
|
+
"type": "string",
|
|
654
|
+
"enum": [
|
|
655
|
+
"JSON"
|
|
656
|
+
]
|
|
657
|
+
},
|
|
658
|
+
"items": {
|
|
659
|
+
"type": "array",
|
|
660
|
+
"minItems": 1,
|
|
661
|
+
"items": {
|
|
662
|
+
"type": "object",
|
|
663
|
+
"additionalProperties": true
|
|
664
|
+
}
|
|
665
|
+
}
|
|
666
|
+
}
|
|
667
|
+
},
|
|
668
|
+
"ListOfLink": {
|
|
669
|
+
"description": "A list of links. `fallbackLanguage` applies to every item's translated\n`label` and `description`; items may mix plain and translated fields\nfreely, since a plain string is a complete answer for any language.\n",
|
|
670
|
+
"type": "object",
|
|
671
|
+
"required": [
|
|
672
|
+
"itemType",
|
|
673
|
+
"items"
|
|
674
|
+
],
|
|
675
|
+
"additionalProperties": false,
|
|
676
|
+
"properties": {
|
|
677
|
+
"itemType": {
|
|
678
|
+
"type": "string",
|
|
679
|
+
"enum": [
|
|
680
|
+
"Link"
|
|
681
|
+
]
|
|
682
|
+
},
|
|
683
|
+
"fallbackLanguage": {
|
|
684
|
+
"type": "string",
|
|
685
|
+
"minLength": 2,
|
|
686
|
+
"default": "de"
|
|
687
|
+
},
|
|
688
|
+
"items": {
|
|
689
|
+
"type": "array",
|
|
690
|
+
"minItems": 1,
|
|
691
|
+
"items": {
|
|
692
|
+
"$ref": "#/components/schemas/LinkFields"
|
|
693
|
+
}
|
|
694
|
+
}
|
|
695
|
+
}
|
|
696
|
+
},
|
|
697
|
+
"ListValue": {
|
|
698
|
+
"description": "An ordered collection of one declared element type. Items round-trip in\nthe order written; nothing sorts them. Holds at most 100 items.\n\nThe whole value is limited to 32768 characters when serialised — the\nserver enforces this, and it is not expressible per-property here.\n",
|
|
699
|
+
"oneOf": [
|
|
700
|
+
{
|
|
701
|
+
"$ref": "#/components/schemas/ListOfText"
|
|
702
|
+
},
|
|
703
|
+
{
|
|
704
|
+
"$ref": "#/components/schemas/ListOfNumber"
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"$ref": "#/components/schemas/ListOfBoolean"
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
"$ref": "#/components/schemas/ListOfJson"
|
|
711
|
+
},
|
|
712
|
+
{
|
|
713
|
+
"$ref": "#/components/schemas/ListOfLink"
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"$ref": "#/components/schemas/ListOfString"
|
|
717
|
+
},
|
|
718
|
+
{
|
|
719
|
+
"$ref": "#/components/schemas/ListOfSecretString"
|
|
720
|
+
}
|
|
721
|
+
],
|
|
722
|
+
"discriminator": {
|
|
723
|
+
"propertyName": "itemType",
|
|
724
|
+
"mapping": {
|
|
725
|
+
"Text": "#/components/schemas/ListOfText",
|
|
726
|
+
"Number": "#/components/schemas/ListOfNumber",
|
|
727
|
+
"Boolean": "#/components/schemas/ListOfBoolean",
|
|
728
|
+
"JSON": "#/components/schemas/ListOfJson",
|
|
729
|
+
"Link": "#/components/schemas/ListOfLink",
|
|
730
|
+
"String": "#/components/schemas/ListOfString",
|
|
731
|
+
"SecretString": "#/components/schemas/ListOfSecretString"
|
|
732
|
+
}
|
|
733
|
+
}
|
|
734
|
+
},
|
|
735
|
+
"EnvironmentValue": {
|
|
736
|
+
"description": "A variable's value. The JSON type corresponds to the variable's `type`:\n`String`, `SecretString` and `Text` are strings, `Number` is a number,\n`Boolean` is a boolean, and `Map`, `JSON`, `Link` and `List` are objects.\nNumbers are IEEE 754 doubles; integers above 2^53 may lose precision on\nround-trip.\n",
|
|
737
|
+
"anyOf": [
|
|
738
|
+
{
|
|
739
|
+
"type": "string"
|
|
740
|
+
},
|
|
741
|
+
{
|
|
742
|
+
"type": "number"
|
|
743
|
+
},
|
|
744
|
+
{
|
|
745
|
+
"type": "boolean"
|
|
746
|
+
},
|
|
747
|
+
{
|
|
748
|
+
"$ref": "#/components/schemas/MapValue"
|
|
749
|
+
},
|
|
750
|
+
{
|
|
751
|
+
"$ref": "#/components/schemas/JsonValue"
|
|
752
|
+
},
|
|
753
|
+
{
|
|
754
|
+
"$ref": "#/components/schemas/LinkValue"
|
|
755
|
+
},
|
|
756
|
+
{
|
|
757
|
+
"$ref": "#/components/schemas/ListValue"
|
|
758
|
+
}
|
|
759
|
+
]
|
|
760
|
+
},
|
|
761
|
+
"EnvironmentVariable": {
|
|
762
|
+
"type": "object",
|
|
763
|
+
"required": [
|
|
764
|
+
"key",
|
|
765
|
+
"type",
|
|
766
|
+
"created_at",
|
|
767
|
+
"updated_at"
|
|
768
|
+
],
|
|
769
|
+
"properties": {
|
|
770
|
+
"key": {
|
|
771
|
+
"type": "string",
|
|
772
|
+
"pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
|
|
773
|
+
},
|
|
774
|
+
"type": {
|
|
775
|
+
"$ref": "#/components/schemas/EnvironmentValueType"
|
|
776
|
+
},
|
|
777
|
+
"item_type": {
|
|
778
|
+
"allOf": [
|
|
779
|
+
{
|
|
780
|
+
"$ref": "#/components/schemas/ListItemType"
|
|
781
|
+
}
|
|
782
|
+
],
|
|
783
|
+
"description": "Present only for a `List` variable that holds a value, derived from\nthat value at read time and never stored. Returned even when `value`\nitself is withheld, which is the case for a list of `SecretString` —\nit is the only way a client learns what such a list holds.\n"
|
|
784
|
+
},
|
|
785
|
+
"description": {
|
|
786
|
+
"type": "string"
|
|
787
|
+
},
|
|
788
|
+
"group": {
|
|
789
|
+
"type": "string",
|
|
790
|
+
"description": "Optional group name for organising variables in the UI"
|
|
791
|
+
},
|
|
792
|
+
"value": {
|
|
793
|
+
"allOf": [
|
|
794
|
+
{
|
|
795
|
+
"$ref": "#/components/schemas/EnvironmentValue"
|
|
796
|
+
}
|
|
797
|
+
],
|
|
798
|
+
"description": "Returned for non-secret types, omitted for SecretString and for a\nList of SecretString. Also omitted when\nthe variable has been created without a value — for example by a blueprint\ninstall, which syncs a variable's key and type but never its value.\n"
|
|
799
|
+
},
|
|
800
|
+
"protected": {
|
|
801
|
+
"type": "boolean",
|
|
802
|
+
"description": "Whether the variable is protected from editing"
|
|
803
|
+
},
|
|
804
|
+
"created_at": {
|
|
805
|
+
"type": "string",
|
|
806
|
+
"format": "date-time"
|
|
807
|
+
},
|
|
808
|
+
"updated_at": {
|
|
809
|
+
"type": "string",
|
|
810
|
+
"format": "date-time"
|
|
811
|
+
}
|
|
812
|
+
}
|
|
813
|
+
},
|
|
814
|
+
"EnvironmentVariableListItem": {
|
|
815
|
+
"type": "object",
|
|
816
|
+
"required": [
|
|
817
|
+
"key",
|
|
818
|
+
"type",
|
|
819
|
+
"created_at",
|
|
820
|
+
"updated_at"
|
|
821
|
+
],
|
|
822
|
+
"properties": {
|
|
823
|
+
"key": {
|
|
824
|
+
"type": "string"
|
|
825
|
+
},
|
|
826
|
+
"type": {
|
|
827
|
+
"$ref": "#/components/schemas/EnvironmentValueType"
|
|
828
|
+
},
|
|
829
|
+
"item_type": {
|
|
830
|
+
"allOf": [
|
|
831
|
+
{
|
|
832
|
+
"$ref": "#/components/schemas/ListItemType"
|
|
833
|
+
}
|
|
834
|
+
],
|
|
835
|
+
"description": "Present only for a `List` variable that holds a value, derived from\nthat value at read time and never stored. Returned even when `value`\nitself is withheld, which is the case for a list of `SecretString` —\nit is the only way a client learns what such a list holds.\n"
|
|
836
|
+
},
|
|
837
|
+
"description": {
|
|
838
|
+
"type": "string"
|
|
839
|
+
},
|
|
840
|
+
"group": {
|
|
841
|
+
"type": "string",
|
|
842
|
+
"description": "Optional group name for organising variables in the UI"
|
|
843
|
+
},
|
|
844
|
+
"value": {
|
|
845
|
+
"allOf": [
|
|
846
|
+
{
|
|
847
|
+
"$ref": "#/components/schemas/EnvironmentValue"
|
|
848
|
+
}
|
|
849
|
+
],
|
|
850
|
+
"description": "Returned for non-secret types, omitted for SecretString and for a\nList of SecretString. Also omitted when\nthe variable has been created without a value — for example by a blueprint\ninstall, which syncs a variable's key and type but never its value.\n"
|
|
851
|
+
},
|
|
852
|
+
"protected": {
|
|
853
|
+
"type": "boolean",
|
|
854
|
+
"description": "Whether the variable is protected from editing"
|
|
855
|
+
},
|
|
856
|
+
"created_at": {
|
|
857
|
+
"type": "string",
|
|
858
|
+
"format": "date-time"
|
|
859
|
+
},
|
|
860
|
+
"updated_at": {
|
|
861
|
+
"type": "string",
|
|
862
|
+
"format": "date-time"
|
|
863
|
+
}
|
|
864
|
+
}
|
|
865
|
+
},
|
|
866
|
+
"EnvironmentVariableList": {
|
|
867
|
+
"type": "object",
|
|
868
|
+
"required": [
|
|
869
|
+
"items"
|
|
870
|
+
],
|
|
871
|
+
"properties": {
|
|
872
|
+
"items": {
|
|
873
|
+
"type": "array",
|
|
874
|
+
"items": {
|
|
875
|
+
"$ref": "#/components/schemas/EnvironmentVariableListItem"
|
|
876
|
+
}
|
|
877
|
+
}
|
|
878
|
+
}
|
|
879
|
+
},
|
|
880
|
+
"EnvironmentVariableCreateRequest": {
|
|
881
|
+
"type": "object",
|
|
882
|
+
"required": [
|
|
883
|
+
"key",
|
|
884
|
+
"type"
|
|
885
|
+
],
|
|
886
|
+
"properties": {
|
|
887
|
+
"key": {
|
|
888
|
+
"type": "string",
|
|
889
|
+
"pattern": "^[a-z0-9][a-z0-9_.\\-]{0,127}$"
|
|
890
|
+
},
|
|
891
|
+
"type": {
|
|
892
|
+
"$ref": "#/components/schemas/EnvironmentValueType"
|
|
893
|
+
},
|
|
894
|
+
"description": {
|
|
895
|
+
"type": "string"
|
|
896
|
+
},
|
|
897
|
+
"group": {
|
|
898
|
+
"type": "string"
|
|
899
|
+
},
|
|
900
|
+
"value": {
|
|
901
|
+
"$ref": "#/components/schemas/EnvironmentValue"
|
|
902
|
+
},
|
|
903
|
+
"protected": {
|
|
904
|
+
"type": "boolean",
|
|
905
|
+
"description": "Whether the variable is protected from editing"
|
|
906
|
+
}
|
|
907
|
+
}
|
|
908
|
+
},
|
|
909
|
+
"EnvironmentVariableUpdateRequest": {
|
|
910
|
+
"type": "object",
|
|
911
|
+
"properties": {
|
|
912
|
+
"type": {
|
|
913
|
+
"description": "Type of variable. Used when creating a new variable. Defaults to String.",
|
|
914
|
+
"allOf": [
|
|
915
|
+
{
|
|
916
|
+
"$ref": "#/components/schemas/EnvironmentValueType"
|
|
917
|
+
}
|
|
918
|
+
]
|
|
919
|
+
},
|
|
920
|
+
"value": {
|
|
921
|
+
"$ref": "#/components/schemas/EnvironmentValue"
|
|
922
|
+
},
|
|
923
|
+
"description": {
|
|
924
|
+
"type": "string"
|
|
925
|
+
},
|
|
926
|
+
"group": {
|
|
927
|
+
"type": "string"
|
|
928
|
+
},
|
|
929
|
+
"protected": {
|
|
930
|
+
"type": "boolean",
|
|
931
|
+
"description": "Whether the variable is protected from editing"
|
|
932
|
+
}
|
|
933
|
+
}
|
|
934
|
+
},
|
|
935
|
+
"EnvironmentGroup": {
|
|
936
|
+
"type": "object",
|
|
937
|
+
"required": [
|
|
938
|
+
"name",
|
|
939
|
+
"created_at",
|
|
940
|
+
"updated_at"
|
|
941
|
+
],
|
|
942
|
+
"properties": {
|
|
943
|
+
"name": {
|
|
944
|
+
"type": "string"
|
|
945
|
+
},
|
|
946
|
+
"description": {
|
|
947
|
+
"type": "string"
|
|
948
|
+
},
|
|
949
|
+
"created_at": {
|
|
950
|
+
"type": "string",
|
|
951
|
+
"format": "date-time"
|
|
952
|
+
},
|
|
953
|
+
"updated_at": {
|
|
954
|
+
"type": "string",
|
|
955
|
+
"format": "date-time"
|
|
956
|
+
}
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"EnvironmentGroupList": {
|
|
960
|
+
"type": "object",
|
|
961
|
+
"required": [
|
|
962
|
+
"items"
|
|
963
|
+
],
|
|
964
|
+
"properties": {
|
|
965
|
+
"items": {
|
|
966
|
+
"type": "array",
|
|
967
|
+
"items": {
|
|
968
|
+
"$ref": "#/components/schemas/EnvironmentGroup"
|
|
969
|
+
}
|
|
970
|
+
}
|
|
971
|
+
}
|
|
972
|
+
},
|
|
973
|
+
"EnvironmentGroupUpsertRequest": {
|
|
974
|
+
"type": "object",
|
|
975
|
+
"properties": {
|
|
976
|
+
"description": {
|
|
977
|
+
"type": "string"
|
|
978
|
+
}
|
|
979
|
+
}
|
|
980
|
+
}
|
|
981
|
+
}
|
|
982
|
+
},
|
|
983
|
+
"servers": [
|
|
984
|
+
{
|
|
985
|
+
"url": "https://environments.sls.epilot.io"
|
|
986
|
+
}
|
|
987
|
+
]
|
|
988
|
+
}
|