@meshery/schemas 1.2.21 → 1.2.23

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.
Files changed (106) hide show
  1. package/dist/cloudApi.d.mts +1728 -1527
  2. package/dist/cloudApi.d.ts +1728 -1527
  3. package/dist/cloudApi.js +1 -1
  4. package/dist/cloudApi.mjs +1 -1
  5. package/dist/constructs/v1alpha1/capability/Capability.d.ts +111 -106
  6. package/dist/constructs/v1alpha1/core/Core.d.ts +734 -822
  7. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +40 -45
  8. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1716 -1829
  9. package/dist/constructs/v1beta1/academy/Academy.d.ts +6537 -5918
  10. package/dist/constructs/v1beta1/academy/AcademySchema.js +1 -1
  11. package/dist/constructs/v1beta1/academy/AcademySchema.mjs +1 -1
  12. package/dist/constructs/v1beta1/badge/Badge.d.ts +600 -439
  13. package/dist/constructs/v1beta1/capability/Capability.d.ts +111 -106
  14. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +40 -45
  15. package/dist/constructs/v1beta1/category/Category.d.ts +26 -38
  16. package/dist/constructs/v1beta1/component/Component.d.ts +729 -833
  17. package/dist/constructs/v1beta1/connection/Connection.d.ts +1357 -1170
  18. package/dist/constructs/v1beta1/core/Core.d.ts +734 -822
  19. package/dist/constructs/v1beta1/credential/Credential.d.ts +593 -458
  20. package/dist/constructs/v1beta1/environment/Environment.d.ts +835 -666
  21. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +5508 -6030
  22. package/dist/constructs/v1beta1/event/Event.d.ts +898 -527
  23. package/dist/constructs/v1beta1/feature/Feature.d.ts +287 -249
  24. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +1244 -877
  25. package/dist/constructs/v1beta1/key/Key.d.ts +589 -444
  26. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +796 -575
  27. package/dist/constructs/v1beta1/model/Model.d.ts +572 -598
  28. package/dist/constructs/v1beta1/organization/Organization.d.ts +1829 -1410
  29. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17093 -17910
  30. package/dist/constructs/v1beta1/plan/Plan.d.ts +159 -115
  31. package/dist/constructs/v1beta1/role/Role.d.ts +933 -688
  32. package/dist/constructs/v1beta1/role/RoleSchema.js +1 -1
  33. package/dist/constructs/v1beta1/role/RoleSchema.mjs +1 -1
  34. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +425 -315
  35. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +18 -61
  36. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +839 -674
  37. package/dist/constructs/v1beta1/support/Support.d.ts +115 -74
  38. package/dist/constructs/v1beta1/system/System.d.ts +434 -0
  39. package/dist/constructs/v1beta1/system/System.js +1 -0
  40. package/dist/constructs/v1beta1/system/System.mjs +0 -0
  41. package/dist/constructs/v1beta1/system/SystemSchema.d.ts +2 -0
  42. package/dist/constructs/v1beta1/system/SystemSchema.js +2 -0
  43. package/dist/constructs/v1beta1/system/SystemSchema.mjs +2 -0
  44. package/dist/constructs/v1beta1/team/Team.d.ts +1028 -762
  45. package/dist/constructs/v1beta1/token/Token.d.ts +612 -475
  46. package/dist/constructs/v1beta1/user/User.d.ts +1723 -1554
  47. package/dist/constructs/v1beta1/user/UserSchema.js +1 -1
  48. package/dist/constructs/v1beta1/user/UserSchema.mjs +1 -1
  49. package/dist/constructs/v1beta1/view/View.d.ts +833 -664
  50. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4900 -4695
  51. package/dist/constructs/v1beta2/academy/Academy.d.ts +7840 -7222
  52. package/dist/constructs/v1beta2/academy/AcademySchema.js +1 -1
  53. package/dist/constructs/v1beta2/academy/AcademySchema.mjs +1 -1
  54. package/dist/constructs/v1beta2/badge/Badge.d.ts +610 -453
  55. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +40 -45
  56. package/dist/constructs/v1beta2/component/Component.d.ts +747 -851
  57. package/dist/constructs/v1beta2/connection/Connection.d.ts +1376 -1189
  58. package/dist/constructs/v1beta2/core/Core.d.ts +768 -856
  59. package/dist/constructs/v1beta2/credential/Credential.d.ts +572 -437
  60. package/dist/constructs/v1beta2/design/Design.d.ts +17682 -18467
  61. package/dist/constructs/v1beta2/event/Event.d.ts +946 -575
  62. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +1268 -901
  63. package/dist/constructs/v1beta2/key/Key.d.ts +599 -454
  64. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +806 -585
  65. package/dist/constructs/v1beta2/model/Model.d.ts +610 -636
  66. package/dist/constructs/v1beta2/organization/Organization.d.ts +2135 -1724
  67. package/dist/constructs/v1beta2/plan/Plan.d.ts +169 -128
  68. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +1842 -2011
  69. package/dist/constructs/v1beta2/role/Role.d.ts +940 -695
  70. package/dist/constructs/v1beta2/role/RoleSchema.js +1 -1
  71. package/dist/constructs/v1beta2/role/RoleSchema.mjs +1 -1
  72. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +466 -356
  73. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +866 -701
  74. package/dist/constructs/v1beta2/team/Team.d.ts +1118 -852
  75. package/dist/constructs/v1beta2/token/Token.d.ts +616 -479
  76. package/dist/constructs/v1beta2/user/User.d.ts +1723 -1554
  77. package/dist/constructs/v1beta2/user/UserSchema.js +1 -1
  78. package/dist/constructs/v1beta2/user/UserSchema.mjs +1 -1
  79. package/dist/constructs/v1beta2/view/View.d.ts +838 -669
  80. package/dist/constructs/v1beta3/academy/Academy.d.ts +7844 -7226
  81. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  82. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  83. package/dist/constructs/v1beta3/component/Component.d.ts +753 -857
  84. package/dist/constructs/v1beta3/connection/Connection.d.ts +1447 -1260
  85. package/dist/constructs/v1beta3/design/Design.d.ts +5729 -5307
  86. package/dist/constructs/v1beta3/design/DesignSchema.js +8 -8
  87. package/dist/constructs/v1beta3/design/DesignSchema.mjs +8 -8
  88. package/dist/constructs/v1beta3/environment/Environment.d.ts +858 -689
  89. package/dist/constructs/v1beta3/event/Event.d.ts +1041 -666
  90. package/dist/constructs/v1beta3/filter/Filter.d.ts +1437 -1299
  91. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +1277 -910
  92. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +850 -690
  93. package/dist/constructs/v1beta3/plan/Plan.d.ts +197 -156
  94. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +1842 -2011
  95. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +969 -804
  96. package/dist/constructs/v1beta3/token/Token.d.ts +616 -479
  97. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +5030 -4822
  98. package/dist/index.d.mts +5520 -5062
  99. package/dist/index.d.ts +5520 -5062
  100. package/dist/mesheryApi.d.mts +1318 -526
  101. package/dist/mesheryApi.d.ts +1318 -526
  102. package/dist/mesheryApi.js +1 -1
  103. package/dist/mesheryApi.mjs +1 -1
  104. package/dist/permissions.d.mts +1 -1
  105. package/dist/permissions.d.ts +1 -1
  106. package/package.json +1 -2
@@ -4,406 +4,67 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/performance-profiles": {
8
- /** Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering. */
9
- get: operations["getPerformanceProfiles"];
10
- /** Creates a new performance profile when the body omits id, or updates the matching existing profile when an id is provided. */
11
- post: operations["upsertPerformanceProfile"];
12
- };
13
- "/api/performance-profiles/{performanceProfileId}": {
14
- /** Returns a single performance profile owned by (or visible to) the authenticated user. */
15
- get: operations["getPerformanceProfile"];
16
- /** Updates the performance profile identified by the path parameter. */
17
- put: operations["updatePerformanceProfile"];
18
- /** Deletes the performance profile identified by the path parameter and any associated performance results. */
19
- delete: operations["deletePerformanceProfile"];
20
- };
21
- }
22
-
23
- export interface components {
24
- schemas: {
25
- /**
26
- * PerformanceProfile
27
- * @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
28
- */
29
- PerformanceProfile: {
30
- /**
31
- * Format: uuid
32
- * @description Unique identifier for the performance profile.
33
- */
34
- id: string;
35
- /** @description Human-readable name of the performance profile. */
36
- name: string;
37
- /**
38
- * Format: uuid
39
- * @description User ID of the profile owner.
40
- */
41
- userId: string;
42
- /**
43
- * Format: uuid
44
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
45
- */
46
- schedule?: string | null;
47
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
48
- loadGenerators?: string[];
49
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
50
- endpoints?: string[];
51
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
52
- serviceMesh?: string;
53
- /** @description Number of concurrent requests issued by the load generator. */
54
- concurrentRequest?: number;
55
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
56
- qps?: number;
57
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
58
- duration?: string;
59
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
60
- requestHeaders?: string;
61
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
62
- requestCookies?: string;
63
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
64
- requestBody?: string;
65
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
66
- contentType?: string;
67
- /** @description Free-form metadata associated with the performance profile. */
68
- metadata?: { [key: string]: unknown };
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?: { [key: string]: unknown };
128
- };
129
- /** @description Paginated list of performance profiles. */
130
- PerformanceProfilePage: {
131
- /** @description Zero-based page index returned in this response. */
132
- page: number;
133
- /** @description Maximum number of items returned on each page. */
134
- pageSize: number;
135
- /** @description Total number of performance profiles across all pages. */
136
- totalCount: number;
137
- /** @description Performance profiles in this page. */
138
- profiles: {
139
- /**
140
- * Format: uuid
141
- * @description Unique identifier for the performance profile.
142
- */
143
- id: string;
144
- /** @description Human-readable name of the performance profile. */
145
- name: string;
7
+ "/api/performance-profiles": {
8
+ parameters: {
9
+ query?: never;
10
+ header?: never;
11
+ path?: never;
12
+ cookie?: never;
13
+ };
146
14
  /**
147
- * Format: uuid
148
- * @description User ID of the profile owner.
15
+ * List performance profiles
16
+ * @description Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering.
149
17
  */
150
- userId: string;
18
+ get: operations["getPerformanceProfiles"];
19
+ put?: never;
151
20
  /**
152
- * Format: uuid
153
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
21
+ * Create or update a performance profile
22
+ * @description Creates a new performance profile when the body omits id, or updates the matching existing profile when an id is provided.
154
23
  */
155
- schedule?: string | null;
156
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
157
- loadGenerators?: string[];
158
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
159
- endpoints?: string[];
160
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
161
- serviceMesh?: string;
162
- /** @description Number of concurrent requests issued by the load generator. */
163
- concurrentRequest?: number;
164
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
165
- qps?: number;
166
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
167
- duration?: string;
168
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
169
- requestHeaders?: string;
170
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
171
- requestCookies?: string;
172
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
173
- requestBody?: string;
174
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
175
- contentType?: string;
176
- /** @description Free-form metadata associated with the performance profile. */
177
- metadata?: { [key: string]: unknown };
24
+ post: operations["upsertPerformanceProfile"];
25
+ delete?: never;
26
+ options?: never;
27
+ head?: never;
28
+ patch?: never;
29
+ trace?: never;
30
+ };
31
+ "/api/performance-profiles/{performanceProfileId}": {
32
+ parameters: {
33
+ query?: never;
34
+ header?: never;
35
+ path?: never;
36
+ cookie?: never;
37
+ };
178
38
  /**
179
- * Format: date-time
180
- * @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.
39
+ * Get a performance profile by ID
40
+ * @description Returns a single performance profile owned by (or visible to) the authenticated user.
181
41
  */
182
- lastRun?: string | null;
183
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
184
- totalResults?: number;
42
+ get: operations["getPerformanceProfile"];
185
43
  /**
186
- * Format: date-time
187
- * @description Timestamp when the performance profile was created.
44
+ * Update a performance profile
45
+ * @description Updates the performance profile identified by the path parameter.
188
46
  */
189
- createdAt: string;
47
+ put: operations["updatePerformanceProfile"];
48
+ post?: never;
190
49
  /**
191
- * Format: date-time
192
- * @description Timestamp when the performance profile was last updated.
50
+ * Delete a performance profile
51
+ * @description Deletes the performance profile identified by the path parameter and any associated performance results.
193
52
  */
194
- updatedAt: string;
195
- }[];
196
- };
197
- };
198
- responses: {
199
- /** ok */
200
- 200: {
201
- content: {
202
- "text/plain": string;
203
- };
53
+ delete: operations["deletePerformanceProfile"];
54
+ options?: never;
55
+ head?: never;
56
+ patch?: never;
57
+ trace?: never;
204
58
  };
205
- /** Invalid request body or request param */
206
- 400: {
207
- content: {
208
- "text/plain": string;
209
- };
210
- };
211
- /** Expired JWT token used or insufficient privilege */
212
- 401: {
213
- content: {
214
- "text/plain": string;
215
- };
216
- };
217
- /** Result not found */
218
- 404: {
219
- content: {
220
- "text/plain": string;
221
- };
222
- };
223
- /** Internal server error */
224
- 500: {
225
- content: {
226
- "text/plain": string;
227
- };
228
- };
229
- };
230
- parameters: {
231
- /** @description Performance profile ID. */
232
- performanceProfileId: string;
233
- /** @description Get responses that match search param value */
234
- search: string;
235
- /** @description Get ordered responses */
236
- order: string;
237
- /** @description Get responses by page */
238
- page: string;
239
- /** @description Get responses by pagesize */
240
- pagesize: string;
241
- };
242
- requestBodies: {
243
- /** Body for creating or updating a performance profile. */
244
- performanceProfilePayload: {
245
- content: {
246
- "application/json": {
247
- /**
248
- * Format: uuid
249
- * @description Existing performance-profile ID for updates; omit on create.
250
- */
251
- id?: string;
252
- /** @description Human-readable name of the performance profile. */
253
- name: string;
254
- /**
255
- * Format: uuid
256
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
257
- */
258
- userId?: string;
259
- /**
260
- * Format: uuid
261
- * @description Optional schedule ID associating the profile with a recurring run.
262
- */
263
- schedule?: string | null;
264
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
265
- loadGenerators: string[];
266
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
267
- endpoints: string[];
268
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
269
- serviceMesh?: string;
270
- /** @description Number of concurrent requests issued by the load generator. */
271
- concurrentRequest?: number;
272
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
273
- qps?: number;
274
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
275
- duration: string;
276
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
277
- requestHeaders?: string;
278
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
279
- requestCookies?: string;
280
- /** @description HTTP request body sent on each load-test request. */
281
- requestBody?: string;
282
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
283
- contentType?: string;
284
- /** @description Free-form metadata associated with the performance profile. */
285
- metadata?: { [key: string]: unknown };
286
- };
287
- };
288
- };
289
- };
290
59
  }
291
-
292
- export interface operations {
293
- /** Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering. */
294
- getPerformanceProfiles: {
295
- parameters: {
296
- query: {
297
- /** Get responses by page */
298
- page?: string;
299
- /** Get responses by pagesize */
300
- pagesize?: string;
301
- /** Get responses that match search param value */
302
- search?: string;
303
- /** Get ordered responses */
304
- order?: string;
305
- };
306
- };
307
- responses: {
308
- /** Performance profiles */
309
- 200: {
310
- content: {
311
- "application/json": {
312
- /** @description Zero-based page index returned in this response. */
313
- page: number;
314
- /** @description Maximum number of items returned on each page. */
315
- pageSize: number;
316
- /** @description Total number of performance profiles across all pages. */
317
- totalCount: number;
318
- /** @description Performance profiles in this page. */
319
- profiles: {
320
- /**
321
- * Format: uuid
322
- * @description Unique identifier for the performance profile.
323
- */
324
- id: string;
325
- /** @description Human-readable name of the performance profile. */
326
- name: string;
327
- /**
328
- * Format: uuid
329
- * @description User ID of the profile owner.
330
- */
331
- userId: string;
332
- /**
333
- * Format: uuid
334
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
335
- */
336
- schedule?: string | null;
337
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
338
- loadGenerators?: string[];
339
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
340
- endpoints?: string[];
341
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
342
- serviceMesh?: string;
343
- /** @description Number of concurrent requests issued by the load generator. */
344
- concurrentRequest?: number;
345
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
346
- qps?: number;
347
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
348
- duration?: string;
349
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
350
- requestHeaders?: string;
351
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
352
- requestCookies?: string;
353
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
354
- requestBody?: string;
355
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
356
- contentType?: string;
357
- /** @description Free-form metadata associated with the performance profile. */
358
- metadata?: { [key: string]: unknown };
359
- /**
360
- * Format: date-time
361
- * @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.
362
- */
363
- lastRun?: string | null;
364
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
365
- totalResults?: number;
366
- /**
367
- * Format: date-time
368
- * @description Timestamp when the performance profile was created.
369
- */
370
- createdAt: string;
371
- /**
372
- * Format: date-time
373
- * @description Timestamp when the performance profile was last updated.
374
- */
375
- updatedAt: string;
376
- }[];
377
- };
378
- };
379
- };
380
- /** Invalid request body or request param */
381
- 400: {
382
- content: {
383
- "text/plain": string;
384
- };
385
- };
386
- /** Expired JWT token used or insufficient privilege */
387
- 401: {
388
- content: {
389
- "text/plain": string;
390
- };
391
- };
392
- /** Internal server error */
393
- 500: {
394
- content: {
395
- "text/plain": string;
396
- };
397
- };
398
- };
399
- };
400
- /** Creates a new performance profile when the body omits id, or updates the matching existing profile when an id is provided. */
401
- upsertPerformanceProfile: {
402
- responses: {
403
- /** Performance profile upserted */
404
- 200: {
405
- content: {
406
- "application/json": {
60
+ export type webhooks = Record<string, never>;
61
+ export interface components {
62
+ schemas: {
63
+ /**
64
+ * PerformanceProfile
65
+ * @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
66
+ */
67
+ PerformanceProfile: {
407
68
  /**
408
69
  * Format: uuid
409
70
  * @description Unique identifier for the performance profile.
@@ -442,7 +103,9 @@ export interface operations {
442
103
  /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
443
104
  contentType?: string;
444
105
  /** @description Free-form metadata associated with the performance profile. */
445
- metadata?: { [key: string]: unknown };
106
+ metadata?: {
107
+ [key: string]: unknown;
108
+ };
446
109
  /**
447
110
  * Format: date-time
448
111
  * @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.
@@ -460,109 +123,30 @@ export interface operations {
460
123
  * @description Timestamp when the performance profile was last updated.
461
124
  */
462
125
  updatedAt: string;
463
- };
464
- };
465
- };
466
- /** Invalid request body or request param */
467
- 400: {
468
- content: {
469
- "text/plain": string;
470
126
  };
471
- };
472
- /** Expired JWT token used or insufficient privilege */
473
- 401: {
474
- content: {
475
- "text/plain": string;
476
- };
477
- };
478
- /** Internal server error */
479
- 500: {
480
- content: {
481
- "text/plain": string;
482
- };
483
- };
484
- };
485
- /** Body for creating or updating a performance profile. */
486
- requestBody: {
487
- content: {
488
- "application/json": {
489
- /**
490
- * Format: uuid
491
- * @description Existing performance-profile ID for updates; omit on create.
492
- */
493
- id?: string;
494
- /** @description Human-readable name of the performance profile. */
495
- name: string;
496
- /**
497
- * Format: uuid
498
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
499
- */
500
- userId?: string;
501
- /**
502
- * Format: uuid
503
- * @description Optional schedule ID associating the profile with a recurring run.
504
- */
505
- schedule?: string | null;
506
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
507
- loadGenerators: string[];
508
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
509
- endpoints: string[];
510
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
511
- serviceMesh?: string;
512
- /** @description Number of concurrent requests issued by the load generator. */
513
- concurrentRequest?: number;
514
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
515
- qps?: number;
516
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
517
- duration: string;
518
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
519
- requestHeaders?: string;
520
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
521
- requestCookies?: string;
522
- /** @description HTTP request body sent on each load-test request. */
523
- requestBody?: string;
524
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
525
- contentType?: string;
526
- /** @description Free-form metadata associated with the performance profile. */
527
- metadata?: { [key: string]: unknown };
528
- };
529
- };
530
- };
531
- };
532
- /** Returns a single performance profile owned by (or visible to) the authenticated user. */
533
- getPerformanceProfile: {
534
- parameters: {
535
- path: {
536
- /** Performance profile ID. */
537
- performanceProfileId: string;
538
- };
539
- };
540
- responses: {
541
- /** Performance profile */
542
- 200: {
543
- content: {
544
- "application/json": {
127
+ /** @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. */
128
+ PerformanceProfilePayload: {
545
129
  /**
546
130
  * Format: uuid
547
- * @description Unique identifier for the performance profile.
131
+ * @description Existing performance-profile ID for updates; omit on create.
548
132
  */
549
- id: string;
133
+ id?: string;
550
134
  /** @description Human-readable name of the performance profile. */
551
135
  name: string;
552
136
  /**
553
137
  * Format: uuid
554
- * @description User ID of the profile owner.
138
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
555
139
  */
556
- userId: string;
140
+ userId?: string;
557
141
  /**
558
142
  * Format: uuid
559
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
143
+ * @description Optional schedule ID associating the profile with a recurring run.
560
144
  */
561
145
  schedule?: string | null;
562
146
  /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
563
- loadGenerators?: string[];
147
+ loadGenerators: string[];
564
148
  /** @description Endpoints (URLs) targeted by the performance profile's load test. */
565
- endpoints?: string[];
149
+ endpoints: string[];
566
150
  /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
567
151
  serviceMesh?: string;
568
152
  /** @description Number of concurrent requests issued by the load generator. */
@@ -570,244 +154,820 @@ export interface operations {
570
154
  /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
571
155
  qps?: number;
572
156
  /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
573
- duration?: string;
574
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
157
+ duration: string;
158
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
575
159
  requestHeaders?: string;
576
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
160
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
577
161
  requestCookies?: string;
578
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
162
+ /** @description HTTP request body sent on each load-test request. */
579
163
  requestBody?: string;
580
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
164
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
581
165
  contentType?: string;
582
166
  /** @description Free-form metadata associated with the performance profile. */
583
- metadata?: { [key: string]: unknown };
584
- /**
585
- * Format: date-time
586
- * @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.
587
- */
588
- lastRun?: string | null;
589
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
590
- totalResults?: number;
591
- /**
592
- * Format: date-time
593
- * @description Timestamp when the performance profile was created.
594
- */
595
- createdAt: string;
596
- /**
597
- * Format: date-time
598
- * @description Timestamp when the performance profile was last updated.
599
- */
600
- updatedAt: string;
601
- };
167
+ metadata?: {
168
+ [key: string]: unknown;
169
+ };
602
170
  };
603
- };
604
- /** Invalid request body or request param */
605
- 400: {
606
- content: {
607
- "text/plain": string;
171
+ /** @description Paginated list of performance profiles. */
172
+ PerformanceProfilePage: {
173
+ /** @description Zero-based page index returned in this response. */
174
+ page: number;
175
+ /** @description Maximum number of items returned on each page. */
176
+ pageSize: number;
177
+ /** @description Total number of performance profiles across all pages. */
178
+ totalCount: number;
179
+ /** @description Performance profiles in this page. */
180
+ profiles: {
181
+ /**
182
+ * Format: uuid
183
+ * @description Unique identifier for the performance profile.
184
+ */
185
+ id: string;
186
+ /** @description Human-readable name of the performance profile. */
187
+ name: string;
188
+ /**
189
+ * Format: uuid
190
+ * @description User ID of the profile owner.
191
+ */
192
+ userId: string;
193
+ /**
194
+ * Format: uuid
195
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
196
+ */
197
+ schedule?: string | null;
198
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
199
+ loadGenerators?: string[];
200
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
201
+ endpoints?: string[];
202
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
203
+ serviceMesh?: string;
204
+ /** @description Number of concurrent requests issued by the load generator. */
205
+ concurrentRequest?: number;
206
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
207
+ qps?: number;
208
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
209
+ duration?: string;
210
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
211
+ requestHeaders?: string;
212
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
213
+ requestCookies?: string;
214
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
215
+ requestBody?: string;
216
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
217
+ contentType?: string;
218
+ /** @description Free-form metadata associated with the performance profile. */
219
+ metadata?: {
220
+ [key: string]: unknown;
221
+ };
222
+ /**
223
+ * Format: date-time
224
+ * @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.
225
+ */
226
+ lastRun?: string | null;
227
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
228
+ totalResults?: number;
229
+ /**
230
+ * Format: date-time
231
+ * @description Timestamp when the performance profile was created.
232
+ */
233
+ createdAt: string;
234
+ /**
235
+ * Format: date-time
236
+ * @description Timestamp when the performance profile was last updated.
237
+ */
238
+ updatedAt: string;
239
+ }[];
240
+ };
241
+ };
242
+ responses: {
243
+ /** @description ok */
244
+ 200: {
245
+ headers: {
246
+ [name: string]: unknown;
247
+ };
248
+ content: {
249
+ "text/plain": string;
250
+ };
608
251
  };
609
- };
610
- /** Expired JWT token used or insufficient privilege */
611
- 401: {
612
- content: {
613
- "text/plain": string;
252
+ /** @description Invalid request body or request param */
253
+ 400: {
254
+ headers: {
255
+ [name: string]: unknown;
256
+ };
257
+ content: {
258
+ "text/plain": string;
259
+ };
614
260
  };
615
- };
616
- /** Result not found */
617
- 404: {
618
- content: {
619
- "text/plain": string;
261
+ /** @description Expired JWT token used or insufficient privilege */
262
+ 401: {
263
+ headers: {
264
+ [name: string]: unknown;
265
+ };
266
+ content: {
267
+ "text/plain": string;
268
+ };
620
269
  };
621
- };
622
- /** Internal server error */
623
- 500: {
624
- content: {
625
- "text/plain": string;
270
+ /** @description Result not found */
271
+ 404: {
272
+ headers: {
273
+ [name: string]: unknown;
274
+ };
275
+ content: {
276
+ "text/plain": string;
277
+ };
278
+ };
279
+ /** @description Internal server error */
280
+ 500: {
281
+ headers: {
282
+ [name: string]: unknown;
283
+ };
284
+ content: {
285
+ "text/plain": string;
286
+ };
626
287
  };
627
- };
628
288
  };
629
- };
630
- /** Updates the performance profile identified by the path parameter. */
631
- updatePerformanceProfile: {
632
289
  parameters: {
633
- path: {
634
- /** Performance profile ID. */
290
+ /** @description Performance profile ID. */
635
291
  performanceProfileId: string;
636
- };
292
+ /** @description Get responses that match search param value */
293
+ search: string;
294
+ /** @description Get ordered responses */
295
+ order: string;
296
+ /** @description Get responses by page */
297
+ page: string;
298
+ /** @description Get responses by pagesize */
299
+ pagesize: string;
637
300
  };
638
- responses: {
639
- /** Performance profile */
640
- 200: {
641
- content: {
642
- "application/json": {
643
- /**
644
- * Format: uuid
645
- * @description Unique identifier for the performance profile.
646
- */
647
- id: string;
648
- /** @description Human-readable name of the performance profile. */
649
- name: string;
650
- /**
651
- * Format: uuid
652
- * @description User ID of the profile owner.
653
- */
654
- userId: string;
655
- /**
656
- * Format: uuid
657
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
658
- */
659
- schedule?: string | null;
660
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
661
- loadGenerators?: string[];
662
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
663
- endpoints?: string[];
664
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
665
- serviceMesh?: string;
666
- /** @description Number of concurrent requests issued by the load generator. */
667
- concurrentRequest?: number;
668
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
669
- qps?: number;
670
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
671
- duration?: string;
672
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
673
- requestHeaders?: string;
674
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
675
- requestCookies?: string;
676
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
677
- requestBody?: string;
678
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
679
- contentType?: string;
680
- /** @description Free-form metadata associated with the performance profile. */
681
- metadata?: { [key: string]: unknown };
682
- /**
683
- * Format: date-time
684
- * @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.
685
- */
686
- lastRun?: string | null;
687
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
688
- totalResults?: number;
689
- /**
690
- * Format: date-time
691
- * @description Timestamp when the performance profile was created.
692
- */
693
- createdAt: string;
694
- /**
695
- * Format: date-time
696
- * @description Timestamp when the performance profile was last updated.
697
- */
698
- updatedAt: string;
699
- };
301
+ requestBodies: {
302
+ /** @description Body for creating or updating a performance profile. */
303
+ performanceProfilePayload: {
304
+ content: {
305
+ "application/json": {
306
+ /**
307
+ * Format: uuid
308
+ * @description Existing performance-profile ID for updates; omit on create.
309
+ */
310
+ id?: string;
311
+ /** @description Human-readable name of the performance profile. */
312
+ name: string;
313
+ /**
314
+ * Format: uuid
315
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
316
+ */
317
+ userId?: string;
318
+ /**
319
+ * Format: uuid
320
+ * @description Optional schedule ID associating the profile with a recurring run.
321
+ */
322
+ schedule?: string | null;
323
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
324
+ loadGenerators: string[];
325
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
326
+ endpoints: string[];
327
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
328
+ serviceMesh?: string;
329
+ /** @description Number of concurrent requests issued by the load generator. */
330
+ concurrentRequest?: number;
331
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
332
+ qps?: number;
333
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
334
+ duration: string;
335
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
336
+ requestHeaders?: string;
337
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
338
+ requestCookies?: string;
339
+ /** @description HTTP request body sent on each load-test request. */
340
+ requestBody?: string;
341
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
342
+ contentType?: string;
343
+ /** @description Free-form metadata associated with the performance profile. */
344
+ metadata?: {
345
+ [key: string]: unknown;
346
+ };
347
+ };
348
+ };
349
+ };
350
+ };
351
+ headers: never;
352
+ pathItems: never;
353
+ }
354
+ export type $defs = Record<string, never>;
355
+ export interface operations {
356
+ getPerformanceProfiles: {
357
+ parameters: {
358
+ query?: {
359
+ /** @description Get responses by page */
360
+ page?: string;
361
+ /** @description Get responses by pagesize */
362
+ pagesize?: string;
363
+ /** @description Get responses that match search param value */
364
+ search?: string;
365
+ /** @description Get ordered responses */
366
+ order?: string;
367
+ };
368
+ header?: never;
369
+ path?: never;
370
+ cookie?: never;
700
371
  };
701
- };
702
- /** Invalid request body or request param */
703
- 400: {
704
- content: {
705
- "text/plain": string;
372
+ requestBody?: never;
373
+ responses: {
374
+ /** @description Performance profiles */
375
+ 200: {
376
+ headers: {
377
+ [name: string]: unknown;
378
+ };
379
+ content: {
380
+ "application/json": {
381
+ /** @description Zero-based page index returned in this response. */
382
+ page: number;
383
+ /** @description Maximum number of items returned on each page. */
384
+ pageSize: number;
385
+ /** @description Total number of performance profiles across all pages. */
386
+ totalCount: number;
387
+ /** @description Performance profiles in this page. */
388
+ profiles: {
389
+ /**
390
+ * Format: uuid
391
+ * @description Unique identifier for the performance profile.
392
+ */
393
+ id: string;
394
+ /** @description Human-readable name of the performance profile. */
395
+ name: string;
396
+ /**
397
+ * Format: uuid
398
+ * @description User ID of the profile owner.
399
+ */
400
+ userId: string;
401
+ /**
402
+ * Format: uuid
403
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
404
+ */
405
+ schedule?: string | null;
406
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
407
+ loadGenerators?: string[];
408
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
409
+ endpoints?: string[];
410
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
411
+ serviceMesh?: string;
412
+ /** @description Number of concurrent requests issued by the load generator. */
413
+ concurrentRequest?: number;
414
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
415
+ qps?: number;
416
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
417
+ duration?: string;
418
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
419
+ requestHeaders?: string;
420
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
421
+ requestCookies?: string;
422
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
423
+ requestBody?: string;
424
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
425
+ contentType?: string;
426
+ /** @description Free-form metadata associated with the performance profile. */
427
+ metadata?: {
428
+ [key: string]: unknown;
429
+ };
430
+ /**
431
+ * Format: date-time
432
+ * @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.
433
+ */
434
+ lastRun?: string | null;
435
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
436
+ totalResults?: number;
437
+ /**
438
+ * Format: date-time
439
+ * @description Timestamp when the performance profile was created.
440
+ */
441
+ createdAt: string;
442
+ /**
443
+ * Format: date-time
444
+ * @description Timestamp when the performance profile was last updated.
445
+ */
446
+ updatedAt: string;
447
+ }[];
448
+ };
449
+ };
450
+ };
451
+ /** @description Invalid request body or request param */
452
+ 400: {
453
+ headers: {
454
+ [name: string]: unknown;
455
+ };
456
+ content: {
457
+ "text/plain": string;
458
+ };
459
+ };
460
+ /** @description Expired JWT token used or insufficient privilege */
461
+ 401: {
462
+ headers: {
463
+ [name: string]: unknown;
464
+ };
465
+ content: {
466
+ "text/plain": string;
467
+ };
468
+ };
469
+ /** @description Internal server error */
470
+ 500: {
471
+ headers: {
472
+ [name: string]: unknown;
473
+ };
474
+ content: {
475
+ "text/plain": string;
476
+ };
477
+ };
706
478
  };
707
- };
708
- /** Expired JWT token used or insufficient privilege */
709
- 401: {
710
- content: {
711
- "text/plain": string;
479
+ };
480
+ upsertPerformanceProfile: {
481
+ parameters: {
482
+ query?: never;
483
+ header?: never;
484
+ path?: never;
485
+ cookie?: never;
712
486
  };
713
- };
714
- /** Result not found */
715
- 404: {
716
- content: {
717
- "text/plain": string;
487
+ /** @description Body for creating or updating a performance profile. */
488
+ requestBody: {
489
+ content: {
490
+ "application/json": {
491
+ /**
492
+ * Format: uuid
493
+ * @description Existing performance-profile ID for updates; omit on create.
494
+ */
495
+ id?: string;
496
+ /** @description Human-readable name of the performance profile. */
497
+ name: string;
498
+ /**
499
+ * Format: uuid
500
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
501
+ */
502
+ userId?: string;
503
+ /**
504
+ * Format: uuid
505
+ * @description Optional schedule ID associating the profile with a recurring run.
506
+ */
507
+ schedule?: string | null;
508
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
509
+ loadGenerators: string[];
510
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
511
+ endpoints: string[];
512
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
513
+ serviceMesh?: string;
514
+ /** @description Number of concurrent requests issued by the load generator. */
515
+ concurrentRequest?: number;
516
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
517
+ qps?: number;
518
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
519
+ duration: string;
520
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
521
+ requestHeaders?: string;
522
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
523
+ requestCookies?: string;
524
+ /** @description HTTP request body sent on each load-test request. */
525
+ requestBody?: string;
526
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
527
+ contentType?: string;
528
+ /** @description Free-form metadata associated with the performance profile. */
529
+ metadata?: {
530
+ [key: string]: unknown;
531
+ };
532
+ };
533
+ };
718
534
  };
719
- };
720
- /** Internal server error */
721
- 500: {
722
- content: {
723
- "text/plain": string;
535
+ responses: {
536
+ /** @description Performance profile upserted */
537
+ 200: {
538
+ headers: {
539
+ [name: string]: unknown;
540
+ };
541
+ content: {
542
+ "application/json": {
543
+ /**
544
+ * Format: uuid
545
+ * @description Unique identifier for the performance profile.
546
+ */
547
+ id: string;
548
+ /** @description Human-readable name of the performance profile. */
549
+ name: string;
550
+ /**
551
+ * Format: uuid
552
+ * @description User ID of the profile owner.
553
+ */
554
+ userId: string;
555
+ /**
556
+ * Format: uuid
557
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
558
+ */
559
+ schedule?: string | null;
560
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
561
+ loadGenerators?: string[];
562
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
563
+ endpoints?: string[];
564
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
565
+ serviceMesh?: string;
566
+ /** @description Number of concurrent requests issued by the load generator. */
567
+ concurrentRequest?: number;
568
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
569
+ qps?: number;
570
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
571
+ duration?: string;
572
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
573
+ requestHeaders?: string;
574
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
575
+ requestCookies?: string;
576
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
577
+ requestBody?: string;
578
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
579
+ contentType?: string;
580
+ /** @description Free-form metadata associated with the performance profile. */
581
+ metadata?: {
582
+ [key: string]: unknown;
583
+ };
584
+ /**
585
+ * Format: date-time
586
+ * @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.
587
+ */
588
+ lastRun?: string | null;
589
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
590
+ totalResults?: number;
591
+ /**
592
+ * Format: date-time
593
+ * @description Timestamp when the performance profile was created.
594
+ */
595
+ createdAt: string;
596
+ /**
597
+ * Format: date-time
598
+ * @description Timestamp when the performance profile was last updated.
599
+ */
600
+ updatedAt: string;
601
+ };
602
+ };
603
+ };
604
+ /** @description Invalid request body or request param */
605
+ 400: {
606
+ headers: {
607
+ [name: string]: unknown;
608
+ };
609
+ content: {
610
+ "text/plain": string;
611
+ };
612
+ };
613
+ /** @description Expired JWT token used or insufficient privilege */
614
+ 401: {
615
+ headers: {
616
+ [name: string]: unknown;
617
+ };
618
+ content: {
619
+ "text/plain": string;
620
+ };
621
+ };
622
+ /** @description Internal server error */
623
+ 500: {
624
+ headers: {
625
+ [name: string]: unknown;
626
+ };
627
+ content: {
628
+ "text/plain": string;
629
+ };
630
+ };
724
631
  };
725
- };
726
632
  };
727
- /** Body for creating or updating a performance profile. */
728
- requestBody: {
729
- content: {
730
- "application/json": {
731
- /**
732
- * Format: uuid
733
- * @description Existing performance-profile ID for updates; omit on create.
734
- */
735
- id?: string;
736
- /** @description Human-readable name of the performance profile. */
737
- name: string;
738
- /**
739
- * Format: uuid
740
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
741
- */
742
- userId?: string;
743
- /**
744
- * Format: uuid
745
- * @description Optional schedule ID associating the profile with a recurring run.
746
- */
747
- schedule?: string | null;
748
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
749
- loadGenerators: string[];
750
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
751
- endpoints: string[];
752
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
753
- serviceMesh?: string;
754
- /** @description Number of concurrent requests issued by the load generator. */
755
- concurrentRequest?: number;
756
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
757
- qps?: number;
758
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
759
- duration: string;
760
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
761
- requestHeaders?: string;
762
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
763
- requestCookies?: string;
764
- /** @description HTTP request body sent on each load-test request. */
765
- requestBody?: string;
766
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
767
- contentType?: string;
768
- /** @description Free-form metadata associated with the performance profile. */
769
- metadata?: { [key: string]: unknown };
633
+ getPerformanceProfile: {
634
+ parameters: {
635
+ query?: never;
636
+ header?: never;
637
+ path: {
638
+ /** @description Performance profile ID. */
639
+ performanceProfileId: string;
640
+ };
641
+ cookie?: never;
642
+ };
643
+ requestBody?: never;
644
+ responses: {
645
+ /** @description Performance profile */
646
+ 200: {
647
+ headers: {
648
+ [name: string]: unknown;
649
+ };
650
+ content: {
651
+ "application/json": {
652
+ /**
653
+ * Format: uuid
654
+ * @description Unique identifier for the performance profile.
655
+ */
656
+ id: string;
657
+ /** @description Human-readable name of the performance profile. */
658
+ name: string;
659
+ /**
660
+ * Format: uuid
661
+ * @description User ID of the profile owner.
662
+ */
663
+ userId: string;
664
+ /**
665
+ * Format: uuid
666
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
667
+ */
668
+ schedule?: string | null;
669
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
670
+ loadGenerators?: string[];
671
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
672
+ endpoints?: string[];
673
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
674
+ serviceMesh?: string;
675
+ /** @description Number of concurrent requests issued by the load generator. */
676
+ concurrentRequest?: number;
677
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
678
+ qps?: number;
679
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
680
+ duration?: string;
681
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
682
+ requestHeaders?: string;
683
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
684
+ requestCookies?: string;
685
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
686
+ requestBody?: string;
687
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
688
+ contentType?: string;
689
+ /** @description Free-form metadata associated with the performance profile. */
690
+ metadata?: {
691
+ [key: string]: unknown;
692
+ };
693
+ /**
694
+ * Format: date-time
695
+ * @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.
696
+ */
697
+ lastRun?: string | null;
698
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
699
+ totalResults?: number;
700
+ /**
701
+ * Format: date-time
702
+ * @description Timestamp when the performance profile was created.
703
+ */
704
+ createdAt: string;
705
+ /**
706
+ * Format: date-time
707
+ * @description Timestamp when the performance profile was last updated.
708
+ */
709
+ updatedAt: string;
710
+ };
711
+ };
712
+ };
713
+ /** @description Invalid request body or request param */
714
+ 400: {
715
+ headers: {
716
+ [name: string]: unknown;
717
+ };
718
+ content: {
719
+ "text/plain": string;
720
+ };
721
+ };
722
+ /** @description Expired JWT token used or insufficient privilege */
723
+ 401: {
724
+ headers: {
725
+ [name: string]: unknown;
726
+ };
727
+ content: {
728
+ "text/plain": string;
729
+ };
730
+ };
731
+ /** @description Result not found */
732
+ 404: {
733
+ headers: {
734
+ [name: string]: unknown;
735
+ };
736
+ content: {
737
+ "text/plain": string;
738
+ };
739
+ };
740
+ /** @description Internal server error */
741
+ 500: {
742
+ headers: {
743
+ [name: string]: unknown;
744
+ };
745
+ content: {
746
+ "text/plain": string;
747
+ };
748
+ };
770
749
  };
771
- };
772
- };
773
- };
774
- /** Deletes the performance profile identified by the path parameter and any associated performance results. */
775
- deletePerformanceProfile: {
776
- parameters: {
777
- path: {
778
- /** Performance profile ID. */
779
- performanceProfileId: string;
780
- };
781
750
  };
782
- responses: {
783
- /** Performance profile deleted */
784
- 204: never;
785
- /** Invalid request body or request param */
786
- 400: {
787
- content: {
788
- "text/plain": string;
751
+ updatePerformanceProfile: {
752
+ parameters: {
753
+ query?: never;
754
+ header?: never;
755
+ path: {
756
+ /** @description Performance profile ID. */
757
+ performanceProfileId: string;
758
+ };
759
+ cookie?: never;
789
760
  };
790
- };
791
- /** Expired JWT token used or insufficient privilege */
792
- 401: {
793
- content: {
794
- "text/plain": string;
761
+ /** @description Body for creating or updating a performance profile. */
762
+ requestBody: {
763
+ content: {
764
+ "application/json": {
765
+ /**
766
+ * Format: uuid
767
+ * @description Existing performance-profile ID for updates; omit on create.
768
+ */
769
+ id?: string;
770
+ /** @description Human-readable name of the performance profile. */
771
+ name: string;
772
+ /**
773
+ * Format: uuid
774
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
775
+ */
776
+ userId?: string;
777
+ /**
778
+ * Format: uuid
779
+ * @description Optional schedule ID associating the profile with a recurring run.
780
+ */
781
+ schedule?: string | null;
782
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
783
+ loadGenerators: string[];
784
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
785
+ endpoints: string[];
786
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
787
+ serviceMesh?: string;
788
+ /** @description Number of concurrent requests issued by the load generator. */
789
+ concurrentRequest?: number;
790
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
791
+ qps?: number;
792
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
793
+ duration: string;
794
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
795
+ requestHeaders?: string;
796
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
797
+ requestCookies?: string;
798
+ /** @description HTTP request body sent on each load-test request. */
799
+ requestBody?: string;
800
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
801
+ contentType?: string;
802
+ /** @description Free-form metadata associated with the performance profile. */
803
+ metadata?: {
804
+ [key: string]: unknown;
805
+ };
806
+ };
807
+ };
795
808
  };
796
- };
797
- /** Result not found */
798
- 404: {
799
- content: {
800
- "text/plain": string;
809
+ responses: {
810
+ /** @description Performance profile */
811
+ 200: {
812
+ headers: {
813
+ [name: string]: unknown;
814
+ };
815
+ content: {
816
+ "application/json": {
817
+ /**
818
+ * Format: uuid
819
+ * @description Unique identifier for the performance profile.
820
+ */
821
+ id: string;
822
+ /** @description Human-readable name of the performance profile. */
823
+ name: string;
824
+ /**
825
+ * Format: uuid
826
+ * @description User ID of the profile owner.
827
+ */
828
+ userId: string;
829
+ /**
830
+ * Format: uuid
831
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
832
+ */
833
+ schedule?: string | null;
834
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
835
+ loadGenerators?: string[];
836
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
837
+ endpoints?: string[];
838
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
839
+ serviceMesh?: string;
840
+ /** @description Number of concurrent requests issued by the load generator. */
841
+ concurrentRequest?: number;
842
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
843
+ qps?: number;
844
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
845
+ duration?: string;
846
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
847
+ requestHeaders?: string;
848
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
849
+ requestCookies?: string;
850
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
851
+ requestBody?: string;
852
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
853
+ contentType?: string;
854
+ /** @description Free-form metadata associated with the performance profile. */
855
+ metadata?: {
856
+ [key: string]: unknown;
857
+ };
858
+ /**
859
+ * Format: date-time
860
+ * @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.
861
+ */
862
+ lastRun?: string | null;
863
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
864
+ totalResults?: number;
865
+ /**
866
+ * Format: date-time
867
+ * @description Timestamp when the performance profile was created.
868
+ */
869
+ createdAt: string;
870
+ /**
871
+ * Format: date-time
872
+ * @description Timestamp when the performance profile was last updated.
873
+ */
874
+ updatedAt: string;
875
+ };
876
+ };
877
+ };
878
+ /** @description Invalid request body or request param */
879
+ 400: {
880
+ headers: {
881
+ [name: string]: unknown;
882
+ };
883
+ content: {
884
+ "text/plain": string;
885
+ };
886
+ };
887
+ /** @description Expired JWT token used or insufficient privilege */
888
+ 401: {
889
+ headers: {
890
+ [name: string]: unknown;
891
+ };
892
+ content: {
893
+ "text/plain": string;
894
+ };
895
+ };
896
+ /** @description Result not found */
897
+ 404: {
898
+ headers: {
899
+ [name: string]: unknown;
900
+ };
901
+ content: {
902
+ "text/plain": string;
903
+ };
904
+ };
905
+ /** @description Internal server error */
906
+ 500: {
907
+ headers: {
908
+ [name: string]: unknown;
909
+ };
910
+ content: {
911
+ "text/plain": string;
912
+ };
913
+ };
801
914
  };
802
- };
803
- /** Internal server error */
804
- 500: {
805
- content: {
806
- "text/plain": string;
915
+ };
916
+ deletePerformanceProfile: {
917
+ parameters: {
918
+ query?: never;
919
+ header?: never;
920
+ path: {
921
+ /** @description Performance profile ID. */
922
+ performanceProfileId: string;
923
+ };
924
+ cookie?: never;
925
+ };
926
+ requestBody?: never;
927
+ responses: {
928
+ /** @description Performance profile deleted */
929
+ 204: {
930
+ headers: {
931
+ [name: string]: unknown;
932
+ };
933
+ content?: never;
934
+ };
935
+ /** @description Invalid request body or request param */
936
+ 400: {
937
+ headers: {
938
+ [name: string]: unknown;
939
+ };
940
+ content: {
941
+ "text/plain": string;
942
+ };
943
+ };
944
+ /** @description Expired JWT token used or insufficient privilege */
945
+ 401: {
946
+ headers: {
947
+ [name: string]: unknown;
948
+ };
949
+ content: {
950
+ "text/plain": string;
951
+ };
952
+ };
953
+ /** @description Result not found */
954
+ 404: {
955
+ headers: {
956
+ [name: string]: unknown;
957
+ };
958
+ content: {
959
+ "text/plain": string;
960
+ };
961
+ };
962
+ /** @description Internal server error */
963
+ 500: {
964
+ headers: {
965
+ [name: string]: unknown;
966
+ };
967
+ content: {
968
+ "text/plain": string;
969
+ };
970
+ };
807
971
  };
808
- };
809
972
  };
810
- };
811
973
  }
812
-
813
- export interface external {}