@meshery/schemas 1.2.1 → 1.2.3
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/dist/api.d.mts +39 -4
- package/dist/api.d.ts +39 -4
- package/dist/api.js +2 -2
- package/dist/api.mjs +2 -2
- package/dist/cloudApi.d.mts +12600 -14467
- package/dist/cloudApi.d.ts +12600 -14467
- package/dist/cloudApi.js +1 -1
- package/dist/cloudApi.mjs +1 -1
- package/dist/constructs/v1beta2/team/Team.d.mts +28 -8
- package/dist/constructs/v1beta2/team/Team.d.ts +28 -8
- package/dist/constructs/v1beta2/team/TeamSchema.js +1 -1
- package/dist/constructs/v1beta2/team/TeamSchema.mjs +1 -1
- package/dist/constructs/v1beta3/design/Design.d.mts +2324 -14651
- package/dist/constructs/v1beta3/design/Design.d.ts +2324 -14651
- package/dist/constructs/v1beta3/design/DesignSchema.js +17 -471
- package/dist/constructs/v1beta3/design/DesignSchema.mjs +17 -471
- package/dist/constructs/v1beta3/filter/Filter.d.mts +1366 -0
- package/dist/constructs/v1beta3/filter/Filter.d.ts +1366 -0
- package/dist/constructs/v1beta3/filter/Filter.js +1 -0
- package/dist/constructs/v1beta3/filter/Filter.mjs +0 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.d.mts +7 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.d.ts +7 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.js +80 -0
- package/dist/constructs/v1beta3/filter/FilterSchema.mjs +80 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.mts +832 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +832 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.js +1 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.mjs +0 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.mts +7 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.d.ts +7 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +2 -0
- package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +2 -0
- package/dist/mesheryApi.d.mts +1094 -1086
- package/dist/mesheryApi.d.ts +1094 -1086
- package/dist/mesheryApi.js +1 -1
- package/dist/mesheryApi.mjs +1 -1
- package/package.json +1 -1
|
@@ -0,0 +1,832 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
|
3
|
+
* Do not make direct changes to the file.
|
|
4
|
+
*/
|
|
5
|
+
interface paths {
|
|
6
|
+
"/api/performance-profiles": {
|
|
7
|
+
/** Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering. */
|
|
8
|
+
get: operations["getPerformanceProfiles"];
|
|
9
|
+
/** Creates a new performance profile when the body omits id, or updates the matching existing profile when an id is provided. */
|
|
10
|
+
post: operations["upsertPerformanceProfile"];
|
|
11
|
+
};
|
|
12
|
+
"/api/performance-profiles/{performanceProfileId}": {
|
|
13
|
+
/** Returns a single performance profile owned by (or visible to) the authenticated user. */
|
|
14
|
+
get: operations["getPerformanceProfile"];
|
|
15
|
+
/** Updates the performance profile identified by the path parameter. */
|
|
16
|
+
put: operations["updatePerformanceProfile"];
|
|
17
|
+
/** Deletes the performance profile identified by the path parameter and any associated performance results. */
|
|
18
|
+
delete: operations["deletePerformanceProfile"];
|
|
19
|
+
};
|
|
20
|
+
}
|
|
21
|
+
interface components {
|
|
22
|
+
schemas: {
|
|
23
|
+
/**
|
|
24
|
+
* PerformanceProfile
|
|
25
|
+
* @description A performance profile captures the configuration for a load test run by Meshery against one or more service-mesh endpoints. Profiles are owned by a user and can optionally be associated with a recurring schedule. Learn more at https://docs.meshery.io/tasks/performance-management
|
|
26
|
+
*/
|
|
27
|
+
PerformanceProfile: {
|
|
28
|
+
/**
|
|
29
|
+
* Format: uuid
|
|
30
|
+
* @description Unique identifier for the performance profile.
|
|
31
|
+
*/
|
|
32
|
+
id: string;
|
|
33
|
+
/** @description Human-readable name of the performance profile. */
|
|
34
|
+
name: string;
|
|
35
|
+
/**
|
|
36
|
+
* Format: uuid
|
|
37
|
+
* @description User ID of the profile owner.
|
|
38
|
+
*/
|
|
39
|
+
userId: string;
|
|
40
|
+
/**
|
|
41
|
+
* Format: uuid
|
|
42
|
+
* @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
|
|
43
|
+
*/
|
|
44
|
+
schedule?: string | null;
|
|
45
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
46
|
+
loadGenerators?: string[];
|
|
47
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
48
|
+
endpoints?: string[];
|
|
49
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
50
|
+
serviceMesh?: string;
|
|
51
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
52
|
+
concurrentRequest?: number;
|
|
53
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
54
|
+
qps?: number;
|
|
55
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
56
|
+
duration?: string;
|
|
57
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
|
|
58
|
+
requestHeaders?: string;
|
|
59
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
|
|
60
|
+
requestCookies?: string;
|
|
61
|
+
/** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
|
|
62
|
+
requestBody?: string;
|
|
63
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
|
|
64
|
+
contentType?: string;
|
|
65
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
66
|
+
metadata?: {
|
|
67
|
+
[key: string]: unknown;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Format: date-time
|
|
71
|
+
* @description Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
72
|
+
*/
|
|
73
|
+
lastRun?: string | null;
|
|
74
|
+
/** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
|
|
75
|
+
totalResults?: number;
|
|
76
|
+
/**
|
|
77
|
+
* Format: date-time
|
|
78
|
+
* @description Timestamp when the performance profile was created.
|
|
79
|
+
*/
|
|
80
|
+
createdAt: string;
|
|
81
|
+
/**
|
|
82
|
+
* Format: date-time
|
|
83
|
+
* @description Timestamp when the performance profile was last updated.
|
|
84
|
+
*/
|
|
85
|
+
updatedAt: string;
|
|
86
|
+
};
|
|
87
|
+
/** @description Payload for creating or updating a performance profile. Includes only client-settable fields; server-generated fields (id on create, createdAt, updatedAt, lastRun, totalResults) are populated by the server. */
|
|
88
|
+
PerformanceProfilePayload: {
|
|
89
|
+
/**
|
|
90
|
+
* Format: uuid
|
|
91
|
+
* @description Existing performance-profile ID for updates; omit on create.
|
|
92
|
+
*/
|
|
93
|
+
id?: string;
|
|
94
|
+
/** @description Human-readable name of the performance profile. */
|
|
95
|
+
name: string;
|
|
96
|
+
/**
|
|
97
|
+
* Format: uuid
|
|
98
|
+
* @description Owner user ID. When omitted, the server infers it from the authenticated user.
|
|
99
|
+
*/
|
|
100
|
+
userId?: string;
|
|
101
|
+
/**
|
|
102
|
+
* Format: uuid
|
|
103
|
+
* @description Optional schedule ID associating the profile with a recurring run.
|
|
104
|
+
*/
|
|
105
|
+
schedule?: string | null;
|
|
106
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
107
|
+
loadGenerators: string[];
|
|
108
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
109
|
+
endpoints: string[];
|
|
110
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
111
|
+
serviceMesh?: string;
|
|
112
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
113
|
+
concurrentRequest?: number;
|
|
114
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
115
|
+
qps?: number;
|
|
116
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
117
|
+
duration: string;
|
|
118
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
|
|
119
|
+
requestHeaders?: string;
|
|
120
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
|
|
121
|
+
requestCookies?: string;
|
|
122
|
+
/** @description HTTP request body sent on each load-test request. */
|
|
123
|
+
requestBody?: string;
|
|
124
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
|
|
125
|
+
contentType?: string;
|
|
126
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
127
|
+
metadata?: {
|
|
128
|
+
[key: string]: unknown;
|
|
129
|
+
};
|
|
130
|
+
};
|
|
131
|
+
/** @description Paginated list of performance profiles. */
|
|
132
|
+
PerformanceProfilePage: {
|
|
133
|
+
/** @description Zero-based page index returned in this response. */
|
|
134
|
+
page: number;
|
|
135
|
+
/** @description Maximum number of items returned on each page. */
|
|
136
|
+
pageSize: number;
|
|
137
|
+
/** @description Total number of performance profiles across all pages. */
|
|
138
|
+
totalCount: number;
|
|
139
|
+
/** @description Performance profiles in this page. */
|
|
140
|
+
profiles: {
|
|
141
|
+
/**
|
|
142
|
+
* Format: uuid
|
|
143
|
+
* @description Unique identifier for the performance profile.
|
|
144
|
+
*/
|
|
145
|
+
id: string;
|
|
146
|
+
/** @description Human-readable name of the performance profile. */
|
|
147
|
+
name: string;
|
|
148
|
+
/**
|
|
149
|
+
* Format: uuid
|
|
150
|
+
* @description User ID of the profile owner.
|
|
151
|
+
*/
|
|
152
|
+
userId: string;
|
|
153
|
+
/**
|
|
154
|
+
* Format: uuid
|
|
155
|
+
* @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
|
|
156
|
+
*/
|
|
157
|
+
schedule?: string | null;
|
|
158
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
159
|
+
loadGenerators?: string[];
|
|
160
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
161
|
+
endpoints?: string[];
|
|
162
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
163
|
+
serviceMesh?: string;
|
|
164
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
165
|
+
concurrentRequest?: number;
|
|
166
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
167
|
+
qps?: number;
|
|
168
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
169
|
+
duration?: string;
|
|
170
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
|
|
171
|
+
requestHeaders?: string;
|
|
172
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
|
|
173
|
+
requestCookies?: string;
|
|
174
|
+
/** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
|
|
175
|
+
requestBody?: string;
|
|
176
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
|
|
177
|
+
contentType?: string;
|
|
178
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
179
|
+
metadata?: {
|
|
180
|
+
[key: string]: unknown;
|
|
181
|
+
};
|
|
182
|
+
/**
|
|
183
|
+
* Format: date-time
|
|
184
|
+
* @description Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
185
|
+
*/
|
|
186
|
+
lastRun?: string | null;
|
|
187
|
+
/** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
|
|
188
|
+
totalResults?: number;
|
|
189
|
+
/**
|
|
190
|
+
* Format: date-time
|
|
191
|
+
* @description Timestamp when the performance profile was created.
|
|
192
|
+
*/
|
|
193
|
+
createdAt: string;
|
|
194
|
+
/**
|
|
195
|
+
* Format: date-time
|
|
196
|
+
* @description Timestamp when the performance profile was last updated.
|
|
197
|
+
*/
|
|
198
|
+
updatedAt: string;
|
|
199
|
+
}[];
|
|
200
|
+
};
|
|
201
|
+
};
|
|
202
|
+
responses: {
|
|
203
|
+
/** ok */
|
|
204
|
+
200: {
|
|
205
|
+
content: {
|
|
206
|
+
"text/plain": string;
|
|
207
|
+
};
|
|
208
|
+
};
|
|
209
|
+
/** Invalid request body or request param */
|
|
210
|
+
400: {
|
|
211
|
+
content: {
|
|
212
|
+
"text/plain": string;
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
/** Expired JWT token used or insufficient privilege */
|
|
216
|
+
401: {
|
|
217
|
+
content: {
|
|
218
|
+
"text/plain": string;
|
|
219
|
+
};
|
|
220
|
+
};
|
|
221
|
+
/** Result not found */
|
|
222
|
+
404: {
|
|
223
|
+
content: {
|
|
224
|
+
"text/plain": string;
|
|
225
|
+
};
|
|
226
|
+
};
|
|
227
|
+
/** Internal server error */
|
|
228
|
+
500: {
|
|
229
|
+
content: {
|
|
230
|
+
"text/plain": string;
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
};
|
|
234
|
+
parameters: {
|
|
235
|
+
/** @description Performance profile ID. */
|
|
236
|
+
performanceProfileId: string;
|
|
237
|
+
/** @description Get responses that match search param value */
|
|
238
|
+
search: string;
|
|
239
|
+
/** @description Get ordered responses */
|
|
240
|
+
order: string;
|
|
241
|
+
/** @description Get responses by page */
|
|
242
|
+
page: string;
|
|
243
|
+
/** @description Get responses by pagesize */
|
|
244
|
+
pagesize: string;
|
|
245
|
+
};
|
|
246
|
+
requestBodies: {
|
|
247
|
+
/** Body for creating or updating a performance profile. */
|
|
248
|
+
performanceProfilePayload: {
|
|
249
|
+
content: {
|
|
250
|
+
"application/json": {
|
|
251
|
+
/**
|
|
252
|
+
* Format: uuid
|
|
253
|
+
* @description Existing performance-profile ID for updates; omit on create.
|
|
254
|
+
*/
|
|
255
|
+
id?: string;
|
|
256
|
+
/** @description Human-readable name of the performance profile. */
|
|
257
|
+
name: string;
|
|
258
|
+
/**
|
|
259
|
+
* Format: uuid
|
|
260
|
+
* @description Owner user ID. When omitted, the server infers it from the authenticated user.
|
|
261
|
+
*/
|
|
262
|
+
userId?: string;
|
|
263
|
+
/**
|
|
264
|
+
* Format: uuid
|
|
265
|
+
* @description Optional schedule ID associating the profile with a recurring run.
|
|
266
|
+
*/
|
|
267
|
+
schedule?: string | null;
|
|
268
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
269
|
+
loadGenerators: string[];
|
|
270
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
271
|
+
endpoints: string[];
|
|
272
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
273
|
+
serviceMesh?: string;
|
|
274
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
275
|
+
concurrentRequest?: number;
|
|
276
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
277
|
+
qps?: number;
|
|
278
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
279
|
+
duration: string;
|
|
280
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
|
|
281
|
+
requestHeaders?: string;
|
|
282
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
|
|
283
|
+
requestCookies?: string;
|
|
284
|
+
/** @description HTTP request body sent on each load-test request. */
|
|
285
|
+
requestBody?: string;
|
|
286
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
|
|
287
|
+
contentType?: string;
|
|
288
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
289
|
+
metadata?: {
|
|
290
|
+
[key: string]: unknown;
|
|
291
|
+
};
|
|
292
|
+
};
|
|
293
|
+
};
|
|
294
|
+
};
|
|
295
|
+
};
|
|
296
|
+
}
|
|
297
|
+
interface operations {
|
|
298
|
+
/** Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering. */
|
|
299
|
+
getPerformanceProfiles: {
|
|
300
|
+
parameters: {
|
|
301
|
+
query: {
|
|
302
|
+
/** Get responses by page */
|
|
303
|
+
page?: string;
|
|
304
|
+
/** Get responses by pagesize */
|
|
305
|
+
pagesize?: string;
|
|
306
|
+
/** Get responses that match search param value */
|
|
307
|
+
search?: string;
|
|
308
|
+
/** Get ordered responses */
|
|
309
|
+
order?: string;
|
|
310
|
+
};
|
|
311
|
+
};
|
|
312
|
+
responses: {
|
|
313
|
+
/** Performance profiles */
|
|
314
|
+
200: {
|
|
315
|
+
content: {
|
|
316
|
+
"application/json": {
|
|
317
|
+
/** @description Zero-based page index returned in this response. */
|
|
318
|
+
page: number;
|
|
319
|
+
/** @description Maximum number of items returned on each page. */
|
|
320
|
+
pageSize: number;
|
|
321
|
+
/** @description Total number of performance profiles across all pages. */
|
|
322
|
+
totalCount: number;
|
|
323
|
+
/** @description Performance profiles in this page. */
|
|
324
|
+
profiles: {
|
|
325
|
+
/**
|
|
326
|
+
* Format: uuid
|
|
327
|
+
* @description Unique identifier for the performance profile.
|
|
328
|
+
*/
|
|
329
|
+
id: string;
|
|
330
|
+
/** @description Human-readable name of the performance profile. */
|
|
331
|
+
name: string;
|
|
332
|
+
/**
|
|
333
|
+
* Format: uuid
|
|
334
|
+
* @description User ID of the profile owner.
|
|
335
|
+
*/
|
|
336
|
+
userId: string;
|
|
337
|
+
/**
|
|
338
|
+
* Format: uuid
|
|
339
|
+
* @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
|
|
340
|
+
*/
|
|
341
|
+
schedule?: string | null;
|
|
342
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
343
|
+
loadGenerators?: string[];
|
|
344
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
345
|
+
endpoints?: string[];
|
|
346
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
347
|
+
serviceMesh?: string;
|
|
348
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
349
|
+
concurrentRequest?: number;
|
|
350
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
351
|
+
qps?: number;
|
|
352
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
353
|
+
duration?: string;
|
|
354
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
|
|
355
|
+
requestHeaders?: string;
|
|
356
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
|
|
357
|
+
requestCookies?: string;
|
|
358
|
+
/** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
|
|
359
|
+
requestBody?: string;
|
|
360
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
|
|
361
|
+
contentType?: string;
|
|
362
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
363
|
+
metadata?: {
|
|
364
|
+
[key: string]: unknown;
|
|
365
|
+
};
|
|
366
|
+
/**
|
|
367
|
+
* Format: date-time
|
|
368
|
+
* @description Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
369
|
+
*/
|
|
370
|
+
lastRun?: string | null;
|
|
371
|
+
/** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
|
|
372
|
+
totalResults?: number;
|
|
373
|
+
/**
|
|
374
|
+
* Format: date-time
|
|
375
|
+
* @description Timestamp when the performance profile was created.
|
|
376
|
+
*/
|
|
377
|
+
createdAt: string;
|
|
378
|
+
/**
|
|
379
|
+
* Format: date-time
|
|
380
|
+
* @description Timestamp when the performance profile was last updated.
|
|
381
|
+
*/
|
|
382
|
+
updatedAt: string;
|
|
383
|
+
}[];
|
|
384
|
+
};
|
|
385
|
+
};
|
|
386
|
+
};
|
|
387
|
+
/** Invalid request body or request param */
|
|
388
|
+
400: {
|
|
389
|
+
content: {
|
|
390
|
+
"text/plain": string;
|
|
391
|
+
};
|
|
392
|
+
};
|
|
393
|
+
/** Expired JWT token used or insufficient privilege */
|
|
394
|
+
401: {
|
|
395
|
+
content: {
|
|
396
|
+
"text/plain": string;
|
|
397
|
+
};
|
|
398
|
+
};
|
|
399
|
+
/** Internal server error */
|
|
400
|
+
500: {
|
|
401
|
+
content: {
|
|
402
|
+
"text/plain": string;
|
|
403
|
+
};
|
|
404
|
+
};
|
|
405
|
+
};
|
|
406
|
+
};
|
|
407
|
+
/** Creates a new performance profile when the body omits id, or updates the matching existing profile when an id is provided. */
|
|
408
|
+
upsertPerformanceProfile: {
|
|
409
|
+
responses: {
|
|
410
|
+
/** Performance profile upserted */
|
|
411
|
+
200: {
|
|
412
|
+
content: {
|
|
413
|
+
"application/json": {
|
|
414
|
+
/**
|
|
415
|
+
* Format: uuid
|
|
416
|
+
* @description Unique identifier for the performance profile.
|
|
417
|
+
*/
|
|
418
|
+
id: string;
|
|
419
|
+
/** @description Human-readable name of the performance profile. */
|
|
420
|
+
name: string;
|
|
421
|
+
/**
|
|
422
|
+
* Format: uuid
|
|
423
|
+
* @description User ID of the profile owner.
|
|
424
|
+
*/
|
|
425
|
+
userId: string;
|
|
426
|
+
/**
|
|
427
|
+
* Format: uuid
|
|
428
|
+
* @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
|
|
429
|
+
*/
|
|
430
|
+
schedule?: string | null;
|
|
431
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
432
|
+
loadGenerators?: string[];
|
|
433
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
434
|
+
endpoints?: string[];
|
|
435
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
436
|
+
serviceMesh?: string;
|
|
437
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
438
|
+
concurrentRequest?: number;
|
|
439
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
440
|
+
qps?: number;
|
|
441
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
442
|
+
duration?: string;
|
|
443
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
|
|
444
|
+
requestHeaders?: string;
|
|
445
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
|
|
446
|
+
requestCookies?: string;
|
|
447
|
+
/** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
|
|
448
|
+
requestBody?: string;
|
|
449
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
|
|
450
|
+
contentType?: string;
|
|
451
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
452
|
+
metadata?: {
|
|
453
|
+
[key: string]: unknown;
|
|
454
|
+
};
|
|
455
|
+
/**
|
|
456
|
+
* Format: date-time
|
|
457
|
+
* @description Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
458
|
+
*/
|
|
459
|
+
lastRun?: string | null;
|
|
460
|
+
/** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
|
|
461
|
+
totalResults?: number;
|
|
462
|
+
/**
|
|
463
|
+
* Format: date-time
|
|
464
|
+
* @description Timestamp when the performance profile was created.
|
|
465
|
+
*/
|
|
466
|
+
createdAt: string;
|
|
467
|
+
/**
|
|
468
|
+
* Format: date-time
|
|
469
|
+
* @description Timestamp when the performance profile was last updated.
|
|
470
|
+
*/
|
|
471
|
+
updatedAt: string;
|
|
472
|
+
};
|
|
473
|
+
};
|
|
474
|
+
};
|
|
475
|
+
/** Invalid request body or request param */
|
|
476
|
+
400: {
|
|
477
|
+
content: {
|
|
478
|
+
"text/plain": string;
|
|
479
|
+
};
|
|
480
|
+
};
|
|
481
|
+
/** Expired JWT token used or insufficient privilege */
|
|
482
|
+
401: {
|
|
483
|
+
content: {
|
|
484
|
+
"text/plain": string;
|
|
485
|
+
};
|
|
486
|
+
};
|
|
487
|
+
/** Internal server error */
|
|
488
|
+
500: {
|
|
489
|
+
content: {
|
|
490
|
+
"text/plain": string;
|
|
491
|
+
};
|
|
492
|
+
};
|
|
493
|
+
};
|
|
494
|
+
/** Body for creating or updating a performance profile. */
|
|
495
|
+
requestBody: {
|
|
496
|
+
content: {
|
|
497
|
+
"application/json": {
|
|
498
|
+
/**
|
|
499
|
+
* Format: uuid
|
|
500
|
+
* @description Existing performance-profile ID for updates; omit on create.
|
|
501
|
+
*/
|
|
502
|
+
id?: string;
|
|
503
|
+
/** @description Human-readable name of the performance profile. */
|
|
504
|
+
name: string;
|
|
505
|
+
/**
|
|
506
|
+
* Format: uuid
|
|
507
|
+
* @description Owner user ID. When omitted, the server infers it from the authenticated user.
|
|
508
|
+
*/
|
|
509
|
+
userId?: string;
|
|
510
|
+
/**
|
|
511
|
+
* Format: uuid
|
|
512
|
+
* @description Optional schedule ID associating the profile with a recurring run.
|
|
513
|
+
*/
|
|
514
|
+
schedule?: string | null;
|
|
515
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
516
|
+
loadGenerators: string[];
|
|
517
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
518
|
+
endpoints: string[];
|
|
519
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
520
|
+
serviceMesh?: string;
|
|
521
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
522
|
+
concurrentRequest?: number;
|
|
523
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
524
|
+
qps?: number;
|
|
525
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
526
|
+
duration: string;
|
|
527
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
|
|
528
|
+
requestHeaders?: string;
|
|
529
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
|
|
530
|
+
requestCookies?: string;
|
|
531
|
+
/** @description HTTP request body sent on each load-test request. */
|
|
532
|
+
requestBody?: string;
|
|
533
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
|
|
534
|
+
contentType?: string;
|
|
535
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
536
|
+
metadata?: {
|
|
537
|
+
[key: string]: unknown;
|
|
538
|
+
};
|
|
539
|
+
};
|
|
540
|
+
};
|
|
541
|
+
};
|
|
542
|
+
};
|
|
543
|
+
/** Returns a single performance profile owned by (or visible to) the authenticated user. */
|
|
544
|
+
getPerformanceProfile: {
|
|
545
|
+
parameters: {
|
|
546
|
+
path: {
|
|
547
|
+
/** Performance profile ID. */
|
|
548
|
+
performanceProfileId: string;
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
responses: {
|
|
552
|
+
/** Performance profile */
|
|
553
|
+
200: {
|
|
554
|
+
content: {
|
|
555
|
+
"application/json": {
|
|
556
|
+
/**
|
|
557
|
+
* Format: uuid
|
|
558
|
+
* @description Unique identifier for the performance profile.
|
|
559
|
+
*/
|
|
560
|
+
id: string;
|
|
561
|
+
/** @description Human-readable name of the performance profile. */
|
|
562
|
+
name: string;
|
|
563
|
+
/**
|
|
564
|
+
* Format: uuid
|
|
565
|
+
* @description User ID of the profile owner.
|
|
566
|
+
*/
|
|
567
|
+
userId: string;
|
|
568
|
+
/**
|
|
569
|
+
* Format: uuid
|
|
570
|
+
* @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
|
|
571
|
+
*/
|
|
572
|
+
schedule?: string | null;
|
|
573
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
574
|
+
loadGenerators?: string[];
|
|
575
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
576
|
+
endpoints?: string[];
|
|
577
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
578
|
+
serviceMesh?: string;
|
|
579
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
580
|
+
concurrentRequest?: number;
|
|
581
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
582
|
+
qps?: number;
|
|
583
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
584
|
+
duration?: string;
|
|
585
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
|
|
586
|
+
requestHeaders?: string;
|
|
587
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
|
|
588
|
+
requestCookies?: string;
|
|
589
|
+
/** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
|
|
590
|
+
requestBody?: string;
|
|
591
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
|
|
592
|
+
contentType?: string;
|
|
593
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
594
|
+
metadata?: {
|
|
595
|
+
[key: string]: unknown;
|
|
596
|
+
};
|
|
597
|
+
/**
|
|
598
|
+
* Format: date-time
|
|
599
|
+
* @description Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
600
|
+
*/
|
|
601
|
+
lastRun?: string | null;
|
|
602
|
+
/** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
|
|
603
|
+
totalResults?: number;
|
|
604
|
+
/**
|
|
605
|
+
* Format: date-time
|
|
606
|
+
* @description Timestamp when the performance profile was created.
|
|
607
|
+
*/
|
|
608
|
+
createdAt: string;
|
|
609
|
+
/**
|
|
610
|
+
* Format: date-time
|
|
611
|
+
* @description Timestamp when the performance profile was last updated.
|
|
612
|
+
*/
|
|
613
|
+
updatedAt: string;
|
|
614
|
+
};
|
|
615
|
+
};
|
|
616
|
+
};
|
|
617
|
+
/** Invalid request body or request param */
|
|
618
|
+
400: {
|
|
619
|
+
content: {
|
|
620
|
+
"text/plain": string;
|
|
621
|
+
};
|
|
622
|
+
};
|
|
623
|
+
/** Expired JWT token used or insufficient privilege */
|
|
624
|
+
401: {
|
|
625
|
+
content: {
|
|
626
|
+
"text/plain": string;
|
|
627
|
+
};
|
|
628
|
+
};
|
|
629
|
+
/** Result not found */
|
|
630
|
+
404: {
|
|
631
|
+
content: {
|
|
632
|
+
"text/plain": string;
|
|
633
|
+
};
|
|
634
|
+
};
|
|
635
|
+
/** Internal server error */
|
|
636
|
+
500: {
|
|
637
|
+
content: {
|
|
638
|
+
"text/plain": string;
|
|
639
|
+
};
|
|
640
|
+
};
|
|
641
|
+
};
|
|
642
|
+
};
|
|
643
|
+
/** Updates the performance profile identified by the path parameter. */
|
|
644
|
+
updatePerformanceProfile: {
|
|
645
|
+
parameters: {
|
|
646
|
+
path: {
|
|
647
|
+
/** Performance profile ID. */
|
|
648
|
+
performanceProfileId: string;
|
|
649
|
+
};
|
|
650
|
+
};
|
|
651
|
+
responses: {
|
|
652
|
+
/** Performance profile */
|
|
653
|
+
200: {
|
|
654
|
+
content: {
|
|
655
|
+
"application/json": {
|
|
656
|
+
/**
|
|
657
|
+
* Format: uuid
|
|
658
|
+
* @description Unique identifier for the performance profile.
|
|
659
|
+
*/
|
|
660
|
+
id: string;
|
|
661
|
+
/** @description Human-readable name of the performance profile. */
|
|
662
|
+
name: string;
|
|
663
|
+
/**
|
|
664
|
+
* Format: uuid
|
|
665
|
+
* @description User ID of the profile owner.
|
|
666
|
+
*/
|
|
667
|
+
userId: string;
|
|
668
|
+
/**
|
|
669
|
+
* Format: uuid
|
|
670
|
+
* @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
|
|
671
|
+
*/
|
|
672
|
+
schedule?: string | null;
|
|
673
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
674
|
+
loadGenerators?: string[];
|
|
675
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
676
|
+
endpoints?: string[];
|
|
677
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
678
|
+
serviceMesh?: string;
|
|
679
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
680
|
+
concurrentRequest?: number;
|
|
681
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
682
|
+
qps?: number;
|
|
683
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
684
|
+
duration?: string;
|
|
685
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
|
|
686
|
+
requestHeaders?: string;
|
|
687
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
|
|
688
|
+
requestCookies?: string;
|
|
689
|
+
/** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
|
|
690
|
+
requestBody?: string;
|
|
691
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
|
|
692
|
+
contentType?: string;
|
|
693
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
694
|
+
metadata?: {
|
|
695
|
+
[key: string]: unknown;
|
|
696
|
+
};
|
|
697
|
+
/**
|
|
698
|
+
* Format: date-time
|
|
699
|
+
* @description Server-computed timestamp of the most recent load-test run that used this profile. Null until the first run completes. Server-managed; clients must not set this on create/update.
|
|
700
|
+
*/
|
|
701
|
+
lastRun?: string | null;
|
|
702
|
+
/** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
|
|
703
|
+
totalResults?: number;
|
|
704
|
+
/**
|
|
705
|
+
* Format: date-time
|
|
706
|
+
* @description Timestamp when the performance profile was created.
|
|
707
|
+
*/
|
|
708
|
+
createdAt: string;
|
|
709
|
+
/**
|
|
710
|
+
* Format: date-time
|
|
711
|
+
* @description Timestamp when the performance profile was last updated.
|
|
712
|
+
*/
|
|
713
|
+
updatedAt: string;
|
|
714
|
+
};
|
|
715
|
+
};
|
|
716
|
+
};
|
|
717
|
+
/** Invalid request body or request param */
|
|
718
|
+
400: {
|
|
719
|
+
content: {
|
|
720
|
+
"text/plain": string;
|
|
721
|
+
};
|
|
722
|
+
};
|
|
723
|
+
/** Expired JWT token used or insufficient privilege */
|
|
724
|
+
401: {
|
|
725
|
+
content: {
|
|
726
|
+
"text/plain": string;
|
|
727
|
+
};
|
|
728
|
+
};
|
|
729
|
+
/** Result not found */
|
|
730
|
+
404: {
|
|
731
|
+
content: {
|
|
732
|
+
"text/plain": string;
|
|
733
|
+
};
|
|
734
|
+
};
|
|
735
|
+
/** Internal server error */
|
|
736
|
+
500: {
|
|
737
|
+
content: {
|
|
738
|
+
"text/plain": string;
|
|
739
|
+
};
|
|
740
|
+
};
|
|
741
|
+
};
|
|
742
|
+
/** Body for creating or updating a performance profile. */
|
|
743
|
+
requestBody: {
|
|
744
|
+
content: {
|
|
745
|
+
"application/json": {
|
|
746
|
+
/**
|
|
747
|
+
* Format: uuid
|
|
748
|
+
* @description Existing performance-profile ID for updates; omit on create.
|
|
749
|
+
*/
|
|
750
|
+
id?: string;
|
|
751
|
+
/** @description Human-readable name of the performance profile. */
|
|
752
|
+
name: string;
|
|
753
|
+
/**
|
|
754
|
+
* Format: uuid
|
|
755
|
+
* @description Owner user ID. When omitted, the server infers it from the authenticated user.
|
|
756
|
+
*/
|
|
757
|
+
userId?: string;
|
|
758
|
+
/**
|
|
759
|
+
* Format: uuid
|
|
760
|
+
* @description Optional schedule ID associating the profile with a recurring run.
|
|
761
|
+
*/
|
|
762
|
+
schedule?: string | null;
|
|
763
|
+
/** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
|
|
764
|
+
loadGenerators: string[];
|
|
765
|
+
/** @description Endpoints (URLs) targeted by the performance profile's load test. */
|
|
766
|
+
endpoints: string[];
|
|
767
|
+
/** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
|
|
768
|
+
serviceMesh?: string;
|
|
769
|
+
/** @description Number of concurrent requests issued by the load generator. */
|
|
770
|
+
concurrentRequest?: number;
|
|
771
|
+
/** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
|
|
772
|
+
qps?: number;
|
|
773
|
+
/** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
|
|
774
|
+
duration: string;
|
|
775
|
+
/** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
|
|
776
|
+
requestHeaders?: string;
|
|
777
|
+
/** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
|
|
778
|
+
requestCookies?: string;
|
|
779
|
+
/** @description HTTP request body sent on each load-test request. */
|
|
780
|
+
requestBody?: string;
|
|
781
|
+
/** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
|
|
782
|
+
contentType?: string;
|
|
783
|
+
/** @description Free-form metadata associated with the performance profile. */
|
|
784
|
+
metadata?: {
|
|
785
|
+
[key: string]: unknown;
|
|
786
|
+
};
|
|
787
|
+
};
|
|
788
|
+
};
|
|
789
|
+
};
|
|
790
|
+
};
|
|
791
|
+
/** Deletes the performance profile identified by the path parameter and any associated performance results. */
|
|
792
|
+
deletePerformanceProfile: {
|
|
793
|
+
parameters: {
|
|
794
|
+
path: {
|
|
795
|
+
/** Performance profile ID. */
|
|
796
|
+
performanceProfileId: string;
|
|
797
|
+
};
|
|
798
|
+
};
|
|
799
|
+
responses: {
|
|
800
|
+
/** Performance profile deleted */
|
|
801
|
+
204: never;
|
|
802
|
+
/** Invalid request body or request param */
|
|
803
|
+
400: {
|
|
804
|
+
content: {
|
|
805
|
+
"text/plain": string;
|
|
806
|
+
};
|
|
807
|
+
};
|
|
808
|
+
/** Expired JWT token used or insufficient privilege */
|
|
809
|
+
401: {
|
|
810
|
+
content: {
|
|
811
|
+
"text/plain": string;
|
|
812
|
+
};
|
|
813
|
+
};
|
|
814
|
+
/** Result not found */
|
|
815
|
+
404: {
|
|
816
|
+
content: {
|
|
817
|
+
"text/plain": string;
|
|
818
|
+
};
|
|
819
|
+
};
|
|
820
|
+
/** Internal server error */
|
|
821
|
+
500: {
|
|
822
|
+
content: {
|
|
823
|
+
"text/plain": string;
|
|
824
|
+
};
|
|
825
|
+
};
|
|
826
|
+
};
|
|
827
|
+
};
|
|
828
|
+
}
|
|
829
|
+
interface external {
|
|
830
|
+
}
|
|
831
|
+
|
|
832
|
+
export type { components, external, operations, paths };
|