@meshery/schemas 1.2.15 → 1.2.16

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