@meshery/schemas 1.3.9 → 1.4.0

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 (101) hide show
  1. package/dist/cloudApi.d.mts +28 -28
  2. package/dist/cloudApi.d.ts +28 -28
  3. package/dist/constructs/v1alpha1/capability/Capability.d.ts +106 -111
  4. package/dist/constructs/v1alpha1/core/Core.d.ts +822 -734
  5. package/dist/constructs/v1alpha2/catalog/Catalog.d.ts +45 -40
  6. package/dist/constructs/v1alpha3/relationship/Relationship.d.ts +1829 -1716
  7. package/dist/constructs/v1beta1/academy/Academy.d.ts +6023 -6642
  8. package/dist/constructs/v1beta1/badge/Badge.d.ts +439 -600
  9. package/dist/constructs/v1beta1/capability/Capability.d.ts +106 -111
  10. package/dist/constructs/v1beta1/catalog/Catalog.d.ts +45 -40
  11. package/dist/constructs/v1beta1/category/Category.d.ts +38 -26
  12. package/dist/constructs/v1beta1/component/Component.d.ts +833 -729
  13. package/dist/constructs/v1beta1/connection/Connection.d.ts +1170 -1357
  14. package/dist/constructs/v1beta1/core/Core.d.ts +822 -734
  15. package/dist/constructs/v1beta1/credential/Credential.d.ts +458 -593
  16. package/dist/constructs/v1beta1/environment/Environment.d.ts +666 -835
  17. package/dist/constructs/v1beta1/evaluation/Evaluation.d.ts +6142 -5619
  18. package/dist/constructs/v1beta1/event/Event.d.ts +527 -898
  19. package/dist/constructs/v1beta1/feature/Feature.d.ts +343 -389
  20. package/dist/constructs/v1beta1/invitation/Invitation.d.ts +877 -1244
  21. package/dist/constructs/v1beta1/key/Key.d.ts +444 -589
  22. package/dist/constructs/v1beta1/keychain/Keychain.d.ts +575 -796
  23. package/dist/constructs/v1beta1/model/Model.d.ts +598 -572
  24. package/dist/constructs/v1beta1/organization/Organization.d.ts +1410 -1829
  25. package/dist/constructs/v1beta1/pattern/Pattern.d.ts +17988 -17171
  26. package/dist/constructs/v1beta1/plan/Plan.d.ts +115 -159
  27. package/dist/constructs/v1beta1/role/Role.d.ts +688 -933
  28. package/dist/constructs/v1beta1/schedule/Schedule.d.ts +315 -425
  29. package/dist/constructs/v1beta1/subcategory/Subcategory.d.ts +61 -18
  30. package/dist/constructs/v1beta1/subscription/Subscription.d.ts +674 -839
  31. package/dist/constructs/v1beta1/support/Support.d.ts +74 -115
  32. package/dist/constructs/v1beta1/system/System.d.ts +250 -385
  33. package/dist/constructs/v1beta1/team/Team.d.ts +762 -1028
  34. package/dist/constructs/v1beta1/token/Token.d.ts +475 -612
  35. package/dist/constructs/v1beta1/user/User.d.ts +1553 -1722
  36. package/dist/constructs/v1beta1/view/View.d.ts +664 -833
  37. package/dist/constructs/v1beta1/workspace/Workspace.d.ts +4705 -4910
  38. package/dist/constructs/v1beta2/academy/Academy.d.ts +7246 -7864
  39. package/dist/constructs/v1beta2/badge/Badge.d.ts +453 -610
  40. package/dist/constructs/v1beta2/catalog/Catalog.d.ts +45 -40
  41. package/dist/constructs/v1beta2/component/Component.d.ts +851 -747
  42. package/dist/constructs/v1beta2/connection/Connection.d.ts +1189 -1376
  43. package/dist/constructs/v1beta2/core/Core.d.ts +856 -768
  44. package/dist/constructs/v1beta2/credential/Credential.d.ts +437 -572
  45. package/dist/constructs/v1beta2/design/Design.d.ts +18631 -17846
  46. package/dist/constructs/v1beta2/event/Event.d.ts +575 -946
  47. package/dist/constructs/v1beta2/invitation/Invitation.d.ts +901 -1268
  48. package/dist/constructs/v1beta2/key/Key.d.ts +454 -599
  49. package/dist/constructs/v1beta2/keychain/Keychain.d.ts +585 -806
  50. package/dist/constructs/v1beta2/model/Model.d.ts +636 -610
  51. package/dist/constructs/v1beta2/organization/Organization.d.ts +2017 -2458
  52. package/dist/constructs/v1beta2/plan/Plan.d.ts +128 -169
  53. package/dist/constructs/v1beta2/relationship/Relationship.d.ts +2013 -1844
  54. package/dist/constructs/v1beta2/role/Role.d.ts +695 -940
  55. package/dist/constructs/v1beta2/schedule/Schedule.d.ts +356 -466
  56. package/dist/constructs/v1beta2/subscription/Subscription.d.ts +701 -866
  57. package/dist/constructs/v1beta2/team/Team.d.ts +852 -1118
  58. package/dist/constructs/v1beta2/token/Token.d.ts +479 -616
  59. package/dist/constructs/v1beta2/user/User.d.ts +1553 -1722
  60. package/dist/constructs/v1beta2/view/View.d.ts +669 -838
  61. package/dist/constructs/v1beta3/academy/Academy.d.ts +7246 -7864
  62. package/dist/constructs/v1beta3/academy/AcademySchema.js +1 -1
  63. package/dist/constructs/v1beta3/academy/AcademySchema.mjs +1 -1
  64. package/dist/constructs/v1beta3/component/Component.d.ts +857 -753
  65. package/dist/constructs/v1beta3/connection/Connection.d.ts +5559 -5053
  66. package/dist/constructs/v1beta3/connection/ConnectionSchema.js +6 -6
  67. package/dist/constructs/v1beta3/connection/ConnectionSchema.mjs +6 -6
  68. package/dist/constructs/v1beta3/design/Design.d.ts +5297 -5719
  69. package/dist/constructs/v1beta3/design/DesignSchema.js +2 -2
  70. package/dist/constructs/v1beta3/design/DesignSchema.mjs +2 -2
  71. package/dist/constructs/v1beta3/environment/Environment.d.ts +689 -858
  72. package/dist/constructs/v1beta3/event/Event.d.ts +666 -1041
  73. package/dist/constructs/v1beta3/event/EventSchema.js +1 -1
  74. package/dist/constructs/v1beta3/event/EventSchema.mjs +1 -1
  75. package/dist/constructs/v1beta3/filter/Filter.d.ts +1300 -1438
  76. package/dist/constructs/v1beta3/filter/FilterSchema.js +7 -7
  77. package/dist/constructs/v1beta3/filter/FilterSchema.mjs +7 -7
  78. package/dist/constructs/v1beta3/invitation/Invitation.d.ts +911 -1278
  79. package/dist/constructs/v1beta3/invitation/InvitationSchema.js +1 -1
  80. package/dist/constructs/v1beta3/invitation/InvitationSchema.mjs +1 -1
  81. package/dist/constructs/v1beta3/performance_profile/PerformanceProfile.d.ts +1114 -1412
  82. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.js +1 -1
  83. package/dist/constructs/v1beta3/performance_profile/PerformanceProfileSchema.mjs +1 -1
  84. package/dist/constructs/v1beta3/plan/Plan.d.ts +156 -197
  85. package/dist/constructs/v1beta3/relationship/Relationship.d.ts +2013 -1844
  86. package/dist/constructs/v1beta3/subscription/Subscription.d.ts +804 -969
  87. package/dist/constructs/v1beta3/token/Token.d.ts +480 -617
  88. package/dist/constructs/v1beta3/token/TokenSchema.js +1 -1
  89. package/dist/constructs/v1beta3/token/TokenSchema.mjs +1 -1
  90. package/dist/constructs/v1beta3/workspace/Workspace.d.ts +4825 -5033
  91. package/dist/index.d.mts +5032 -5501
  92. package/dist/index.d.ts +5032 -5501
  93. package/dist/mesheryApi.d.mts +8 -8
  94. package/dist/mesheryApi.d.ts +8 -8
  95. package/dist/mesheryApi.js +1 -1
  96. package/dist/mesheryApi.mjs +1 -1
  97. package/dist/permissions.d.mts +25 -1
  98. package/dist/permissions.d.ts +25 -1
  99. package/dist/permissions.js +1 -1
  100. package/dist/permissions.mjs +1 -1
  101. package/package.json +1 -1
@@ -4,127 +4,590 @@
4
4
  */
5
5
 
6
6
  export interface paths {
7
- "/api/performance/profiles": {
8
- parameters: {
9
- query?: never;
10
- header?: never;
11
- path?: never;
12
- cookie?: never;
13
- };
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
+ "/api/performance/profiles/{performanceProfileId}/results": {
22
+ /** Returns paginated load-test results associated with the performance profile identified by the path parameter. */
23
+ get: operations["getPerformanceProfileResults"];
24
+ };
25
+ "/api/performance/profiles/{performanceProfileId}/results/{resultId}": {
26
+ /** Returns one load-test result associated with the performance profile identified by the path parameter. */
27
+ get: operations["getPerformanceProfileResult"];
28
+ };
29
+ "/api/performance/results": {
30
+ /** Returns paginated load-test results visible to the authenticated user. */
31
+ get: operations["getPerformanceResults"];
32
+ };
33
+ }
34
+
35
+ export interface components {
36
+ schemas: {
37
+ /**
38
+ * PerformanceProfile
39
+ * @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
40
+ */
41
+ PerformanceProfile: {
42
+ /**
43
+ * Format: uuid
44
+ * @description Unique identifier for the performance profile.
45
+ */
46
+ id: string;
47
+ /** @description Human-readable name of the performance profile. */
48
+ name: string;
49
+ /**
50
+ * Format: uuid
51
+ * @description User ID of the profile owner.
52
+ */
53
+ owner: string;
54
+ /**
55
+ * Format: uuid
56
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
57
+ */
58
+ schedule?: string | null;
59
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
60
+ loadGenerators?: string[];
61
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
62
+ endpoints?: string[];
63
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
64
+ serviceMesh?: string;
65
+ /** @description Number of concurrent requests issued by the load generator. */
66
+ concurrentRequest?: number;
67
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
68
+ qps?: number;
69
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
70
+ duration?: string;
71
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
72
+ requestHeaders?: string;
73
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
74
+ requestCookies?: string;
75
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
76
+ requestBody?: string;
77
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
78
+ contentType?: string;
79
+ /** @description Free-form metadata associated with the performance profile. */
80
+ metadata?: { [key: string]: unknown };
81
+ /**
82
+ * Format: date-time
83
+ * @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.
84
+ */
85
+ lastRun?: string | null;
86
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
87
+ totalResults?: number;
88
+ /**
89
+ * Format: date-time
90
+ * @description Timestamp when the performance profile was created.
91
+ */
92
+ createdAt: string;
93
+ /**
94
+ * Format: date-time
95
+ * @description Timestamp when the performance profile was last updated.
96
+ */
97
+ updatedAt: string;
98
+ };
99
+ /** @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. */
100
+ PerformanceProfilePayload: {
101
+ /**
102
+ * Format: uuid
103
+ * @description Existing performance-profile ID for updates; omit on create.
104
+ */
105
+ id?: string;
106
+ /** @description Human-readable name of the performance profile. */
107
+ name: string;
108
+ /**
109
+ * Format: uuid
110
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
111
+ */
112
+ userId?: string;
113
+ /**
114
+ * Format: uuid
115
+ * @description Optional schedule ID associating the profile with a recurring run.
116
+ */
117
+ schedule?: string | null;
118
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
119
+ loadGenerators: string[];
120
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
121
+ endpoints: string[];
122
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
123
+ serviceMesh?: string;
124
+ /** @description Number of concurrent requests issued by the load generator. */
125
+ concurrentRequest?: number;
126
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
127
+ qps?: number;
128
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
129
+ duration: string;
130
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
131
+ requestHeaders?: string;
132
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
133
+ requestCookies?: string;
134
+ /** @description HTTP request body sent on each load-test request. */
135
+ requestBody?: string;
136
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
137
+ contentType?: string;
138
+ /** @description Free-form metadata associated with the performance profile. */
139
+ metadata?: { [key: string]: unknown };
140
+ };
141
+ /** @description Paginated list of performance profiles. */
142
+ PerformanceProfilePage: {
143
+ /** @description Zero-based page index returned in this response. */
144
+ page: number;
145
+ /** @description Maximum number of items returned on each page. */
146
+ pageSize: number;
147
+ /** @description Total number of performance profiles across all pages. */
148
+ totalCount: number;
149
+ /** @description Performance profiles in this page. */
150
+ profiles: {
14
151
  /**
15
- * List performance profiles
16
- * @description Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering.
152
+ * Format: uuid
153
+ * @description Unique identifier for the performance profile.
17
154
  */
18
- get: operations["getPerformanceProfiles"];
19
- put?: never;
155
+ id: string;
156
+ /** @description Human-readable name of the performance profile. */
157
+ name: string;
20
158
  /**
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.
159
+ * Format: uuid
160
+ * @description User ID of the profile owner.
23
161
  */
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
- };
162
+ owner: string;
38
163
  /**
39
- * Get a performance profile by ID
40
- * @description Returns a single performance profile owned by (or visible to) the authenticated user.
164
+ * Format: uuid
165
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
41
166
  */
42
- get: operations["getPerformanceProfile"];
167
+ schedule?: string | null;
168
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
169
+ loadGenerators?: string[];
170
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
171
+ endpoints?: string[];
172
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
173
+ serviceMesh?: string;
174
+ /** @description Number of concurrent requests issued by the load generator. */
175
+ concurrentRequest?: number;
176
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
177
+ qps?: number;
178
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
179
+ duration?: string;
180
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
181
+ requestHeaders?: string;
182
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
183
+ requestCookies?: string;
184
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
185
+ requestBody?: string;
186
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
187
+ contentType?: string;
188
+ /** @description Free-form metadata associated with the performance profile. */
189
+ metadata?: { [key: string]: unknown };
43
190
  /**
44
- * Update a performance profile
45
- * @description Updates the performance profile identified by the path parameter.
191
+ * Format: date-time
192
+ * @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.
46
193
  */
47
- put: operations["updatePerformanceProfile"];
48
- post?: never;
194
+ lastRun?: string | null;
195
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
196
+ totalResults?: number;
49
197
  /**
50
- * Delete a performance profile
51
- * @description Deletes the performance profile identified by the path parameter and any associated performance results.
198
+ * Format: date-time
199
+ * @description Timestamp when the performance profile was created.
52
200
  */
53
- delete: operations["deletePerformanceProfile"];
54
- options?: never;
55
- head?: never;
56
- patch?: never;
57
- trace?: never;
58
- };
59
- "/api/performance/profiles/{performanceProfileId}/results": {
60
- parameters: {
61
- query?: never;
62
- header?: never;
63
- path?: never;
64
- cookie?: never;
65
- };
201
+ createdAt: string;
66
202
  /**
67
- * List performance results for a profile
68
- * @description Returns paginated load-test results associated with the performance profile identified by the path parameter.
203
+ * Format: date-time
204
+ * @description Timestamp when the performance profile was last updated.
69
205
  */
70
- get: operations["getPerformanceProfileResults"];
71
- put?: never;
72
- post?: never;
73
- delete?: never;
74
- options?: never;
75
- head?: never;
76
- patch?: never;
77
- trace?: never;
206
+ updatedAt: string;
207
+ }[];
78
208
  };
79
- "/api/performance/profiles/{performanceProfileId}/results/{resultId}": {
80
- parameters: {
81
- query?: never;
82
- header?: never;
83
- path?: never;
84
- cookie?: never;
85
- };
209
+ /** @description Load-test result captured for a Meshery performance profile. */
210
+ PerformanceResult: {
211
+ /**
212
+ * Format: uuid
213
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
214
+ */
215
+ mesheryId?: string;
216
+ /** @description Human-readable name of the performance result. */
217
+ name?: string;
218
+ /** @description Service mesh under test for this result. */
219
+ mesh?: string;
220
+ /**
221
+ * Format: uuid
222
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
223
+ */
224
+ performanceProfile?: string | null;
225
+ /** @description Provider-assigned test identifier for this result. */
226
+ testId?: string;
227
+ /** @description Raw load-generator output for this performance result. */
228
+ runnerResults?: { [key: string]: unknown };
229
+ /** @description Server-side metrics collected for this performance result. */
230
+ serverMetrics?: { [key: string]: unknown };
231
+ /** @description Server board configuration associated with this performance result. */
232
+ serverBoardConfig?: { [key: string]: unknown };
233
+ /**
234
+ * Format: date-time
235
+ * @description Time when the load test started.
236
+ */
237
+ testStartTime?: string;
238
+ /**
239
+ * Format: uuid
240
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
241
+ */
242
+ userId?: string;
243
+ /**
244
+ * Format: date-time
245
+ * @description Timestamp when the performance result was created.
246
+ */
247
+ createdAt?: string;
248
+ /**
249
+ * Format: date-time
250
+ * @description Timestamp when the performance result was last updated.
251
+ */
252
+ updatedAt?: string;
253
+ };
254
+ /** @description Paginated list of performance results. */
255
+ PerformanceResultPage: {
256
+ /** @description Zero-based page index returned in this response. */
257
+ page: number;
258
+ /** @description Maximum number of items returned on each page. */
259
+ pageSize: number;
260
+ /** @description Total number of performance results across all pages. */
261
+ totalCount: number;
262
+ /** @description Performance results in this page. */
263
+ results: {
86
264
  /**
87
- * Get a performance result for a profile
88
- * @description Returns one load-test result associated with the performance profile identified by the path parameter.
265
+ * Format: uuid
266
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
89
267
  */
90
- get: operations["getPerformanceProfileResult"];
91
- put?: never;
92
- post?: never;
93
- delete?: never;
94
- options?: never;
95
- head?: never;
96
- patch?: never;
97
- trace?: never;
98
- };
99
- "/api/performance/results": {
100
- parameters: {
101
- query?: never;
102
- header?: never;
103
- path?: never;
104
- cookie?: never;
105
- };
268
+ mesheryId?: string;
269
+ /** @description Human-readable name of the performance result. */
270
+ name?: string;
271
+ /** @description Service mesh under test for this result. */
272
+ mesh?: string;
106
273
  /**
107
- * List all performance results
108
- * @description Returns paginated load-test results visible to the authenticated user.
274
+ * Format: uuid
275
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
109
276
  */
110
- get: operations["getPerformanceResults"];
111
- put?: never;
112
- post?: never;
113
- delete?: never;
114
- options?: never;
115
- head?: never;
116
- patch?: never;
117
- trace?: never;
118
- };
119
- }
120
- export type webhooks = Record<string, never>;
121
- export interface components {
122
- schemas: {
277
+ performanceProfile?: string | null;
278
+ /** @description Provider-assigned test identifier for this result. */
279
+ testId?: string;
280
+ /** @description Raw load-generator output for this performance result. */
281
+ runnerResults?: { [key: string]: unknown };
282
+ /** @description Server-side metrics collected for this performance result. */
283
+ serverMetrics?: { [key: string]: unknown };
284
+ /** @description Server board configuration associated with this performance result. */
285
+ serverBoardConfig?: { [key: string]: unknown };
286
+ /**
287
+ * Format: date-time
288
+ * @description Time when the load test started.
289
+ */
290
+ testStartTime?: string;
291
+ /**
292
+ * Format: uuid
293
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
294
+ */
295
+ userId?: string;
296
+ /**
297
+ * Format: date-time
298
+ * @description Timestamp when the performance result was created.
299
+ */
300
+ createdAt?: string;
123
301
  /**
124
- * PerformanceProfile
125
- * @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
302
+ * Format: date-time
303
+ * @description Timestamp when the performance result was last updated.
126
304
  */
127
- PerformanceProfile: {
305
+ updatedAt?: string;
306
+ }[];
307
+ };
308
+ /** @description Runtime configuration for a single performance (load) test run. This is the executable test definition that drives load generation, distinct from a saved PerformanceProfile. It is the Meshery-native replacement for the deprecated service-mesh-performance (SMP) PerformanceTestConfig. */
309
+ PerformanceTestConfig: {
310
+ /** @description Version of the performance test configuration format. */
311
+ smpVersion?: string;
312
+ /** @description Opaque identifier assigned to the persisted test configuration. Server-assigned (a UUID string); accepted as a free-form string for backward compatibility with externally authored test files. */
313
+ id?: string;
314
+ /** @description Human-readable name of the performance test. */
315
+ name: string;
316
+ /** @description Arbitrary key/value labels attached to the test configuration. */
317
+ labels?: { [key: string]: string };
318
+ /** @description Load-generation clients that issue requests during the test. A single client is typical; multiple clients describe a distributed load test. */
319
+ clients: {
320
+ /** @description Whether the client runs inside the cluster (internal) rather than against an external endpoint. */
321
+ internal?: boolean;
322
+ /** @description Load generator used to drive the test (e.g. "fortio"). Empty defaults to the server's supported generator. */
323
+ loadGenerator?: string;
324
+ /** @description Application protocol exercised by the client (e.g. "http", "tcp", "udp", "grpc"). */
325
+ protocol?: string;
326
+ /** @description Number of concurrent connections the client opens to the endpoint. */
327
+ connections?: number;
328
+ /** @description Target requests-per-second issued by the client. Zero means unthrottled. */
329
+ rps?: number;
330
+ /** @description HTTP request headers sent on each request. */
331
+ headers?: { [key: string]: string };
332
+ /** @description HTTP request cookies sent on each request. */
333
+ cookies?: { [key: string]: string };
334
+ /** @description Request body sent on each request. */
335
+ body?: string;
336
+ /** @description Content-Type header applied to the request body (e.g. "application/json"). */
337
+ contentType?: string;
338
+ /** @description Target endpoint URLs the client issues requests against. */
339
+ endpointUrls: string[];
340
+ /** @description PEM-encoded SSL certificate presented by the client, when required. */
341
+ sslCertificate?: string;
342
+ /** @description Additional load-generator-specific options passed through to the generator. */
343
+ additionalOptions?: string;
344
+ }[];
345
+ /** @description Length of time the endpoint is held under load, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
346
+ duration: string;
347
+ };
348
+ /** @description A single load-generation client within a PerformanceTestConfig. It is the Meshery-native replacement for the deprecated service-mesh-performance (SMP) PerformanceTestConfig_Client. */
349
+ PerformanceTestClient: {
350
+ /** @description Whether the client runs inside the cluster (internal) rather than against an external endpoint. */
351
+ internal?: boolean;
352
+ /** @description Load generator used to drive the test (e.g. "fortio"). Empty defaults to the server's supported generator. */
353
+ loadGenerator?: string;
354
+ /** @description Application protocol exercised by the client (e.g. "http", "tcp", "udp", "grpc"). */
355
+ protocol?: string;
356
+ /** @description Number of concurrent connections the client opens to the endpoint. */
357
+ connections?: number;
358
+ /** @description Target requests-per-second issued by the client. Zero means unthrottled. */
359
+ rps?: number;
360
+ /** @description HTTP request headers sent on each request. */
361
+ headers?: { [key: string]: string };
362
+ /** @description HTTP request cookies sent on each request. */
363
+ cookies?: { [key: string]: string };
364
+ /** @description Request body sent on each request. */
365
+ body?: string;
366
+ /** @description Content-Type header applied to the request body (e.g. "application/json"). */
367
+ contentType?: string;
368
+ /** @description Target endpoint URLs the client issues requests against. */
369
+ endpointUrls: string[];
370
+ /** @description PEM-encoded SSL certificate presented by the client, when required. */
371
+ sslCertificate?: string;
372
+ /** @description Additional load-generator-specific options passed through to the generator. */
373
+ additionalOptions?: string;
374
+ };
375
+ };
376
+ responses: {
377
+ /** ok */
378
+ 200: {
379
+ content: {
380
+ "text/plain": string;
381
+ };
382
+ };
383
+ /** Invalid request body or request param */
384
+ 400: {
385
+ content: {
386
+ "text/plain": string;
387
+ };
388
+ };
389
+ /** Expired JWT token used or insufficient privilege */
390
+ 401: {
391
+ content: {
392
+ "text/plain": string;
393
+ };
394
+ };
395
+ /** Result not found */
396
+ 404: {
397
+ content: {
398
+ "text/plain": string;
399
+ };
400
+ };
401
+ /** Internal server error */
402
+ 500: {
403
+ content: {
404
+ "text/plain": string;
405
+ };
406
+ };
407
+ };
408
+ parameters: {
409
+ /** @description Performance profile ID. */
410
+ performanceProfileId: string;
411
+ /** @description Performance result ID. */
412
+ resultId: string;
413
+ /** @description Get responses that match search param value */
414
+ search: string;
415
+ /** @description Get ordered responses */
416
+ order: string;
417
+ /** @description Get responses by page */
418
+ page: string;
419
+ /** @description Get responses by pagesize */
420
+ pagesize: string;
421
+ /** @description Start date for filtering results by test start time, in YYYY-MM-DD format. */
422
+ from: string;
423
+ /** @description End date for filtering results by test start time, in YYYY-MM-DD format. */
424
+ to: string;
425
+ };
426
+ requestBodies: {
427
+ /** Body for creating or updating a performance profile. */
428
+ performanceProfilePayload: {
429
+ content: {
430
+ "application/json": {
431
+ /**
432
+ * Format: uuid
433
+ * @description Existing performance-profile ID for updates; omit on create.
434
+ */
435
+ id?: string;
436
+ /** @description Human-readable name of the performance profile. */
437
+ name: string;
438
+ /**
439
+ * Format: uuid
440
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
441
+ */
442
+ userId?: string;
443
+ /**
444
+ * Format: uuid
445
+ * @description Optional schedule ID associating the profile with a recurring run.
446
+ */
447
+ schedule?: string | null;
448
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
449
+ loadGenerators: string[];
450
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
451
+ endpoints: string[];
452
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
453
+ serviceMesh?: string;
454
+ /** @description Number of concurrent requests issued by the load generator. */
455
+ concurrentRequest?: number;
456
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
457
+ qps?: number;
458
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
459
+ duration: string;
460
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
461
+ requestHeaders?: string;
462
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
463
+ requestCookies?: string;
464
+ /** @description HTTP request body sent on each load-test request. */
465
+ requestBody?: string;
466
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
467
+ contentType?: string;
468
+ /** @description Free-form metadata associated with the performance profile. */
469
+ metadata?: { [key: string]: unknown };
470
+ };
471
+ };
472
+ };
473
+ };
474
+ }
475
+
476
+ export interface operations {
477
+ /** Returns the performance profiles owned by the authenticated user, with pagination, search, and ordering. */
478
+ getPerformanceProfiles: {
479
+ parameters: {
480
+ query: {
481
+ /** Get responses by page */
482
+ page?: string;
483
+ /** Get responses by pagesize */
484
+ pagesize?: string;
485
+ /** Get responses that match search param value */
486
+ search?: string;
487
+ /** Get ordered responses */
488
+ order?: string;
489
+ };
490
+ };
491
+ responses: {
492
+ /** Performance profiles */
493
+ 200: {
494
+ content: {
495
+ "application/json": {
496
+ /** @description Zero-based page index returned in this response. */
497
+ page: number;
498
+ /** @description Maximum number of items returned on each page. */
499
+ pageSize: number;
500
+ /** @description Total number of performance profiles across all pages. */
501
+ totalCount: number;
502
+ /** @description Performance profiles in this page. */
503
+ profiles: {
504
+ /**
505
+ * Format: uuid
506
+ * @description Unique identifier for the performance profile.
507
+ */
508
+ id: string;
509
+ /** @description Human-readable name of the performance profile. */
510
+ name: string;
511
+ /**
512
+ * Format: uuid
513
+ * @description User ID of the profile owner.
514
+ */
515
+ owner: string;
516
+ /**
517
+ * Format: uuid
518
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
519
+ */
520
+ schedule?: string | null;
521
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
522
+ loadGenerators?: string[];
523
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
524
+ endpoints?: string[];
525
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
526
+ serviceMesh?: string;
527
+ /** @description Number of concurrent requests issued by the load generator. */
528
+ concurrentRequest?: number;
529
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
530
+ qps?: number;
531
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
532
+ duration?: string;
533
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
534
+ requestHeaders?: string;
535
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
536
+ requestCookies?: string;
537
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
538
+ requestBody?: string;
539
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
540
+ contentType?: string;
541
+ /** @description Free-form metadata associated with the performance profile. */
542
+ metadata?: { [key: string]: unknown };
543
+ /**
544
+ * Format: date-time
545
+ * @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.
546
+ */
547
+ lastRun?: string | null;
548
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
549
+ totalResults?: number;
550
+ /**
551
+ * Format: date-time
552
+ * @description Timestamp when the performance profile was created.
553
+ */
554
+ createdAt: string;
555
+ /**
556
+ * Format: date-time
557
+ * @description Timestamp when the performance profile was last updated.
558
+ */
559
+ updatedAt: string;
560
+ }[];
561
+ };
562
+ };
563
+ };
564
+ /** Invalid request body or request param */
565
+ 400: {
566
+ content: {
567
+ "text/plain": string;
568
+ };
569
+ };
570
+ /** Expired JWT token used or insufficient privilege */
571
+ 401: {
572
+ content: {
573
+ "text/plain": string;
574
+ };
575
+ };
576
+ /** Internal server error */
577
+ 500: {
578
+ content: {
579
+ "text/plain": string;
580
+ };
581
+ };
582
+ };
583
+ };
584
+ /** Creates a new performance profile when the body omits id, or updates the matching existing profile when an id is provided. */
585
+ upsertPerformanceProfile: {
586
+ responses: {
587
+ /** Performance profile upserted */
588
+ 200: {
589
+ content: {
590
+ "application/json": {
128
591
  /**
129
592
  * Format: uuid
130
593
  * @description Unique identifier for the performance profile.
@@ -136,7 +599,7 @@ export interface components {
136
599
  * Format: uuid
137
600
  * @description User ID of the profile owner.
138
601
  */
139
- userId: string;
602
+ owner: string;
140
603
  /**
141
604
  * Format: uuid
142
605
  * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
@@ -163,9 +626,7 @@ export interface components {
163
626
  /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
164
627
  contentType?: string;
165
628
  /** @description Free-form metadata associated with the performance profile. */
166
- metadata?: {
167
- [key: string]: unknown;
168
- };
629
+ metadata?: { [key: string]: unknown };
169
630
  /**
170
631
  * Format: date-time
171
632
  * @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.
@@ -183,30 +644,109 @@ export interface components {
183
644
  * @description Timestamp when the performance profile was last updated.
184
645
  */
185
646
  updatedAt: string;
647
+ };
648
+ };
649
+ };
650
+ /** Invalid request body or request param */
651
+ 400: {
652
+ content: {
653
+ "text/plain": string;
186
654
  };
187
- /** @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. */
188
- PerformanceProfilePayload: {
655
+ };
656
+ /** Expired JWT token used or insufficient privilege */
657
+ 401: {
658
+ content: {
659
+ "text/plain": string;
660
+ };
661
+ };
662
+ /** Internal server error */
663
+ 500: {
664
+ content: {
665
+ "text/plain": string;
666
+ };
667
+ };
668
+ };
669
+ /** Body for creating or updating a performance profile. */
670
+ requestBody: {
671
+ content: {
672
+ "application/json": {
673
+ /**
674
+ * Format: uuid
675
+ * @description Existing performance-profile ID for updates; omit on create.
676
+ */
677
+ id?: string;
678
+ /** @description Human-readable name of the performance profile. */
679
+ name: string;
680
+ /**
681
+ * Format: uuid
682
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
683
+ */
684
+ userId?: string;
685
+ /**
686
+ * Format: uuid
687
+ * @description Optional schedule ID associating the profile with a recurring run.
688
+ */
689
+ schedule?: string | null;
690
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
691
+ loadGenerators: string[];
692
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
693
+ endpoints: string[];
694
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
695
+ serviceMesh?: string;
696
+ /** @description Number of concurrent requests issued by the load generator. */
697
+ concurrentRequest?: number;
698
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
699
+ qps?: number;
700
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
701
+ duration: string;
702
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
703
+ requestHeaders?: string;
704
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
705
+ requestCookies?: string;
706
+ /** @description HTTP request body sent on each load-test request. */
707
+ requestBody?: string;
708
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
709
+ contentType?: string;
710
+ /** @description Free-form metadata associated with the performance profile. */
711
+ metadata?: { [key: string]: unknown };
712
+ };
713
+ };
714
+ };
715
+ };
716
+ /** Returns a single performance profile owned by (or visible to) the authenticated user. */
717
+ getPerformanceProfile: {
718
+ parameters: {
719
+ path: {
720
+ /** Performance profile ID. */
721
+ performanceProfileId: string;
722
+ };
723
+ };
724
+ responses: {
725
+ /** Performance profile */
726
+ 200: {
727
+ content: {
728
+ "application/json": {
189
729
  /**
190
730
  * Format: uuid
191
- * @description Existing performance-profile ID for updates; omit on create.
731
+ * @description Unique identifier for the performance profile.
192
732
  */
193
- id?: string;
733
+ id: string;
194
734
  /** @description Human-readable name of the performance profile. */
195
735
  name: string;
196
736
  /**
197
737
  * Format: uuid
198
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
738
+ * @description User ID of the profile owner.
199
739
  */
200
- userId?: string;
740
+ owner: string;
201
741
  /**
202
742
  * Format: uuid
203
- * @description Optional schedule ID associating the profile with a recurring run.
743
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
204
744
  */
205
745
  schedule?: string | null;
206
746
  /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
207
- loadGenerators: string[];
747
+ loadGenerators?: string[];
208
748
  /** @description Endpoints (URLs) targeted by the performance profile's load test. */
209
- endpoints: string[];
749
+ endpoints?: string[];
210
750
  /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
211
751
  serviceMesh?: string;
212
752
  /** @description Number of concurrent requests issued by the load generator. */
@@ -214,92 +754,362 @@ export interface components {
214
754
  /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
215
755
  qps?: number;
216
756
  /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
217
- duration: string;
218
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
757
+ duration?: string;
758
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
219
759
  requestHeaders?: string;
220
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
760
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
221
761
  requestCookies?: string;
222
- /** @description HTTP request body sent on each load-test request. */
762
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
223
763
  requestBody?: string;
224
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
764
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
225
765
  contentType?: string;
226
766
  /** @description Free-form metadata associated with the performance profile. */
227
- metadata?: {
228
- [key: string]: unknown;
229
- };
767
+ metadata?: { [key: string]: unknown };
768
+ /**
769
+ * Format: date-time
770
+ * @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.
771
+ */
772
+ lastRun?: string | null;
773
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
774
+ totalResults?: number;
775
+ /**
776
+ * Format: date-time
777
+ * @description Timestamp when the performance profile was created.
778
+ */
779
+ createdAt: string;
780
+ /**
781
+ * Format: date-time
782
+ * @description Timestamp when the performance profile was last updated.
783
+ */
784
+ updatedAt: string;
785
+ };
230
786
  };
231
- /** @description Paginated list of performance profiles. */
232
- PerformanceProfilePage: {
787
+ };
788
+ /** Invalid request body or request param */
789
+ 400: {
790
+ content: {
791
+ "text/plain": string;
792
+ };
793
+ };
794
+ /** Expired JWT token used or insufficient privilege */
795
+ 401: {
796
+ content: {
797
+ "text/plain": string;
798
+ };
799
+ };
800
+ /** Result not found */
801
+ 404: {
802
+ content: {
803
+ "text/plain": string;
804
+ };
805
+ };
806
+ /** Internal server error */
807
+ 500: {
808
+ content: {
809
+ "text/plain": string;
810
+ };
811
+ };
812
+ };
813
+ };
814
+ /** Updates the performance profile identified by the path parameter. */
815
+ updatePerformanceProfile: {
816
+ parameters: {
817
+ path: {
818
+ /** Performance profile ID. */
819
+ performanceProfileId: string;
820
+ };
821
+ };
822
+ responses: {
823
+ /** Performance profile */
824
+ 200: {
825
+ content: {
826
+ "application/json": {
827
+ /**
828
+ * Format: uuid
829
+ * @description Unique identifier for the performance profile.
830
+ */
831
+ id: string;
832
+ /** @description Human-readable name of the performance profile. */
833
+ name: string;
834
+ /**
835
+ * Format: uuid
836
+ * @description User ID of the profile owner.
837
+ */
838
+ owner: string;
839
+ /**
840
+ * Format: uuid
841
+ * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
842
+ */
843
+ schedule?: string | null;
844
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
845
+ loadGenerators?: string[];
846
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
847
+ endpoints?: string[];
848
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
849
+ serviceMesh?: string;
850
+ /** @description Number of concurrent requests issued by the load generator. */
851
+ concurrentRequest?: number;
852
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
853
+ qps?: number;
854
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
855
+ duration?: string;
856
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
857
+ requestHeaders?: string;
858
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
859
+ requestCookies?: string;
860
+ /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
861
+ requestBody?: string;
862
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
863
+ contentType?: string;
864
+ /** @description Free-form metadata associated with the performance profile. */
865
+ metadata?: { [key: string]: unknown };
866
+ /**
867
+ * Format: date-time
868
+ * @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.
869
+ */
870
+ lastRun?: string | null;
871
+ /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
872
+ totalResults?: number;
873
+ /**
874
+ * Format: date-time
875
+ * @description Timestamp when the performance profile was created.
876
+ */
877
+ createdAt: string;
878
+ /**
879
+ * Format: date-time
880
+ * @description Timestamp when the performance profile was last updated.
881
+ */
882
+ updatedAt: string;
883
+ };
884
+ };
885
+ };
886
+ /** Invalid request body or request param */
887
+ 400: {
888
+ content: {
889
+ "text/plain": string;
890
+ };
891
+ };
892
+ /** Expired JWT token used or insufficient privilege */
893
+ 401: {
894
+ content: {
895
+ "text/plain": string;
896
+ };
897
+ };
898
+ /** Result not found */
899
+ 404: {
900
+ content: {
901
+ "text/plain": string;
902
+ };
903
+ };
904
+ /** Internal server error */
905
+ 500: {
906
+ content: {
907
+ "text/plain": string;
908
+ };
909
+ };
910
+ };
911
+ /** Body for creating or updating a performance profile. */
912
+ requestBody: {
913
+ content: {
914
+ "application/json": {
915
+ /**
916
+ * Format: uuid
917
+ * @description Existing performance-profile ID for updates; omit on create.
918
+ */
919
+ id?: string;
920
+ /** @description Human-readable name of the performance profile. */
921
+ name: string;
922
+ /**
923
+ * Format: uuid
924
+ * @description Owner user ID. When omitted, the server infers it from the authenticated user.
925
+ */
926
+ userId?: string;
927
+ /**
928
+ * Format: uuid
929
+ * @description Optional schedule ID associating the profile with a recurring run.
930
+ */
931
+ schedule?: string | null;
932
+ /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
933
+ loadGenerators: string[];
934
+ /** @description Endpoints (URLs) targeted by the performance profile's load test. */
935
+ endpoints: string[];
936
+ /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
937
+ serviceMesh?: string;
938
+ /** @description Number of concurrent requests issued by the load generator. */
939
+ concurrentRequest?: number;
940
+ /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
941
+ qps?: number;
942
+ /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
943
+ duration: string;
944
+ /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
945
+ requestHeaders?: string;
946
+ /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
947
+ requestCookies?: string;
948
+ /** @description HTTP request body sent on each load-test request. */
949
+ requestBody?: string;
950
+ /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
951
+ contentType?: string;
952
+ /** @description Free-form metadata associated with the performance profile. */
953
+ metadata?: { [key: string]: unknown };
954
+ };
955
+ };
956
+ };
957
+ };
958
+ /** Deletes the performance profile identified by the path parameter and any associated performance results. */
959
+ deletePerformanceProfile: {
960
+ parameters: {
961
+ path: {
962
+ /** Performance profile ID. */
963
+ performanceProfileId: string;
964
+ };
965
+ };
966
+ responses: {
967
+ /** Performance profile deleted */
968
+ 204: never;
969
+ /** Invalid request body or request param */
970
+ 400: {
971
+ content: {
972
+ "text/plain": string;
973
+ };
974
+ };
975
+ /** Expired JWT token used or insufficient privilege */
976
+ 401: {
977
+ content: {
978
+ "text/plain": string;
979
+ };
980
+ };
981
+ /** Result not found */
982
+ 404: {
983
+ content: {
984
+ "text/plain": string;
985
+ };
986
+ };
987
+ /** Internal server error */
988
+ 500: {
989
+ content: {
990
+ "text/plain": string;
991
+ };
992
+ };
993
+ };
994
+ };
995
+ /** Returns paginated load-test results associated with the performance profile identified by the path parameter. */
996
+ getPerformanceProfileResults: {
997
+ parameters: {
998
+ path: {
999
+ /** Performance profile ID. */
1000
+ performanceProfileId: string;
1001
+ };
1002
+ query: {
1003
+ /** Get responses by page */
1004
+ page?: string;
1005
+ /** Get responses by pagesize */
1006
+ pagesize?: string;
1007
+ /** Get responses that match search param value */
1008
+ search?: string;
1009
+ /** Get ordered responses */
1010
+ order?: string;
1011
+ };
1012
+ };
1013
+ responses: {
1014
+ /** Performance results */
1015
+ 200: {
1016
+ content: {
1017
+ "application/json": {
233
1018
  /** @description Zero-based page index returned in this response. */
234
1019
  page: number;
235
1020
  /** @description Maximum number of items returned on each page. */
236
1021
  pageSize: number;
237
- /** @description Total number of performance profiles across all pages. */
1022
+ /** @description Total number of performance results across all pages. */
238
1023
  totalCount: number;
239
- /** @description Performance profiles in this page. */
240
- profiles: {
241
- /**
242
- * Format: uuid
243
- * @description Unique identifier for the performance profile.
244
- */
245
- id: string;
246
- /** @description Human-readable name of the performance profile. */
247
- name: string;
248
- /**
249
- * Format: uuid
250
- * @description User ID of the profile owner.
251
- */
252
- userId: string;
253
- /**
254
- * Format: uuid
255
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
256
- */
257
- schedule?: string | null;
258
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
259
- loadGenerators?: string[];
260
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
261
- endpoints?: string[];
262
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
263
- serviceMesh?: string;
264
- /** @description Number of concurrent requests issued by the load generator. */
265
- concurrentRequest?: number;
266
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
267
- qps?: number;
268
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
269
- duration?: string;
270
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
271
- requestHeaders?: string;
272
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
273
- requestCookies?: string;
274
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
275
- requestBody?: string;
276
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
277
- contentType?: string;
278
- /** @description Free-form metadata associated with the performance profile. */
279
- metadata?: {
280
- [key: string]: unknown;
281
- };
282
- /**
283
- * Format: date-time
284
- * @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.
285
- */
286
- lastRun?: string | null;
287
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
288
- totalResults?: number;
289
- /**
290
- * Format: date-time
291
- * @description Timestamp when the performance profile was created.
292
- */
293
- createdAt: string;
294
- /**
295
- * Format: date-time
296
- * @description Timestamp when the performance profile was last updated.
297
- */
298
- updatedAt: string;
1024
+ /** @description Performance results in this page. */
1025
+ results: {
1026
+ /**
1027
+ * Format: uuid
1028
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1029
+ */
1030
+ mesheryId?: string;
1031
+ /** @description Human-readable name of the performance result. */
1032
+ name?: string;
1033
+ /** @description Service mesh under test for this result. */
1034
+ mesh?: string;
1035
+ /**
1036
+ * Format: uuid
1037
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1038
+ */
1039
+ performanceProfile?: string | null;
1040
+ /** @description Provider-assigned test identifier for this result. */
1041
+ testId?: string;
1042
+ /** @description Raw load-generator output for this performance result. */
1043
+ runnerResults?: { [key: string]: unknown };
1044
+ /** @description Server-side metrics collected for this performance result. */
1045
+ serverMetrics?: { [key: string]: unknown };
1046
+ /** @description Server board configuration associated with this performance result. */
1047
+ serverBoardConfig?: { [key: string]: unknown };
1048
+ /**
1049
+ * Format: date-time
1050
+ * @description Time when the load test started.
1051
+ */
1052
+ testStartTime?: string;
1053
+ /**
1054
+ * Format: uuid
1055
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1056
+ */
1057
+ userId?: string;
1058
+ /**
1059
+ * Format: date-time
1060
+ * @description Timestamp when the performance result was created.
1061
+ */
1062
+ createdAt?: string;
1063
+ /**
1064
+ * Format: date-time
1065
+ * @description Timestamp when the performance result was last updated.
1066
+ */
1067
+ updatedAt?: string;
299
1068
  }[];
1069
+ };
1070
+ };
1071
+ };
1072
+ /** Invalid request body or request param */
1073
+ 400: {
1074
+ content: {
1075
+ "text/plain": string;
300
1076
  };
301
- /** @description Load-test result captured for a Meshery performance profile. */
302
- PerformanceResult: {
1077
+ };
1078
+ /** Expired JWT token used or insufficient privilege */
1079
+ 401: {
1080
+ content: {
1081
+ "text/plain": string;
1082
+ };
1083
+ };
1084
+ /** Result not found */
1085
+ 404: {
1086
+ content: {
1087
+ "text/plain": string;
1088
+ };
1089
+ };
1090
+ /** Internal server error */
1091
+ 500: {
1092
+ content: {
1093
+ "text/plain": string;
1094
+ };
1095
+ };
1096
+ };
1097
+ };
1098
+ /** Returns one load-test result associated with the performance profile identified by the path parameter. */
1099
+ getPerformanceProfileResult: {
1100
+ parameters: {
1101
+ path: {
1102
+ /** Performance profile ID. */
1103
+ performanceProfileId: string;
1104
+ /** Performance result ID. */
1105
+ resultId: string;
1106
+ };
1107
+ };
1108
+ responses: {
1109
+ /** Performance result */
1110
+ 200: {
1111
+ content: {
1112
+ "application/json": {
303
1113
  /**
304
1114
  * Format: uuid
305
1115
  * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
@@ -317,17 +1127,11 @@ export interface components {
317
1127
  /** @description Provider-assigned test identifier for this result. */
318
1128
  testId?: string;
319
1129
  /** @description Raw load-generator output for this performance result. */
320
- runnerResults?: {
321
- [key: string]: unknown;
322
- };
1130
+ runnerResults?: { [key: string]: unknown };
323
1131
  /** @description Server-side metrics collected for this performance result. */
324
- serverMetrics?: {
325
- [key: string]: unknown;
326
- };
1132
+ serverMetrics?: { [key: string]: unknown };
327
1133
  /** @description Server board configuration associated with this performance result. */
328
- serverBoardConfig?: {
329
- [key: string]: unknown;
330
- };
1134
+ serverBoardConfig?: { [key: string]: unknown };
331
1135
  /**
332
1136
  * Format: date-time
333
1137
  * @description Time when the load test started.
@@ -348,9 +1152,58 @@ export interface components {
348
1152
  * @description Timestamp when the performance result was last updated.
349
1153
  */
350
1154
  updatedAt?: string;
1155
+ };
1156
+ };
1157
+ };
1158
+ /** Invalid request body or request param */
1159
+ 400: {
1160
+ content: {
1161
+ "text/plain": string;
1162
+ };
1163
+ };
1164
+ /** Expired JWT token used or insufficient privilege */
1165
+ 401: {
1166
+ content: {
1167
+ "text/plain": string;
1168
+ };
1169
+ };
1170
+ /** Result not found */
1171
+ 404: {
1172
+ content: {
1173
+ "text/plain": string;
351
1174
  };
352
- /** @description Paginated list of performance results. */
353
- PerformanceResultPage: {
1175
+ };
1176
+ /** Internal server error */
1177
+ 500: {
1178
+ content: {
1179
+ "text/plain": string;
1180
+ };
1181
+ };
1182
+ };
1183
+ };
1184
+ /** Returns paginated load-test results visible to the authenticated user. */
1185
+ getPerformanceResults: {
1186
+ parameters: {
1187
+ query: {
1188
+ /** Get responses by page */
1189
+ page?: string;
1190
+ /** Get responses by pagesize */
1191
+ pagesize?: string;
1192
+ /** Get responses that match search param value */
1193
+ search?: string;
1194
+ /** Get ordered responses */
1195
+ order?: string;
1196
+ /** Start date for filtering results by test start time, in YYYY-MM-DD format. */
1197
+ from?: string;
1198
+ /** End date for filtering results by test start time, in YYYY-MM-DD format. */
1199
+ to?: string;
1200
+ };
1201
+ };
1202
+ responses: {
1203
+ /** Performance results */
1204
+ 200: {
1205
+ content: {
1206
+ "application/json": {
354
1207
  /** @description Zero-based page index returned in this response. */
355
1208
  page: number;
356
1209
  /** @description Maximum number of items returned on each page. */
@@ -359,1223 +1212,72 @@ export interface components {
359
1212
  totalCount: number;
360
1213
  /** @description Performance results in this page. */
361
1214
  results: {
362
- /**
363
- * Format: uuid
364
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
365
- */
366
- mesheryId?: string;
367
- /** @description Human-readable name of the performance result. */
368
- name?: string;
369
- /** @description Service mesh under test for this result. */
370
- mesh?: string;
371
- /**
372
- * Format: uuid
373
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
374
- */
375
- performanceProfile?: string | null;
376
- /** @description Provider-assigned test identifier for this result. */
377
- testId?: string;
378
- /** @description Raw load-generator output for this performance result. */
379
- runnerResults?: {
380
- [key: string]: unknown;
381
- };
382
- /** @description Server-side metrics collected for this performance result. */
383
- serverMetrics?: {
384
- [key: string]: unknown;
385
- };
386
- /** @description Server board configuration associated with this performance result. */
387
- serverBoardConfig?: {
388
- [key: string]: unknown;
389
- };
390
- /**
391
- * Format: date-time
392
- * @description Time when the load test started.
393
- */
394
- testStartTime?: string;
395
- /**
396
- * Format: uuid
397
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
398
- */
399
- userId?: string;
400
- /**
401
- * Format: date-time
402
- * @description Timestamp when the performance result was created.
403
- */
404
- createdAt?: string;
405
- /**
406
- * Format: date-time
407
- * @description Timestamp when the performance result was last updated.
408
- */
409
- updatedAt?: string;
410
- }[];
411
- };
412
- /** @description Runtime configuration for a single performance (load) test run. This is the executable test definition that drives load generation, distinct from a saved PerformanceProfile. It is the Meshery-native replacement for the deprecated service-mesh-performance (SMP) PerformanceTestConfig. */
413
- PerformanceTestConfig: {
414
- /** @description Version of the performance test configuration format. */
415
- smpVersion?: string;
416
- /** @description Opaque identifier assigned to the persisted test configuration. Server-assigned (a UUID string); accepted as a free-form string for backward compatibility with externally authored test files. */
417
- id?: string;
418
- /** @description Human-readable name of the performance test. */
419
- name: string;
420
- /** @description Arbitrary key/value labels attached to the test configuration. */
421
- labels?: {
422
- [key: string]: string;
423
- };
424
- /** @description Load-generation clients that issue requests during the test. A single client is typical; multiple clients describe a distributed load test. */
425
- clients: {
426
- /** @description Whether the client runs inside the cluster (internal) rather than against an external endpoint. */
427
- internal?: boolean;
428
- /** @description Load generator used to drive the test (e.g. "fortio"). Empty defaults to the server's supported generator. */
429
- loadGenerator?: string;
430
- /** @description Application protocol exercised by the client (e.g. "http", "tcp", "udp", "grpc"). */
431
- protocol?: string;
432
- /** @description Number of concurrent connections the client opens to the endpoint. */
433
- connections?: number;
434
- /** @description Target requests-per-second issued by the client. Zero means unthrottled. */
435
- rps?: number;
436
- /** @description HTTP request headers sent on each request. */
437
- headers?: {
438
- [key: string]: string;
439
- };
440
- /** @description HTTP request cookies sent on each request. */
441
- cookies?: {
442
- [key: string]: string;
443
- };
444
- /** @description Request body sent on each request. */
445
- body?: string;
446
- /** @description Content-Type header applied to the request body (e.g. "application/json"). */
447
- contentType?: string;
448
- /** @description Target endpoint URLs the client issues requests against. */
449
- endpointUrls: string[];
450
- /** @description PEM-encoded SSL certificate presented by the client, when required. */
451
- sslCertificate?: string;
452
- /** @description Additional load-generator-specific options passed through to the generator. */
453
- additionalOptions?: string;
1215
+ /**
1216
+ * Format: uuid
1217
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1218
+ */
1219
+ mesheryId?: string;
1220
+ /** @description Human-readable name of the performance result. */
1221
+ name?: string;
1222
+ /** @description Service mesh under test for this result. */
1223
+ mesh?: string;
1224
+ /**
1225
+ * Format: uuid
1226
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1227
+ */
1228
+ performanceProfile?: string | null;
1229
+ /** @description Provider-assigned test identifier for this result. */
1230
+ testId?: string;
1231
+ /** @description Raw load-generator output for this performance result. */
1232
+ runnerResults?: { [key: string]: unknown };
1233
+ /** @description Server-side metrics collected for this performance result. */
1234
+ serverMetrics?: { [key: string]: unknown };
1235
+ /** @description Server board configuration associated with this performance result. */
1236
+ serverBoardConfig?: { [key: string]: unknown };
1237
+ /**
1238
+ * Format: date-time
1239
+ * @description Time when the load test started.
1240
+ */
1241
+ testStartTime?: string;
1242
+ /**
1243
+ * Format: uuid
1244
+ * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1245
+ */
1246
+ userId?: string;
1247
+ /**
1248
+ * Format: date-time
1249
+ * @description Timestamp when the performance result was created.
1250
+ */
1251
+ createdAt?: string;
1252
+ /**
1253
+ * Format: date-time
1254
+ * @description Timestamp when the performance result was last updated.
1255
+ */
1256
+ updatedAt?: string;
454
1257
  }[];
455
- /** @description Length of time the endpoint is held under load, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
456
- duration: string;
1258
+ };
457
1259
  };
458
- /** @description A single load-generation client within a PerformanceTestConfig. It is the Meshery-native replacement for the deprecated service-mesh-performance (SMP) PerformanceTestConfig_Client. */
459
- PerformanceTestClient: {
460
- /** @description Whether the client runs inside the cluster (internal) rather than against an external endpoint. */
461
- internal?: boolean;
462
- /** @description Load generator used to drive the test (e.g. "fortio"). Empty defaults to the server's supported generator. */
463
- loadGenerator?: string;
464
- /** @description Application protocol exercised by the client (e.g. "http", "tcp", "udp", "grpc"). */
465
- protocol?: string;
466
- /** @description Number of concurrent connections the client opens to the endpoint. */
467
- connections?: number;
468
- /** @description Target requests-per-second issued by the client. Zero means unthrottled. */
469
- rps?: number;
470
- /** @description HTTP request headers sent on each request. */
471
- headers?: {
472
- [key: string]: string;
473
- };
474
- /** @description HTTP request cookies sent on each request. */
475
- cookies?: {
476
- [key: string]: string;
477
- };
478
- /** @description Request body sent on each request. */
479
- body?: string;
480
- /** @description Content-Type header applied to the request body (e.g. "application/json"). */
481
- contentType?: string;
482
- /** @description Target endpoint URLs the client issues requests against. */
483
- endpointUrls: string[];
484
- /** @description PEM-encoded SSL certificate presented by the client, when required. */
485
- sslCertificate?: string;
486
- /** @description Additional load-generator-specific options passed through to the generator. */
487
- additionalOptions?: string;
488
- };
489
- };
490
- responses: {
491
- /** @description ok */
492
- 200: {
493
- headers: {
494
- [name: string]: unknown;
495
- };
496
- content: {
497
- "text/plain": string;
498
- };
1260
+ };
1261
+ /** Invalid request body or request param */
1262
+ 400: {
1263
+ content: {
1264
+ "text/plain": string;
499
1265
  };
500
- /** @description Invalid request body or request param */
501
- 400: {
502
- headers: {
503
- [name: string]: unknown;
504
- };
505
- content: {
506
- "text/plain": string;
507
- };
1266
+ };
1267
+ /** Expired JWT token used or insufficient privilege */
1268
+ 401: {
1269
+ content: {
1270
+ "text/plain": string;
508
1271
  };
509
- /** @description Expired JWT token used or insufficient privilege */
510
- 401: {
511
- headers: {
512
- [name: string]: unknown;
513
- };
514
- content: {
515
- "text/plain": string;
516
- };
517
- };
518
- /** @description Result not found */
519
- 404: {
520
- headers: {
521
- [name: string]: unknown;
522
- };
523
- content: {
524
- "text/plain": string;
525
- };
526
- };
527
- /** @description Internal server error */
528
- 500: {
529
- headers: {
530
- [name: string]: unknown;
531
- };
532
- content: {
533
- "text/plain": string;
534
- };
535
- };
536
- };
537
- parameters: {
538
- /** @description Performance profile ID. */
539
- performanceProfileId: string;
540
- /** @description Performance result ID. */
541
- resultId: string;
542
- /** @description Get responses that match search param value */
543
- search: string;
544
- /** @description Get ordered responses */
545
- order: string;
546
- /** @description Get responses by page */
547
- page: string;
548
- /** @description Get responses by pagesize */
549
- pagesize: string;
550
- /** @description Start date for filtering results by test start time, in YYYY-MM-DD format. */
551
- from: string;
552
- /** @description End date for filtering results by test start time, in YYYY-MM-DD format. */
553
- to: string;
554
- };
555
- requestBodies: {
556
- /** @description Body for creating or updating a performance profile. */
557
- performanceProfilePayload: {
558
- content: {
559
- "application/json": {
560
- /**
561
- * Format: uuid
562
- * @description Existing performance-profile ID for updates; omit on create.
563
- */
564
- id?: string;
565
- /** @description Human-readable name of the performance profile. */
566
- name: string;
567
- /**
568
- * Format: uuid
569
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
570
- */
571
- userId?: string;
572
- /**
573
- * Format: uuid
574
- * @description Optional schedule ID associating the profile with a recurring run.
575
- */
576
- schedule?: string | null;
577
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
578
- loadGenerators: string[];
579
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
580
- endpoints: string[];
581
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
582
- serviceMesh?: string;
583
- /** @description Number of concurrent requests issued by the load generator. */
584
- concurrentRequest?: number;
585
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
586
- qps?: number;
587
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
588
- duration: string;
589
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
590
- requestHeaders?: string;
591
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
592
- requestCookies?: string;
593
- /** @description HTTP request body sent on each load-test request. */
594
- requestBody?: string;
595
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
596
- contentType?: string;
597
- /** @description Free-form metadata associated with the performance profile. */
598
- metadata?: {
599
- [key: string]: unknown;
600
- };
601
- };
602
- };
603
- };
604
- };
605
- headers: never;
606
- pathItems: never;
607
- }
608
- export type $defs = Record<string, never>;
609
- export interface operations {
610
- getPerformanceProfiles: {
611
- parameters: {
612
- query?: {
613
- /** @description Get responses by page */
614
- page?: string;
615
- /** @description Get responses by pagesize */
616
- pagesize?: string;
617
- /** @description Get responses that match search param value */
618
- search?: string;
619
- /** @description Get ordered responses */
620
- order?: string;
621
- };
622
- header?: never;
623
- path?: never;
624
- cookie?: never;
625
- };
626
- requestBody?: never;
627
- responses: {
628
- /** @description Performance profiles */
629
- 200: {
630
- headers: {
631
- [name: string]: unknown;
632
- };
633
- content: {
634
- "application/json": {
635
- /** @description Zero-based page index returned in this response. */
636
- page: number;
637
- /** @description Maximum number of items returned on each page. */
638
- pageSize: number;
639
- /** @description Total number of performance profiles across all pages. */
640
- totalCount: number;
641
- /** @description Performance profiles in this page. */
642
- profiles: {
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?: {
682
- [key: string]: unknown;
683
- };
684
- /**
685
- * Format: date-time
686
- * @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.
687
- */
688
- lastRun?: string | null;
689
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
690
- totalResults?: number;
691
- /**
692
- * Format: date-time
693
- * @description Timestamp when the performance profile was created.
694
- */
695
- createdAt: string;
696
- /**
697
- * Format: date-time
698
- * @description Timestamp when the performance profile was last updated.
699
- */
700
- updatedAt: string;
701
- }[];
702
- };
703
- };
704
- };
705
- /** @description Invalid request body or request param */
706
- 400: {
707
- headers: {
708
- [name: string]: unknown;
709
- };
710
- content: {
711
- "text/plain": string;
712
- };
713
- };
714
- /** @description Expired JWT token used or insufficient privilege */
715
- 401: {
716
- headers: {
717
- [name: string]: unknown;
718
- };
719
- content: {
720
- "text/plain": string;
721
- };
722
- };
723
- /** @description Internal server error */
724
- 500: {
725
- headers: {
726
- [name: string]: unknown;
727
- };
728
- content: {
729
- "text/plain": string;
730
- };
731
- };
732
- };
733
- };
734
- upsertPerformanceProfile: {
735
- parameters: {
736
- query?: never;
737
- header?: never;
738
- path?: never;
739
- cookie?: never;
740
- };
741
- /** @description Body for creating or updating a performance profile. */
742
- requestBody: {
743
- content: {
744
- "application/json": {
745
- /**
746
- * Format: uuid
747
- * @description Existing performance-profile ID for updates; omit on create.
748
- */
749
- id?: string;
750
- /** @description Human-readable name of the performance profile. */
751
- name: string;
752
- /**
753
- * Format: uuid
754
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
755
- */
756
- userId?: string;
757
- /**
758
- * Format: uuid
759
- * @description Optional schedule ID associating the profile with a recurring run.
760
- */
761
- schedule?: string | null;
762
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
763
- loadGenerators: string[];
764
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
765
- endpoints: string[];
766
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
767
- serviceMesh?: string;
768
- /** @description Number of concurrent requests issued by the load generator. */
769
- concurrentRequest?: number;
770
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
771
- qps?: number;
772
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
773
- duration: string;
774
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
775
- requestHeaders?: string;
776
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
777
- requestCookies?: string;
778
- /** @description HTTP request body sent on each load-test request. */
779
- requestBody?: string;
780
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
781
- contentType?: string;
782
- /** @description Free-form metadata associated with the performance profile. */
783
- metadata?: {
784
- [key: string]: unknown;
785
- };
786
- };
787
- };
788
- };
789
- responses: {
790
- /** @description Performance profile upserted */
791
- 200: {
792
- headers: {
793
- [name: string]: unknown;
794
- };
795
- content: {
796
- "application/json": {
797
- /**
798
- * Format: uuid
799
- * @description Unique identifier for the performance profile.
800
- */
801
- id: string;
802
- /** @description Human-readable name of the performance profile. */
803
- name: string;
804
- /**
805
- * Format: uuid
806
- * @description User ID of the profile owner.
807
- */
808
- userId: string;
809
- /**
810
- * Format: uuid
811
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
812
- */
813
- schedule?: string | null;
814
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
815
- loadGenerators?: string[];
816
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
817
- endpoints?: string[];
818
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
819
- serviceMesh?: string;
820
- /** @description Number of concurrent requests issued by the load generator. */
821
- concurrentRequest?: number;
822
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
823
- qps?: number;
824
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
825
- duration?: string;
826
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
827
- requestHeaders?: string;
828
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
829
- requestCookies?: string;
830
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
831
- requestBody?: string;
832
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
833
- contentType?: string;
834
- /** @description Free-form metadata associated with the performance profile. */
835
- metadata?: {
836
- [key: string]: unknown;
837
- };
838
- /**
839
- * Format: date-time
840
- * @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.
841
- */
842
- lastRun?: string | null;
843
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
844
- totalResults?: number;
845
- /**
846
- * Format: date-time
847
- * @description Timestamp when the performance profile was created.
848
- */
849
- createdAt: string;
850
- /**
851
- * Format: date-time
852
- * @description Timestamp when the performance profile was last updated.
853
- */
854
- updatedAt: string;
855
- };
856
- };
857
- };
858
- /** @description Invalid request body or request param */
859
- 400: {
860
- headers: {
861
- [name: string]: unknown;
862
- };
863
- content: {
864
- "text/plain": string;
865
- };
866
- };
867
- /** @description Expired JWT token used or insufficient privilege */
868
- 401: {
869
- headers: {
870
- [name: string]: unknown;
871
- };
872
- content: {
873
- "text/plain": string;
874
- };
875
- };
876
- /** @description Internal server error */
877
- 500: {
878
- headers: {
879
- [name: string]: unknown;
880
- };
881
- content: {
882
- "text/plain": string;
883
- };
884
- };
885
- };
886
- };
887
- getPerformanceProfile: {
888
- parameters: {
889
- query?: never;
890
- header?: never;
891
- path: {
892
- /** @description Performance profile ID. */
893
- performanceProfileId: string;
894
- };
895
- cookie?: never;
896
- };
897
- requestBody?: never;
898
- responses: {
899
- /** @description Performance profile */
900
- 200: {
901
- headers: {
902
- [name: string]: unknown;
903
- };
904
- content: {
905
- "application/json": {
906
- /**
907
- * Format: uuid
908
- * @description Unique identifier for the performance profile.
909
- */
910
- id: string;
911
- /** @description Human-readable name of the performance profile. */
912
- name: string;
913
- /**
914
- * Format: uuid
915
- * @description User ID of the profile owner.
916
- */
917
- userId: string;
918
- /**
919
- * Format: uuid
920
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
921
- */
922
- schedule?: string | null;
923
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
924
- loadGenerators?: string[];
925
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
926
- endpoints?: string[];
927
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
928
- serviceMesh?: string;
929
- /** @description Number of concurrent requests issued by the load generator. */
930
- concurrentRequest?: number;
931
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
932
- qps?: number;
933
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
934
- duration?: string;
935
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
936
- requestHeaders?: string;
937
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
938
- requestCookies?: string;
939
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
940
- requestBody?: string;
941
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
942
- contentType?: string;
943
- /** @description Free-form metadata associated with the performance profile. */
944
- metadata?: {
945
- [key: string]: unknown;
946
- };
947
- /**
948
- * Format: date-time
949
- * @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.
950
- */
951
- lastRun?: string | null;
952
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
953
- totalResults?: number;
954
- /**
955
- * Format: date-time
956
- * @description Timestamp when the performance profile was created.
957
- */
958
- createdAt: string;
959
- /**
960
- * Format: date-time
961
- * @description Timestamp when the performance profile was last updated.
962
- */
963
- updatedAt: string;
964
- };
965
- };
966
- };
967
- /** @description Invalid request body or request param */
968
- 400: {
969
- headers: {
970
- [name: string]: unknown;
971
- };
972
- content: {
973
- "text/plain": string;
974
- };
975
- };
976
- /** @description Expired JWT token used or insufficient privilege */
977
- 401: {
978
- headers: {
979
- [name: string]: unknown;
980
- };
981
- content: {
982
- "text/plain": string;
983
- };
984
- };
985
- /** @description Result not found */
986
- 404: {
987
- headers: {
988
- [name: string]: unknown;
989
- };
990
- content: {
991
- "text/plain": string;
992
- };
993
- };
994
- /** @description Internal server error */
995
- 500: {
996
- headers: {
997
- [name: string]: unknown;
998
- };
999
- content: {
1000
- "text/plain": string;
1001
- };
1002
- };
1003
- };
1004
- };
1005
- updatePerformanceProfile: {
1006
- parameters: {
1007
- query?: never;
1008
- header?: never;
1009
- path: {
1010
- /** @description Performance profile ID. */
1011
- performanceProfileId: string;
1012
- };
1013
- cookie?: never;
1014
- };
1015
- /** @description Body for creating or updating a performance profile. */
1016
- requestBody: {
1017
- content: {
1018
- "application/json": {
1019
- /**
1020
- * Format: uuid
1021
- * @description Existing performance-profile ID for updates; omit on create.
1022
- */
1023
- id?: string;
1024
- /** @description Human-readable name of the performance profile. */
1025
- name: string;
1026
- /**
1027
- * Format: uuid
1028
- * @description Owner user ID. When omitted, the server infers it from the authenticated user.
1029
- */
1030
- userId?: string;
1031
- /**
1032
- * Format: uuid
1033
- * @description Optional schedule ID associating the profile with a recurring run.
1034
- */
1035
- schedule?: string | null;
1036
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
1037
- loadGenerators: string[];
1038
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
1039
- endpoints: string[];
1040
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
1041
- serviceMesh?: string;
1042
- /** @description Number of concurrent requests issued by the load generator. */
1043
- concurrentRequest?: number;
1044
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
1045
- qps?: number;
1046
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
1047
- duration: string;
1048
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. */
1049
- requestHeaders?: string;
1050
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. */
1051
- requestCookies?: string;
1052
- /** @description HTTP request body sent on each load-test request. */
1053
- requestBody?: string;
1054
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). */
1055
- contentType?: string;
1056
- /** @description Free-form metadata associated with the performance profile. */
1057
- metadata?: {
1058
- [key: string]: unknown;
1059
- };
1060
- };
1061
- };
1062
- };
1063
- responses: {
1064
- /** @description Performance profile */
1065
- 200: {
1066
- headers: {
1067
- [name: string]: unknown;
1068
- };
1069
- content: {
1070
- "application/json": {
1071
- /**
1072
- * Format: uuid
1073
- * @description Unique identifier for the performance profile.
1074
- */
1075
- id: string;
1076
- /** @description Human-readable name of the performance profile. */
1077
- name: string;
1078
- /**
1079
- * Format: uuid
1080
- * @description User ID of the profile owner.
1081
- */
1082
- userId: string;
1083
- /**
1084
- * Format: uuid
1085
- * @description Optional schedule ID associated with this performance profile. Null when the profile is not bound to a recurring schedule.
1086
- */
1087
- schedule?: string | null;
1088
- /** @description Load generators (e.g. fortio, wrk2, nighthawk) to drive the profile's load test. */
1089
- loadGenerators?: string[];
1090
- /** @description Endpoints (URLs) targeted by the performance profile's load test. */
1091
- endpoints?: string[];
1092
- /** @description Service mesh under test for the profile (e.g. istio, linkerd, consul). Empty string when the profile is mesh-agnostic. */
1093
- serviceMesh?: string;
1094
- /** @description Number of concurrent requests issued by the load generator. */
1095
- concurrentRequest?: number;
1096
- /** @description Target queries-per-second rate for the load generator. Zero indicates the generator runs unthrottled. */
1097
- qps?: number;
1098
- /** @description Duration of the load test, expressed as a Go duration string (e.g. "30s", "5m", "1h"). */
1099
- duration?: string;
1100
- /** @description HTTP request headers, serialized as JSON, sent on each load-test request. Empty string when no headers are configured. */
1101
- requestHeaders?: string;
1102
- /** @description HTTP request cookies, serialized as JSON, sent on each load-test request. Empty string when no cookies are configured. */
1103
- requestCookies?: string;
1104
- /** @description HTTP request body sent on each load-test request. Empty string when no body is configured. */
1105
- requestBody?: string;
1106
- /** @description Content-Type header value applied to each load-test request body (e.g. "application/json"). Empty string when no body is configured. */
1107
- contentType?: string;
1108
- /** @description Free-form metadata associated with the performance profile. */
1109
- metadata?: {
1110
- [key: string]: unknown;
1111
- };
1112
- /**
1113
- * Format: date-time
1114
- * @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.
1115
- */
1116
- lastRun?: string | null;
1117
- /** @description Server-computed count of load-test results recorded for this profile. Server-managed; clients must not set this on create/update. */
1118
- totalResults?: number;
1119
- /**
1120
- * Format: date-time
1121
- * @description Timestamp when the performance profile was created.
1122
- */
1123
- createdAt: string;
1124
- /**
1125
- * Format: date-time
1126
- * @description Timestamp when the performance profile was last updated.
1127
- */
1128
- updatedAt: string;
1129
- };
1130
- };
1131
- };
1132
- /** @description Invalid request body or request param */
1133
- 400: {
1134
- headers: {
1135
- [name: string]: unknown;
1136
- };
1137
- content: {
1138
- "text/plain": string;
1139
- };
1140
- };
1141
- /** @description Expired JWT token used or insufficient privilege */
1142
- 401: {
1143
- headers: {
1144
- [name: string]: unknown;
1145
- };
1146
- content: {
1147
- "text/plain": string;
1148
- };
1149
- };
1150
- /** @description Result not found */
1151
- 404: {
1152
- headers: {
1153
- [name: string]: unknown;
1154
- };
1155
- content: {
1156
- "text/plain": string;
1157
- };
1158
- };
1159
- /** @description Internal server error */
1160
- 500: {
1161
- headers: {
1162
- [name: string]: unknown;
1163
- };
1164
- content: {
1165
- "text/plain": string;
1166
- };
1167
- };
1168
- };
1169
- };
1170
- deletePerformanceProfile: {
1171
- parameters: {
1172
- query?: never;
1173
- header?: never;
1174
- path: {
1175
- /** @description Performance profile ID. */
1176
- performanceProfileId: string;
1177
- };
1178
- cookie?: never;
1179
- };
1180
- requestBody?: never;
1181
- responses: {
1182
- /** @description Performance profile deleted */
1183
- 204: {
1184
- headers: {
1185
- [name: string]: unknown;
1186
- };
1187
- content?: never;
1188
- };
1189
- /** @description Invalid request body or request param */
1190
- 400: {
1191
- headers: {
1192
- [name: string]: unknown;
1193
- };
1194
- content: {
1195
- "text/plain": string;
1196
- };
1197
- };
1198
- /** @description Expired JWT token used or insufficient privilege */
1199
- 401: {
1200
- headers: {
1201
- [name: string]: unknown;
1202
- };
1203
- content: {
1204
- "text/plain": string;
1205
- };
1206
- };
1207
- /** @description Result not found */
1208
- 404: {
1209
- headers: {
1210
- [name: string]: unknown;
1211
- };
1212
- content: {
1213
- "text/plain": string;
1214
- };
1215
- };
1216
- /** @description Internal server error */
1217
- 500: {
1218
- headers: {
1219
- [name: string]: unknown;
1220
- };
1221
- content: {
1222
- "text/plain": string;
1223
- };
1224
- };
1225
- };
1226
- };
1227
- getPerformanceProfileResults: {
1228
- parameters: {
1229
- query?: {
1230
- /** @description Get responses by page */
1231
- page?: string;
1232
- /** @description Get responses by pagesize */
1233
- pagesize?: string;
1234
- /** @description Get responses that match search param value */
1235
- search?: string;
1236
- /** @description Get ordered responses */
1237
- order?: string;
1238
- };
1239
- header?: never;
1240
- path: {
1241
- /** @description Performance profile ID. */
1242
- performanceProfileId: string;
1243
- };
1244
- cookie?: never;
1245
- };
1246
- requestBody?: never;
1247
- responses: {
1248
- /** @description Performance results */
1249
- 200: {
1250
- headers: {
1251
- [name: string]: unknown;
1252
- };
1253
- content: {
1254
- "application/json": {
1255
- /** @description Zero-based page index returned in this response. */
1256
- page: number;
1257
- /** @description Maximum number of items returned on each page. */
1258
- pageSize: number;
1259
- /** @description Total number of performance results across all pages. */
1260
- totalCount: number;
1261
- /** @description Performance results in this page. */
1262
- results: {
1263
- /**
1264
- * Format: uuid
1265
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1266
- */
1267
- mesheryId?: string;
1268
- /** @description Human-readable name of the performance result. */
1269
- name?: string;
1270
- /** @description Service mesh under test for this result. */
1271
- mesh?: string;
1272
- /**
1273
- * Format: uuid
1274
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1275
- */
1276
- performanceProfile?: string | null;
1277
- /** @description Provider-assigned test identifier for this result. */
1278
- testId?: string;
1279
- /** @description Raw load-generator output for this performance result. */
1280
- runnerResults?: {
1281
- [key: string]: unknown;
1282
- };
1283
- /** @description Server-side metrics collected for this performance result. */
1284
- serverMetrics?: {
1285
- [key: string]: unknown;
1286
- };
1287
- /** @description Server board configuration associated with this performance result. */
1288
- serverBoardConfig?: {
1289
- [key: string]: unknown;
1290
- };
1291
- /**
1292
- * Format: date-time
1293
- * @description Time when the load test started.
1294
- */
1295
- testStartTime?: string;
1296
- /**
1297
- * Format: uuid
1298
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1299
- */
1300
- userId?: string;
1301
- /**
1302
- * Format: date-time
1303
- * @description Timestamp when the performance result was created.
1304
- */
1305
- createdAt?: string;
1306
- /**
1307
- * Format: date-time
1308
- * @description Timestamp when the performance result was last updated.
1309
- */
1310
- updatedAt?: string;
1311
- }[];
1312
- };
1313
- };
1314
- };
1315
- /** @description Invalid request body or request param */
1316
- 400: {
1317
- headers: {
1318
- [name: string]: unknown;
1319
- };
1320
- content: {
1321
- "text/plain": string;
1322
- };
1323
- };
1324
- /** @description Expired JWT token used or insufficient privilege */
1325
- 401: {
1326
- headers: {
1327
- [name: string]: unknown;
1328
- };
1329
- content: {
1330
- "text/plain": string;
1331
- };
1332
- };
1333
- /** @description Result not found */
1334
- 404: {
1335
- headers: {
1336
- [name: string]: unknown;
1337
- };
1338
- content: {
1339
- "text/plain": string;
1340
- };
1341
- };
1342
- /** @description Internal server error */
1343
- 500: {
1344
- headers: {
1345
- [name: string]: unknown;
1346
- };
1347
- content: {
1348
- "text/plain": string;
1349
- };
1350
- };
1351
- };
1352
- };
1353
- getPerformanceProfileResult: {
1354
- parameters: {
1355
- query?: never;
1356
- header?: never;
1357
- path: {
1358
- /** @description Performance profile ID. */
1359
- performanceProfileId: string;
1360
- /** @description Performance result ID. */
1361
- resultId: string;
1362
- };
1363
- cookie?: never;
1364
- };
1365
- requestBody?: never;
1366
- responses: {
1367
- /** @description Performance result */
1368
- 200: {
1369
- headers: {
1370
- [name: string]: unknown;
1371
- };
1372
- content: {
1373
- "application/json": {
1374
- /**
1375
- * Format: uuid
1376
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1377
- */
1378
- mesheryId?: string;
1379
- /** @description Human-readable name of the performance result. */
1380
- name?: string;
1381
- /** @description Service mesh under test for this result. */
1382
- mesh?: string;
1383
- /**
1384
- * Format: uuid
1385
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1386
- */
1387
- performanceProfile?: string | null;
1388
- /** @description Provider-assigned test identifier for this result. */
1389
- testId?: string;
1390
- /** @description Raw load-generator output for this performance result. */
1391
- runnerResults?: {
1392
- [key: string]: unknown;
1393
- };
1394
- /** @description Server-side metrics collected for this performance result. */
1395
- serverMetrics?: {
1396
- [key: string]: unknown;
1397
- };
1398
- /** @description Server board configuration associated with this performance result. */
1399
- serverBoardConfig?: {
1400
- [key: string]: unknown;
1401
- };
1402
- /**
1403
- * Format: date-time
1404
- * @description Time when the load test started.
1405
- */
1406
- testStartTime?: string;
1407
- /**
1408
- * Format: uuid
1409
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1410
- */
1411
- userId?: string;
1412
- /**
1413
- * Format: date-time
1414
- * @description Timestamp when the performance result was created.
1415
- */
1416
- createdAt?: string;
1417
- /**
1418
- * Format: date-time
1419
- * @description Timestamp when the performance result was last updated.
1420
- */
1421
- updatedAt?: string;
1422
- };
1423
- };
1424
- };
1425
- /** @description Invalid request body or request param */
1426
- 400: {
1427
- headers: {
1428
- [name: string]: unknown;
1429
- };
1430
- content: {
1431
- "text/plain": string;
1432
- };
1433
- };
1434
- /** @description Expired JWT token used or insufficient privilege */
1435
- 401: {
1436
- headers: {
1437
- [name: string]: unknown;
1438
- };
1439
- content: {
1440
- "text/plain": string;
1441
- };
1442
- };
1443
- /** @description Result not found */
1444
- 404: {
1445
- headers: {
1446
- [name: string]: unknown;
1447
- };
1448
- content: {
1449
- "text/plain": string;
1450
- };
1451
- };
1452
- /** @description Internal server error */
1453
- 500: {
1454
- headers: {
1455
- [name: string]: unknown;
1456
- };
1457
- content: {
1458
- "text/plain": string;
1459
- };
1460
- };
1461
- };
1462
- };
1463
- getPerformanceResults: {
1464
- parameters: {
1465
- query?: {
1466
- /** @description Get responses by page */
1467
- page?: string;
1468
- /** @description Get responses by pagesize */
1469
- pagesize?: string;
1470
- /** @description Get responses that match search param value */
1471
- search?: string;
1472
- /** @description Get ordered responses */
1473
- order?: string;
1474
- /** @description Start date for filtering results by test start time, in YYYY-MM-DD format. */
1475
- from?: string;
1476
- /** @description End date for filtering results by test start time, in YYYY-MM-DD format. */
1477
- to?: string;
1478
- };
1479
- header?: never;
1480
- path?: never;
1481
- cookie?: never;
1482
- };
1483
- requestBody?: never;
1484
- responses: {
1485
- /** @description Performance results */
1486
- 200: {
1487
- headers: {
1488
- [name: string]: unknown;
1489
- };
1490
- content: {
1491
- "application/json": {
1492
- /** @description Zero-based page index returned in this response. */
1493
- page: number;
1494
- /** @description Maximum number of items returned on each page. */
1495
- pageSize: number;
1496
- /** @description Total number of performance results across all pages. */
1497
- totalCount: number;
1498
- /** @description Performance results in this page. */
1499
- results: {
1500
- /**
1501
- * Format: uuid
1502
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1503
- */
1504
- mesheryId?: string;
1505
- /** @description Human-readable name of the performance result. */
1506
- name?: string;
1507
- /** @description Service mesh under test for this result. */
1508
- mesh?: string;
1509
- /**
1510
- * Format: uuid
1511
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1512
- */
1513
- performanceProfile?: string | null;
1514
- /** @description Provider-assigned test identifier for this result. */
1515
- testId?: string;
1516
- /** @description Raw load-generator output for this performance result. */
1517
- runnerResults?: {
1518
- [key: string]: unknown;
1519
- };
1520
- /** @description Server-side metrics collected for this performance result. */
1521
- serverMetrics?: {
1522
- [key: string]: unknown;
1523
- };
1524
- /** @description Server board configuration associated with this performance result. */
1525
- serverBoardConfig?: {
1526
- [key: string]: unknown;
1527
- };
1528
- /**
1529
- * Format: date-time
1530
- * @description Time when the load test started.
1531
- */
1532
- testStartTime?: string;
1533
- /**
1534
- * Format: uuid
1535
- * @description A Universally Unique Identifier used to uniquely identify entities in Meshery. The UUID core definition is used across different schemas.
1536
- */
1537
- userId?: string;
1538
- /**
1539
- * Format: date-time
1540
- * @description Timestamp when the performance result was created.
1541
- */
1542
- createdAt?: string;
1543
- /**
1544
- * Format: date-time
1545
- * @description Timestamp when the performance result was last updated.
1546
- */
1547
- updatedAt?: string;
1548
- }[];
1549
- };
1550
- };
1551
- };
1552
- /** @description Invalid request body or request param */
1553
- 400: {
1554
- headers: {
1555
- [name: string]: unknown;
1556
- };
1557
- content: {
1558
- "text/plain": string;
1559
- };
1560
- };
1561
- /** @description Expired JWT token used or insufficient privilege */
1562
- 401: {
1563
- headers: {
1564
- [name: string]: unknown;
1565
- };
1566
- content: {
1567
- "text/plain": string;
1568
- };
1569
- };
1570
- /** @description Internal server error */
1571
- 500: {
1572
- headers: {
1573
- [name: string]: unknown;
1574
- };
1575
- content: {
1576
- "text/plain": string;
1577
- };
1578
- };
1272
+ };
1273
+ /** Internal server error */
1274
+ 500: {
1275
+ content: {
1276
+ "text/plain": string;
1579
1277
  };
1278
+ };
1580
1279
  };
1280
+ };
1581
1281
  }
1282
+
1283
+ export interface external {}