@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.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 (235) hide show
  1. package/dist/generator/openapi-parser.d.ts +418 -0
  2. package/dist/generator/openapi-parser.d.ts.map +1 -1
  3. package/dist/generator/openapi-parser.js +132 -0
  4. package/dist/generator/openapi-parser.js.map +1 -1
  5. package/dist/generator/tool-generator.d.ts +29 -1
  6. package/dist/generator/tool-generator.d.ts.map +1 -1
  7. package/dist/generator/tool-generator.js +150 -7
  8. package/dist/generator/tool-generator.js.map +1 -1
  9. package/dist/tools/discovery/describe.d.ts +1 -0
  10. package/dist/tools/discovery/describe.d.ts.map +1 -1
  11. package/dist/tools/discovery/describe.js +10 -8
  12. package/dist/tools/discovery/describe.js.map +1 -1
  13. package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
  14. package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
  15. package/dist/tools/generated/admin_console_and_ui/index.js +285 -0
  16. package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
  17. package/dist/tools/generated/api/index.d.ts +8 -0
  18. package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
  19. package/dist/tools/generated/api/index.js +6668 -0
  20. package/dist/tools/generated/api/index.js.map +1 -0
  21. package/dist/tools/generated/authentication/index.d.ts +8 -0
  22. package/dist/tools/generated/authentication/index.d.ts.map +1 -0
  23. package/dist/tools/generated/authentication/index.js +1005 -0
  24. package/dist/tools/generated/authentication/index.js.map +1 -0
  25. package/dist/tools/generated/bigip/index.d.ts.map +1 -1
  26. package/dist/tools/generated/bigip/index.js +2045 -0
  27. package/dist/tools/generated/bigip/index.js.map +1 -1
  28. package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
  29. package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
  30. package/dist/tools/generated/billing_and_usage/index.js +2702 -0
  31. package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
  32. package/dist/tools/generated/blindfold/index.d.ts +8 -0
  33. package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
  34. package/dist/tools/generated/blindfold/index.js +3998 -0
  35. package/dist/tools/generated/blindfold/index.js.map +1 -0
  36. package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
  37. package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
  38. package/dist/tools/generated/bot_and_threat_defense/index.js +2584 -0
  39. package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
  40. package/dist/tools/generated/cdn/index.d.ts.map +1 -1
  41. package/dist/tools/generated/cdn/index.js +1904 -0
  42. package/dist/tools/generated/cdn/index.js.map +1 -1
  43. package/dist/tools/generated/ce_management/index.d.ts +8 -0
  44. package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
  45. package/dist/tools/generated/ce_management/index.js +3963 -0
  46. package/dist/tools/generated/ce_management/index.js.map +1 -0
  47. package/dist/tools/generated/certificates/index.d.ts +8 -0
  48. package/dist/tools/generated/certificates/index.d.ts.map +1 -0
  49. package/dist/tools/generated/certificates/index.js +2579 -0
  50. package/dist/tools/generated/certificates/index.js.map +1 -0
  51. package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
  52. package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
  53. package/dist/tools/generated/cloud_infrastructure/index.js +4124 -0
  54. package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
  55. package/dist/tools/generated/container_services/index.d.ts +8 -0
  56. package/dist/tools/generated/container_services/index.d.ts.map +1 -0
  57. package/dist/tools/generated/container_services/index.js +2054 -0
  58. package/dist/tools/generated/container_services/index.js.map +1 -0
  59. package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
  60. package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
  61. package/dist/tools/generated/data_and_privacy_security/index.js +1708 -0
  62. package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
  63. package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
  64. package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
  65. package/dist/tools/generated/data_intelligence/index.js +1770 -0
  66. package/dist/tools/generated/data_intelligence/index.js.map +1 -0
  67. package/dist/tools/generated/ddos/index.d.ts +8 -0
  68. package/dist/tools/generated/ddos/index.d.ts.map +1 -0
  69. package/dist/tools/generated/ddos/index.js +8511 -0
  70. package/dist/tools/generated/ddos/index.js.map +1 -0
  71. package/dist/tools/generated/dns/index.d.ts +8 -0
  72. package/dist/tools/generated/dns/index.d.ts.map +1 -0
  73. package/dist/tools/generated/dns/index.js +6460 -0
  74. package/dist/tools/generated/dns/index.js.map +1 -0
  75. package/dist/tools/generated/generative_ai/index.d.ts +8 -0
  76. package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
  77. package/dist/tools/generated/generative_ai/index.js +1215 -0
  78. package/dist/tools/generated/generative_ai/index.js.map +1 -0
  79. package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
  80. package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
  81. package/dist/tools/generated/managed_kubernetes/index.js +3233 -0
  82. package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
  83. package/dist/tools/generated/marketplace/index.d.ts +8 -0
  84. package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
  85. package/dist/tools/generated/marketplace/index.js +4580 -0
  86. package/dist/tools/generated/marketplace/index.js.map +1 -0
  87. package/dist/tools/generated/network/index.d.ts +8 -0
  88. package/dist/tools/generated/network/index.d.ts.map +1 -0
  89. package/dist/tools/generated/network/index.js +12616 -0
  90. package/dist/tools/generated/network/index.js.map +1 -0
  91. package/dist/tools/generated/network_security/index.d.ts +8 -0
  92. package/dist/tools/generated/network_security/index.d.ts.map +1 -0
  93. package/dist/tools/generated/network_security/index.js +8884 -0
  94. package/dist/tools/generated/network_security/index.js.map +1 -0
  95. package/dist/tools/generated/nginx_one/index.d.ts +8 -0
  96. package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
  97. package/dist/tools/generated/nginx_one/index.js +1820 -0
  98. package/dist/tools/generated/nginx_one/index.js.map +1 -0
  99. package/dist/tools/generated/object_storage/index.d.ts +8 -0
  100. package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
  101. package/dist/tools/generated/object_storage/index.js +1055 -0
  102. package/dist/tools/generated/object_storage/index.js.map +1 -0
  103. package/dist/tools/generated/observability/index.d.ts.map +1 -1
  104. package/dist/tools/generated/observability/index.js +4243 -4618
  105. package/dist/tools/generated/observability/index.js.map +1 -1
  106. package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
  107. package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
  108. package/dist/tools/generated/rate_limiting/index.js +1937 -0
  109. package/dist/tools/generated/rate_limiting/index.js.map +1 -0
  110. package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
  111. package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
  112. package/dist/tools/generated/secops_and_incident_response/index.js +653 -0
  113. package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
  114. package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
  115. package/dist/tools/generated/service_mesh/index.js +4532 -438
  116. package/dist/tools/generated/service_mesh/index.js.map +1 -1
  117. package/dist/tools/generated/shape/index.d.ts +8 -0
  118. package/dist/tools/generated/shape/index.d.ts.map +1 -0
  119. package/dist/tools/generated/shape/index.js +21784 -0
  120. package/dist/tools/generated/shape/index.js.map +1 -0
  121. package/dist/tools/generated/sites/index.d.ts +8 -0
  122. package/dist/tools/generated/sites/index.d.ts.map +1 -0
  123. package/dist/tools/generated/sites/index.js +13252 -0
  124. package/dist/tools/generated/sites/index.js.map +1 -0
  125. package/dist/tools/generated/statistics/index.d.ts +8 -0
  126. package/dist/tools/generated/statistics/index.d.ts.map +1 -0
  127. package/dist/tools/generated/statistics/index.js +8837 -0
  128. package/dist/tools/generated/statistics/index.js.map +1 -0
  129. package/dist/tools/generated/support/index.d.ts +8 -0
  130. package/dist/tools/generated/support/index.d.ts.map +1 -0
  131. package/dist/tools/generated/support/index.js +6215 -0
  132. package/dist/tools/generated/support/index.js.map +1 -0
  133. package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
  134. package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
  135. package/dist/tools/generated/telemetry_and_insights/index.js +2773 -0
  136. package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
  137. package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
  138. package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
  139. package/dist/tools/generated/tenant_and_identity/index.js +20456 -0
  140. package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
  141. package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
  142. package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
  143. package/dist/tools/generated/threat_campaign/index.js +112 -0
  144. package/dist/tools/generated/threat_campaign/index.js.map +1 -0
  145. package/dist/tools/generated/users/index.d.ts +8 -0
  146. package/dist/tools/generated/users/index.d.ts.map +1 -0
  147. package/dist/tools/generated/users/index.js +1572 -0
  148. package/dist/tools/generated/users/index.js.map +1 -0
  149. package/dist/tools/generated/virtual/index.d.ts +8 -0
  150. package/dist/tools/generated/virtual/index.d.ts.map +1 -0
  151. package/dist/tools/generated/virtual/index.js +11540 -0
  152. package/dist/tools/generated/virtual/index.js.map +1 -0
  153. package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
  154. package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
  155. package/dist/tools/generated/vpm_and_node_management/index.js +98 -0
  156. package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
  157. package/dist/tools/generated/waf/index.d.ts +8 -0
  158. package/dist/tools/generated/waf/index.d.ts.map +1 -0
  159. package/dist/tools/generated/waf/index.js +4440 -0
  160. package/dist/tools/generated/waf/index.js.map +1 -0
  161. package/dist/tools/registry.d.ts.map +1 -1
  162. package/dist/tools/registry.js +68 -36
  163. package/dist/tools/registry.js.map +1 -1
  164. package/package.json +3 -1
  165. package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
  166. package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
  167. package/dist/tools/generated/ai_intelligence/index.js +0 -282
  168. package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
  169. package/dist/tools/generated/api_security/index.d.ts +0 -8
  170. package/dist/tools/generated/api_security/index.d.ts.map +0 -1
  171. package/dist/tools/generated/api_security/index.js +0 -1852
  172. package/dist/tools/generated/api_security/index.js.map +0 -1
  173. package/dist/tools/generated/applications/index.d.ts +0 -8
  174. package/dist/tools/generated/applications/index.d.ts.map +0 -1
  175. package/dist/tools/generated/applications/index.js +0 -1589
  176. package/dist/tools/generated/applications/index.js.map +0 -1
  177. package/dist/tools/generated/billing/index.d.ts +0 -8
  178. package/dist/tools/generated/billing/index.d.ts.map +0 -1
  179. package/dist/tools/generated/billing/index.js +0 -759
  180. package/dist/tools/generated/billing/index.js.map +0 -1
  181. package/dist/tools/generated/config/index.d.ts +0 -8
  182. package/dist/tools/generated/config/index.d.ts.map +0 -1
  183. package/dist/tools/generated/config/index.js +0 -316
  184. package/dist/tools/generated/config/index.js.map +0 -1
  185. package/dist/tools/generated/identity/index.d.ts +0 -8
  186. package/dist/tools/generated/identity/index.d.ts.map +0 -1
  187. package/dist/tools/generated/identity/index.js +0 -5371
  188. package/dist/tools/generated/identity/index.js.map +0 -1
  189. package/dist/tools/generated/infrastructure/index.d.ts +0 -8
  190. package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
  191. package/dist/tools/generated/infrastructure/index.js +0 -5342
  192. package/dist/tools/generated/infrastructure/index.js.map +0 -1
  193. package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
  194. package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
  195. package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
  196. package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
  197. package/dist/tools/generated/integrations/index.d.ts +0 -8
  198. package/dist/tools/generated/integrations/index.d.ts.map +0 -1
  199. package/dist/tools/generated/integrations/index.js +0 -1995
  200. package/dist/tools/generated/integrations/index.js.map +0 -1
  201. package/dist/tools/generated/load_balancer/index.d.ts +0 -8
  202. package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
  203. package/dist/tools/generated/load_balancer/index.js +0 -2269
  204. package/dist/tools/generated/load_balancer/index.js.map +0 -1
  205. package/dist/tools/generated/networking/index.d.ts +0 -8
  206. package/dist/tools/generated/networking/index.d.ts.map +0 -1
  207. package/dist/tools/generated/networking/index.js +0 -11289
  208. package/dist/tools/generated/networking/index.js.map +0 -1
  209. package/dist/tools/generated/nginx/index.d.ts +0 -8
  210. package/dist/tools/generated/nginx/index.d.ts.map +0 -1
  211. package/dist/tools/generated/nginx/index.js +0 -680
  212. package/dist/tools/generated/nginx/index.js.map +0 -1
  213. package/dist/tools/generated/operations/index.d.ts +0 -8
  214. package/dist/tools/generated/operations/index.d.ts.map +0 -1
  215. package/dist/tools/generated/operations/index.js +0 -1759
  216. package/dist/tools/generated/operations/index.js.map +0 -1
  217. package/dist/tools/generated/security/index.d.ts +0 -8
  218. package/dist/tools/generated/security/index.d.ts.map +0 -1
  219. package/dist/tools/generated/security/index.js +0 -9111
  220. package/dist/tools/generated/security/index.js.map +0 -1
  221. package/dist/tools/generated/shape_security/index.d.ts +0 -8
  222. package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
  223. package/dist/tools/generated/shape_security/index.js +0 -4121
  224. package/dist/tools/generated/shape_security/index.js.map +0 -1
  225. package/dist/tools/generated/subscriptions/index.d.ts +0 -8
  226. package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
  227. package/dist/tools/generated/subscriptions/index.js +0 -778
  228. package/dist/tools/generated/subscriptions/index.js.map +0 -1
  229. package/dist/tools/generated/tenant_management/index.d.ts +0 -8
  230. package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
  231. package/dist/tools/generated/tenant_management/index.js +0 -2292
  232. package/dist/tools/generated/tenant_management/index.js.map +0 -1
  233. package/dist/tools/generated/vpn/index.d.ts +0 -8
  234. package/dist/tools/generated/vpn/index.js +0 -1183
  235. package/dist/tools/generated/vpn/index.js.map +0 -1
@@ -0,0 +1,1770 @@
1
+ /**
2
+ * Generated tool definitions for data_intelligence domain
3
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
4
+ */
5
+ export const data_intelligenceTools = [
6
+ {
7
+ toolName: "f5xc-api-dataintelligence-datadictionary-list",
8
+ method: "GET",
9
+ path: "/api/data-intelligence/namespaces/system/datadictionary/{dataset}",
10
+ operation: "list",
11
+ domain: "data_intelligence",
12
+ resource: "datadictionary",
13
+ summary: "GET Data Dictionary.",
14
+ description: "GET the dataset features from Data dictionary API.",
15
+ pathParameters: [
16
+ {
17
+ description: "Dataset\nidentifier to request the dataset features.",
18
+ in: "path",
19
+ name: "dataset",
20
+ required: true,
21
+ schema: {
22
+ type: "string",
23
+ },
24
+ "x-displayname": "Dataset",
25
+ "x-ves-example": "Di_advanced.",
26
+ },
27
+ ],
28
+ queryParameters: [],
29
+ requestBodySchema: null,
30
+ responseSchema: {
31
+ $ref: "#/components/schemas/data_deliveryGetDataDictionaryResponse",
32
+ },
33
+ requiredParams: ["dataset"],
34
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.GetDataDictionary",
35
+ tags: ["Other"],
36
+ sourceFile: "domains/data_intelligence.json",
37
+ displayName: null,
38
+ dangerLevel: "low",
39
+ sideEffects: null,
40
+ requiredFields: ["path.dataset"],
41
+ cliExamples: [
42
+ {
43
+ command: "f5xcctl data-intelligence datadictionary list --namespace {namespace}",
44
+ description: "List all datadictionarys",
45
+ use_case: "list_all",
46
+ },
47
+ ],
48
+ confirmationRequired: false,
49
+ parameterExamples: {
50
+ dataset: "Di_advanced.",
51
+ },
52
+ validationRules: {},
53
+ operationMetadata: {
54
+ common_errors: [
55
+ {
56
+ code: 401,
57
+ message: "Authentication required",
58
+ solution: "Provide valid API credentials",
59
+ },
60
+ {
61
+ code: 403,
62
+ message: "Permission denied",
63
+ solution: "Check access permissions for this operation",
64
+ },
65
+ {
66
+ code: 404,
67
+ message: "Resource not found",
68
+ solution: "Verify resource name, namespace, and path",
69
+ },
70
+ {
71
+ code: 409,
72
+ message: "Resource already exists",
73
+ solution: "Use different name or update existing resource",
74
+ },
75
+ {
76
+ code: 429,
77
+ message: "Rate limit exceeded",
78
+ solution: "Wait before retrying the operation",
79
+ },
80
+ {
81
+ code: 500,
82
+ message: "Server error",
83
+ solution: "Retry operation or contact support",
84
+ },
85
+ ],
86
+ conditions: {
87
+ postconditions: [],
88
+ prerequisites: ["Active namespace"],
89
+ },
90
+ confirmation_required: false,
91
+ danger_level: "low",
92
+ examples: [
93
+ {
94
+ command: "f5xcctl data-intelligence datadictionary list --namespace {namespace}",
95
+ description: "List all datadictionarys",
96
+ use_case: "list_all",
97
+ },
98
+ ],
99
+ field_docs: {},
100
+ optional_fields: [],
101
+ performance_impact: {
102
+ latency: "low",
103
+ resource_usage: "low",
104
+ },
105
+ purpose: "List all datadictionarys",
106
+ required_fields: ["path.dataset"],
107
+ side_effects: {},
108
+ },
109
+ },
110
+ {
111
+ toolName: "f5xc-api-dataintelligence-dataset-list",
112
+ method: "GET",
113
+ path: "/api/data-intelligence/namespaces/system/dataSets",
114
+ operation: "list",
115
+ domain: "data_intelligence",
116
+ resource: "dataSet",
117
+ summary: "GET Data Sets.",
118
+ description: "GET the list of data sets eligible for the tenant.",
119
+ pathParameters: [],
120
+ queryParameters: [],
121
+ requestBodySchema: null,
122
+ responseSchema: {
123
+ $ref: "#/components/schemas/data_deliveryGetDataSetsResponse",
124
+ },
125
+ requiredParams: [],
126
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.GetDataSets",
127
+ tags: ["Other"],
128
+ sourceFile: "domains/data_intelligence.json",
129
+ displayName: null,
130
+ dangerLevel: "low",
131
+ sideEffects: null,
132
+ requiredFields: [],
133
+ cliExamples: [
134
+ {
135
+ command: "f5xcctl data-intelligence dataSet list --namespace {namespace}",
136
+ description: "List all dataSets",
137
+ use_case: "list_all",
138
+ },
139
+ ],
140
+ confirmationRequired: false,
141
+ parameterExamples: {},
142
+ validationRules: {},
143
+ operationMetadata: {
144
+ common_errors: [
145
+ {
146
+ code: 401,
147
+ message: "Authentication required",
148
+ solution: "Provide valid API credentials",
149
+ },
150
+ {
151
+ code: 403,
152
+ message: "Permission denied",
153
+ solution: "Check access permissions for this operation",
154
+ },
155
+ {
156
+ code: 404,
157
+ message: "Resource not found",
158
+ solution: "Verify resource name, namespace, and path",
159
+ },
160
+ {
161
+ code: 409,
162
+ message: "Resource already exists",
163
+ solution: "Use different name or update existing resource",
164
+ },
165
+ {
166
+ code: 429,
167
+ message: "Rate limit exceeded",
168
+ solution: "Wait before retrying the operation",
169
+ },
170
+ {
171
+ code: 500,
172
+ message: "Server error",
173
+ solution: "Retry operation or contact support",
174
+ },
175
+ ],
176
+ conditions: {
177
+ postconditions: [],
178
+ prerequisites: ["Active namespace"],
179
+ },
180
+ confirmation_required: false,
181
+ danger_level: "low",
182
+ examples: [
183
+ {
184
+ command: "f5xcctl data-intelligence dataSet list --namespace {namespace}",
185
+ description: "List all dataSets",
186
+ use_case: "list_all",
187
+ },
188
+ ],
189
+ field_docs: {},
190
+ optional_fields: [],
191
+ performance_impact: {
192
+ latency: "moderate",
193
+ resource_usage: "moderate",
194
+ },
195
+ purpose: "List all dataSets",
196
+ required_fields: [],
197
+ side_effects: {},
198
+ },
199
+ },
200
+ {
201
+ toolName: "f5xc-api-dataintelligence-flowlabel-list",
202
+ method: "GET",
203
+ path: "/api/data-intelligence/namespaces/{namespace}/di/flowlabels",
204
+ operation: "list",
205
+ domain: "data_intelligence",
206
+ resource: "flowlabel",
207
+ summary: "List FlowLabels.",
208
+ description: "ListFlowLabels takes a customer name and returns a list of FlowLabel objects.",
209
+ pathParameters: [
210
+ {
211
+ description: "Namespace\nNamespace in which the suggestions are scoped.",
212
+ in: "path",
213
+ name: "namespace",
214
+ required: true,
215
+ schema: {
216
+ type: "string",
217
+ },
218
+ "x-displayname": "Namespace",
219
+ "x-ves-example": "Foobar",
220
+ },
221
+ ],
222
+ queryParameters: [],
223
+ requestBodySchema: null,
224
+ responseSchema: {
225
+ $ref: "#/components/schemas/data_deliveryListFlowLabelsResponse",
226
+ },
227
+ requiredParams: ["namespace"],
228
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.ListFlowLabels",
229
+ tags: ["Other"],
230
+ sourceFile: "domains/data_intelligence.json",
231
+ displayName: null,
232
+ dangerLevel: "low",
233
+ sideEffects: null,
234
+ requiredFields: ["path.namespace"],
235
+ cliExamples: [
236
+ {
237
+ command: "f5xcctl data-intelligence flowlabel list --namespace {namespace}",
238
+ description: "List all flowlabels",
239
+ use_case: "list_all",
240
+ },
241
+ ],
242
+ confirmationRequired: false,
243
+ parameterExamples: {
244
+ namespace: "Foobar",
245
+ },
246
+ validationRules: {},
247
+ operationMetadata: {
248
+ common_errors: [
249
+ {
250
+ code: 401,
251
+ message: "Authentication required",
252
+ solution: "Provide valid API credentials",
253
+ },
254
+ {
255
+ code: 403,
256
+ message: "Permission denied",
257
+ solution: "Check access permissions for this operation",
258
+ },
259
+ {
260
+ code: 404,
261
+ message: "Resource not found",
262
+ solution: "Verify resource name, namespace, and path",
263
+ },
264
+ {
265
+ code: 409,
266
+ message: "Resource already exists",
267
+ solution: "Use different name or update existing resource",
268
+ },
269
+ {
270
+ code: 429,
271
+ message: "Rate limit exceeded",
272
+ solution: "Wait before retrying the operation",
273
+ },
274
+ {
275
+ code: 500,
276
+ message: "Server error",
277
+ solution: "Retry operation or contact support",
278
+ },
279
+ ],
280
+ conditions: {
281
+ postconditions: [],
282
+ prerequisites: ["Active namespace"],
283
+ },
284
+ confirmation_required: false,
285
+ danger_level: "low",
286
+ examples: [
287
+ {
288
+ command: "f5xcctl data-intelligence flowlabel list --namespace {namespace}",
289
+ description: "List all flowlabels",
290
+ use_case: "list_all",
291
+ },
292
+ ],
293
+ field_docs: {},
294
+ optional_fields: [],
295
+ performance_impact: {
296
+ latency: "moderate",
297
+ resource_usage: "moderate",
298
+ },
299
+ purpose: "List all flowlabels",
300
+ required_fields: ["path.namespace"],
301
+ side_effects: {},
302
+ },
303
+ },
304
+ {
305
+ toolName: "f5xc-api-dataintelligence-init-request-create",
306
+ method: "POST",
307
+ path: "/api/data-intelligence/namespaces/system/init-request",
308
+ operation: "create",
309
+ domain: "data_intelligence",
310
+ resource: "init-request",
311
+ summary: "Enable Data Intelligence.",
312
+ description: "Request to enable Data Intelligence for the tenant.",
313
+ pathParameters: [],
314
+ queryParameters: [],
315
+ requestBodySchema: {
316
+ $ref: "#/components/schemas/schemaEmpty",
317
+ },
318
+ responseSchema: {
319
+ $ref: "#/components/schemas/schemaEmpty",
320
+ },
321
+ requiredParams: ["body"],
322
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.Init",
323
+ tags: ["Other"],
324
+ sourceFile: "domains/data_intelligence.json",
325
+ displayName: null,
326
+ dangerLevel: "medium",
327
+ sideEffects: {
328
+ creates: ["init-request"],
329
+ },
330
+ requiredFields: ["metadata.name", "metadata.namespace"],
331
+ cliExamples: [
332
+ {
333
+ command: "f5xcctl data-intelligence init-request create -f {file}.yaml",
334
+ description: "Create from YAML file",
335
+ use_case: "file_based",
336
+ },
337
+ {
338
+ command: "f5xcctl data-intelligence init-request create {name} --namespace {namespace}",
339
+ description: "Create init-request",
340
+ use_case: "basic_create",
341
+ },
342
+ ],
343
+ confirmationRequired: false,
344
+ parameterExamples: {},
345
+ validationRules: {},
346
+ operationMetadata: {
347
+ common_errors: [
348
+ {
349
+ code: 401,
350
+ message: "Authentication required",
351
+ solution: "Provide valid API credentials",
352
+ },
353
+ {
354
+ code: 403,
355
+ message: "Permission denied",
356
+ solution: "Check access permissions for this operation",
357
+ },
358
+ {
359
+ code: 404,
360
+ message: "Resource not found",
361
+ solution: "Verify resource name, namespace, and path",
362
+ },
363
+ {
364
+ code: 409,
365
+ message: "Resource already exists",
366
+ solution: "Use different name or update existing resource",
367
+ },
368
+ {
369
+ code: 429,
370
+ message: "Rate limit exceeded",
371
+ solution: "Wait before retrying the operation",
372
+ },
373
+ {
374
+ code: 500,
375
+ message: "Server error",
376
+ solution: "Retry operation or contact support",
377
+ },
378
+ ],
379
+ conditions: {
380
+ postconditions: ["Init-request resource created", "Resource assigned unique identifier"],
381
+ prerequisites: ["Active namespace"],
382
+ },
383
+ confirmation_required: false,
384
+ danger_level: "medium",
385
+ examples: [
386
+ {
387
+ command: "f5xcctl data-intelligence init-request create {name} --namespace {namespace}",
388
+ description: "Create init-request",
389
+ use_case: "basic_create",
390
+ },
391
+ {
392
+ command: "f5xcctl data-intelligence init-request create -f {file}.yaml",
393
+ description: "Create from YAML file",
394
+ use_case: "file_based",
395
+ },
396
+ ],
397
+ field_docs: {},
398
+ optional_fields: [],
399
+ performance_impact: {
400
+ latency: "low",
401
+ resource_usage: "low",
402
+ },
403
+ purpose: "Create new init-request",
404
+ required_fields: ["metadata.name", "metadata.namespace"],
405
+ side_effects: {
406
+ creates: ["init-request"],
407
+ },
408
+ },
409
+ },
410
+ {
411
+ toolName: "f5xc-api-dataintelligence-receiver-create",
412
+ method: "POST",
413
+ path: "/api/data-intelligence/namespaces/{metadata.namespace}/receivers",
414
+ operation: "create",
415
+ domain: "data_intelligence",
416
+ resource: "receiver",
417
+ summary: "Create Data Delivery.",
418
+ description: "Creates a new Data Delivery object.",
419
+ pathParameters: [
420
+ {
421
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
422
+ in: "path",
423
+ name: "metadata.namespace",
424
+ required: true,
425
+ schema: {
426
+ type: "string",
427
+ },
428
+ "x-displayname": "Namespace",
429
+ "x-ves-example": "Staging",
430
+ },
431
+ ],
432
+ queryParameters: [],
433
+ requestBodySchema: {
434
+ $ref: "#/components/schemas/receiverCreateRequest",
435
+ },
436
+ responseSchema: {
437
+ $ref: "#/components/schemas/receiverCreateResponse",
438
+ },
439
+ requiredParams: ["body", "metadata.namespace"],
440
+ operationId: "ves.io.schema.shape.data_delivery.receiver.API.Create",
441
+ tags: ["Other"],
442
+ sourceFile: "domains/data_intelligence.json",
443
+ displayName: null,
444
+ dangerLevel: "medium",
445
+ sideEffects: {
446
+ creates: ["receiver"],
447
+ },
448
+ requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
449
+ cliExamples: [
450
+ {
451
+ command: "f5xcctl data-intelligence receiver create -f {file}.yaml",
452
+ description: "Create from YAML file",
453
+ use_case: "file_based",
454
+ },
455
+ {
456
+ command: "f5xcctl data-intelligence receiver create {name} --namespace {namespace}",
457
+ description: "Create receiver",
458
+ use_case: "basic_create",
459
+ },
460
+ ],
461
+ confirmationRequired: false,
462
+ parameterExamples: {
463
+ "metadata.namespace": "Staging",
464
+ },
465
+ validationRules: {},
466
+ operationMetadata: {
467
+ common_errors: [
468
+ {
469
+ code: 401,
470
+ message: "Authentication required",
471
+ solution: "Provide valid API credentials",
472
+ },
473
+ {
474
+ code: 403,
475
+ message: "Permission denied",
476
+ solution: "Check access permissions for this operation",
477
+ },
478
+ {
479
+ code: 404,
480
+ message: "Resource not found",
481
+ solution: "Verify resource name, namespace, and path",
482
+ },
483
+ {
484
+ code: 409,
485
+ message: "Resource already exists",
486
+ solution: "Use different name or update existing resource",
487
+ },
488
+ {
489
+ code: 429,
490
+ message: "Rate limit exceeded",
491
+ solution: "Wait before retrying the operation",
492
+ },
493
+ {
494
+ code: 500,
495
+ message: "Server error",
496
+ solution: "Retry operation or contact support",
497
+ },
498
+ ],
499
+ conditions: {
500
+ postconditions: ["Receiver resource created", "Resource assigned unique identifier"],
501
+ prerequisites: ["Active namespace"],
502
+ },
503
+ confirmation_required: false,
504
+ danger_level: "medium",
505
+ examples: [
506
+ {
507
+ command: "f5xcctl data-intelligence receiver create {name} --namespace {namespace}",
508
+ description: "Create receiver",
509
+ use_case: "basic_create",
510
+ },
511
+ {
512
+ command: "f5xcctl data-intelligence receiver create -f {file}.yaml",
513
+ description: "Create from YAML file",
514
+ use_case: "file_based",
515
+ },
516
+ ],
517
+ field_docs: {},
518
+ optional_fields: [],
519
+ performance_impact: {
520
+ latency: "low",
521
+ resource_usage: "low",
522
+ },
523
+ purpose: "Create new receiver",
524
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
525
+ side_effects: {
526
+ creates: ["receiver"],
527
+ },
528
+ },
529
+ },
530
+ {
531
+ toolName: "f5xc-api-dataintelligence-receiver-delete",
532
+ method: "DELETE",
533
+ path: "/api/data-intelligence/namespaces/{namespace}/receivers/{name}",
534
+ operation: "delete",
535
+ domain: "data_intelligence",
536
+ resource: "receiver",
537
+ summary: "DELETE Data Delivery.",
538
+ description: "DELETE the specified receiver.",
539
+ pathParameters: [
540
+ {
541
+ description: "Name\nName of the configuration object.",
542
+ in: "path",
543
+ name: "name",
544
+ required: true,
545
+ schema: {
546
+ type: "string",
547
+ },
548
+ "x-displayname": "Name",
549
+ "x-ves-example": "Name",
550
+ },
551
+ {
552
+ description: "Namespace\nNamespace in which the configuration object is present.",
553
+ in: "path",
554
+ name: "namespace",
555
+ required: true,
556
+ schema: {
557
+ type: "string",
558
+ },
559
+ "x-displayname": "Namespace",
560
+ "x-ves-example": "Ns1",
561
+ },
562
+ ],
563
+ queryParameters: [],
564
+ requestBodySchema: {
565
+ $ref: "#/components/schemas/receiverDeleteRequest",
566
+ },
567
+ responseSchema: {},
568
+ requiredParams: ["body", "name", "namespace"],
569
+ operationId: "ves.io.schema.shape.data_delivery.receiver.API.Delete",
570
+ tags: ["Other"],
571
+ sourceFile: "domains/data_intelligence.json",
572
+ displayName: null,
573
+ dangerLevel: "high",
574
+ sideEffects: {
575
+ deletes: ["receiver", "contained_resources"],
576
+ },
577
+ requiredFields: ["path.name", "path.namespace"],
578
+ cliExamples: [
579
+ {
580
+ command: "f5xcctl data-intelligence receiver delete {name} --namespace {namespace}",
581
+ description: "Delete receiver",
582
+ use_case: "delete",
583
+ },
584
+ ],
585
+ confirmationRequired: true,
586
+ parameterExamples: {
587
+ name: "Name",
588
+ namespace: "Ns1",
589
+ },
590
+ validationRules: {},
591
+ operationMetadata: {
592
+ common_errors: [
593
+ {
594
+ code: 401,
595
+ message: "Authentication required",
596
+ solution: "Provide valid API credentials",
597
+ },
598
+ {
599
+ code: 403,
600
+ message: "Permission denied",
601
+ solution: "Check access permissions for this operation",
602
+ },
603
+ {
604
+ code: 404,
605
+ message: "Resource not found",
606
+ solution: "Verify resource name, namespace, and path",
607
+ },
608
+ {
609
+ code: 409,
610
+ message: "Resource already exists",
611
+ solution: "Use different name or update existing resource",
612
+ },
613
+ {
614
+ code: 429,
615
+ message: "Rate limit exceeded",
616
+ solution: "Wait before retrying the operation",
617
+ },
618
+ {
619
+ code: 500,
620
+ message: "Server error",
621
+ solution: "Retry operation or contact support",
622
+ },
623
+ ],
624
+ conditions: {
625
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
626
+ prerequisites: ["Active namespace"],
627
+ },
628
+ confirmation_required: true,
629
+ danger_level: "high",
630
+ examples: [
631
+ {
632
+ command: "f5xcctl data-intelligence receiver delete {name} --namespace {namespace}",
633
+ description: "Delete receiver",
634
+ use_case: "delete",
635
+ },
636
+ ],
637
+ field_docs: {},
638
+ optional_fields: [],
639
+ performance_impact: {
640
+ latency: "high",
641
+ resource_usage: "moderate",
642
+ },
643
+ purpose: "Delete receiver",
644
+ required_fields: ["path.name", "path.namespace"],
645
+ side_effects: {
646
+ deletes: ["receiver", "contained_resources"],
647
+ },
648
+ },
649
+ },
650
+ {
651
+ toolName: "f5xc-api-dataintelligence-receiver-get",
652
+ method: "GET",
653
+ path: "/api/data-intelligence/namespaces/{namespace}/receivers/{name}",
654
+ operation: "get",
655
+ domain: "data_intelligence",
656
+ resource: "receiver",
657
+ summary: "GET Data Delivery.",
658
+ description: "GET the Data Delivery object.",
659
+ pathParameters: [
660
+ {
661
+ description: "Name\nThe name of the configuration object to be fetched.",
662
+ in: "path",
663
+ name: "name",
664
+ required: true,
665
+ schema: {
666
+ type: "string",
667
+ },
668
+ "x-displayname": "Name",
669
+ "x-ves-example": "Name",
670
+ },
671
+ {
672
+ description: "Namespace\nThe namespace in which the configuration object is present.",
673
+ in: "path",
674
+ name: "namespace",
675
+ required: true,
676
+ schema: {
677
+ type: "string",
678
+ },
679
+ "x-displayname": "Namespace",
680
+ "x-ves-example": "Ns1",
681
+ },
682
+ ],
683
+ queryParameters: [
684
+ {
685
+ description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
686
+ in: "query",
687
+ name: "response_format",
688
+ required: false,
689
+ schema: {
690
+ default: "GET_RSP_FORMAT_DEFAULT",
691
+ enum: [
692
+ "GET_RSP_FORMAT_DEFAULT",
693
+ "GET_RSP_FORMAT_FOR_CREATE",
694
+ "GET_RSP_FORMAT_FOR_REPLACE",
695
+ "GET_RSP_FORMAT_STATUS",
696
+ "GET_RSP_FORMAT_READ",
697
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
698
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
699
+ ],
700
+ type: "string",
701
+ },
702
+ "x-displayname": "Broken Referred Objects.",
703
+ },
704
+ ],
705
+ requestBodySchema: null,
706
+ responseSchema: {
707
+ $ref: "#/components/schemas/receiverGetResponse",
708
+ },
709
+ requiredParams: ["name", "namespace"],
710
+ operationId: "ves.io.schema.shape.data_delivery.receiver.API.Get",
711
+ tags: ["Other"],
712
+ sourceFile: "domains/data_intelligence.json",
713
+ displayName: null,
714
+ dangerLevel: "low",
715
+ sideEffects: null,
716
+ requiredFields: ["path.name", "path.namespace"],
717
+ cliExamples: [
718
+ {
719
+ command: "f5xcctl data-intelligence receiver get {name} --namespace {namespace}",
720
+ description: "Get specific receiver",
721
+ use_case: "get_specific",
722
+ },
723
+ ],
724
+ confirmationRequired: false,
725
+ parameterExamples: {
726
+ name: "Name",
727
+ namespace: "Ns1",
728
+ },
729
+ validationRules: {},
730
+ operationMetadata: {
731
+ common_errors: [
732
+ {
733
+ code: 401,
734
+ message: "Authentication required",
735
+ solution: "Provide valid API credentials",
736
+ },
737
+ {
738
+ code: 403,
739
+ message: "Permission denied",
740
+ solution: "Check access permissions for this operation",
741
+ },
742
+ {
743
+ code: 404,
744
+ message: "Resource not found",
745
+ solution: "Verify resource name, namespace, and path",
746
+ },
747
+ {
748
+ code: 409,
749
+ message: "Resource already exists",
750
+ solution: "Use different name or update existing resource",
751
+ },
752
+ {
753
+ code: 429,
754
+ message: "Rate limit exceeded",
755
+ solution: "Wait before retrying the operation",
756
+ },
757
+ {
758
+ code: 500,
759
+ message: "Server error",
760
+ solution: "Retry operation or contact support",
761
+ },
762
+ ],
763
+ conditions: {
764
+ postconditions: [],
765
+ prerequisites: ["Active namespace"],
766
+ },
767
+ confirmation_required: false,
768
+ danger_level: "low",
769
+ examples: [
770
+ {
771
+ command: "f5xcctl data-intelligence receiver get {name} --namespace {namespace}",
772
+ description: "Get specific receiver",
773
+ use_case: "get_specific",
774
+ },
775
+ ],
776
+ field_docs: {},
777
+ optional_fields: [],
778
+ performance_impact: {
779
+ latency: "low",
780
+ resource_usage: "low",
781
+ },
782
+ purpose: "Retrieve specific receiver",
783
+ required_fields: ["path.name", "path.namespace"],
784
+ side_effects: {},
785
+ },
786
+ },
787
+ {
788
+ toolName: "f5xc-api-dataintelligence-receiver-list",
789
+ method: "GET",
790
+ path: "/api/data-intelligence/namespaces/{namespace}/receivers",
791
+ operation: "list",
792
+ domain: "data_intelligence",
793
+ resource: "receiver",
794
+ summary: "List Data Delivery.",
795
+ description: "List the set of receiver in a namespace.",
796
+ pathParameters: [
797
+ {
798
+ description: "Namespace\nNamespace to scope the listing of receiver.",
799
+ in: "path",
800
+ name: "namespace",
801
+ required: true,
802
+ schema: {
803
+ type: "string",
804
+ },
805
+ "x-displayname": "Namespace",
806
+ "x-ves-example": "Ns1",
807
+ },
808
+ ],
809
+ queryParameters: [
810
+ {
811
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
812
+ in: "query",
813
+ name: "label_filter",
814
+ required: false,
815
+ schema: {
816
+ type: "string",
817
+ },
818
+ "x-displayname": "Label Filter.",
819
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
820
+ },
821
+ {
822
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
823
+ in: "query",
824
+ name: "report_fields",
825
+ required: false,
826
+ schema: {
827
+ items: {
828
+ type: "string",
829
+ },
830
+ type: "array",
831
+ },
832
+ "x-displayname": "Report Fields.",
833
+ },
834
+ {
835
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
836
+ in: "query",
837
+ name: "report_status_fields",
838
+ required: false,
839
+ schema: {
840
+ items: {
841
+ type: "string",
842
+ },
843
+ type: "array",
844
+ },
845
+ "x-displayname": "Report Status Fields.",
846
+ },
847
+ ],
848
+ requestBodySchema: null,
849
+ responseSchema: {
850
+ $ref: "#/components/schemas/receiverListResponse",
851
+ },
852
+ requiredParams: ["namespace"],
853
+ operationId: "ves.io.schema.shape.data_delivery.receiver.API.List",
854
+ tags: ["Other"],
855
+ sourceFile: "domains/data_intelligence.json",
856
+ displayName: null,
857
+ dangerLevel: "low",
858
+ sideEffects: null,
859
+ requiredFields: ["path.namespace"],
860
+ cliExamples: [
861
+ {
862
+ command: "f5xcctl data-intelligence receiver list --namespace {namespace}",
863
+ description: "List all receivers",
864
+ use_case: "list_all",
865
+ },
866
+ ],
867
+ confirmationRequired: false,
868
+ parameterExamples: {
869
+ label_filter: "Env in (staging, testing), tier in (web, db)",
870
+ namespace: "Ns1",
871
+ },
872
+ validationRules: {},
873
+ operationMetadata: {
874
+ common_errors: [
875
+ {
876
+ code: 401,
877
+ message: "Authentication required",
878
+ solution: "Provide valid API credentials",
879
+ },
880
+ {
881
+ code: 403,
882
+ message: "Permission denied",
883
+ solution: "Check access permissions for this operation",
884
+ },
885
+ {
886
+ code: 404,
887
+ message: "Resource not found",
888
+ solution: "Verify resource name, namespace, and path",
889
+ },
890
+ {
891
+ code: 409,
892
+ message: "Resource already exists",
893
+ solution: "Use different name or update existing resource",
894
+ },
895
+ {
896
+ code: 429,
897
+ message: "Rate limit exceeded",
898
+ solution: "Wait before retrying the operation",
899
+ },
900
+ {
901
+ code: 500,
902
+ message: "Server error",
903
+ solution: "Retry operation or contact support",
904
+ },
905
+ ],
906
+ conditions: {
907
+ postconditions: [],
908
+ prerequisites: ["Active namespace"],
909
+ },
910
+ confirmation_required: false,
911
+ danger_level: "low",
912
+ examples: [
913
+ {
914
+ command: "f5xcctl data-intelligence receiver list --namespace {namespace}",
915
+ description: "List all receivers",
916
+ use_case: "list_all",
917
+ },
918
+ ],
919
+ field_docs: {},
920
+ optional_fields: [],
921
+ performance_impact: {
922
+ latency: "moderate",
923
+ resource_usage: "moderate",
924
+ },
925
+ purpose: "List all receivers",
926
+ required_fields: ["path.namespace"],
927
+ side_effects: {},
928
+ },
929
+ },
930
+ {
931
+ toolName: "f5xc-api-dataintelligence-receiver-update",
932
+ method: "PUT",
933
+ path: "/api/data-intelligence/namespaces/{metadata.namespace}/receivers/{metadata.name}",
934
+ operation: "update",
935
+ domain: "data_intelligence",
936
+ resource: "receiver",
937
+ summary: "Replace Data Delivery.",
938
+ description: "Replaces the content of an Data Delivery object.",
939
+ pathParameters: [
940
+ {
941
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
942
+ in: "path",
943
+ name: "metadata.name",
944
+ required: true,
945
+ schema: {
946
+ type: "string",
947
+ },
948
+ "x-displayname": "Name",
949
+ "x-ves-example": "Example-corp-web.",
950
+ },
951
+ {
952
+ description: 'Namespace\nThis defines the workspace within which each the configuration object is to be created.\nMust be a DNS_LABEL format. For a namespace object itself, namespace value will be ""',
953
+ in: "path",
954
+ name: "metadata.namespace",
955
+ required: true,
956
+ schema: {
957
+ type: "string",
958
+ },
959
+ "x-displayname": "Namespace",
960
+ "x-ves-example": "Staging",
961
+ },
962
+ ],
963
+ queryParameters: [],
964
+ requestBodySchema: {
965
+ $ref: "#/components/schemas/receiverReplaceRequest",
966
+ },
967
+ responseSchema: {
968
+ $ref: "#/components/schemas/receiverReplaceResponse",
969
+ },
970
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
971
+ operationId: "ves.io.schema.shape.data_delivery.receiver.API.Replace",
972
+ tags: ["Other"],
973
+ sourceFile: "domains/data_intelligence.json",
974
+ displayName: null,
975
+ dangerLevel: "medium",
976
+ sideEffects: {
977
+ modifies: ["receiver"],
978
+ },
979
+ requiredFields: ["path.metadata.name", "path.metadata.namespace"],
980
+ cliExamples: [
981
+ {
982
+ command: "f5xcctl data-intelligence receiver update {name} --namespace {namespace} -f {file}.yaml",
983
+ description: "Update receiver",
984
+ use_case: "update",
985
+ },
986
+ ],
987
+ confirmationRequired: false,
988
+ parameterExamples: {
989
+ "metadata.name": "Example-corp-web.",
990
+ "metadata.namespace": "Staging",
991
+ },
992
+ validationRules: {},
993
+ operationMetadata: {
994
+ common_errors: [
995
+ {
996
+ code: 401,
997
+ message: "Authentication required",
998
+ solution: "Provide valid API credentials",
999
+ },
1000
+ {
1001
+ code: 403,
1002
+ message: "Permission denied",
1003
+ solution: "Check access permissions for this operation",
1004
+ },
1005
+ {
1006
+ code: 404,
1007
+ message: "Resource not found",
1008
+ solution: "Verify resource name, namespace, and path",
1009
+ },
1010
+ {
1011
+ code: 409,
1012
+ message: "Resource already exists",
1013
+ solution: "Use different name or update existing resource",
1014
+ },
1015
+ {
1016
+ code: 429,
1017
+ message: "Rate limit exceeded",
1018
+ solution: "Wait before retrying the operation",
1019
+ },
1020
+ {
1021
+ code: 500,
1022
+ message: "Server error",
1023
+ solution: "Retry operation or contact support",
1024
+ },
1025
+ ],
1026
+ conditions: {
1027
+ postconditions: ["Resource updated with new values"],
1028
+ prerequisites: ["Active namespace"],
1029
+ },
1030
+ confirmation_required: false,
1031
+ danger_level: "medium",
1032
+ examples: [
1033
+ {
1034
+ command: "f5xcctl data-intelligence receiver update {name} --namespace {namespace} -f {file}.yaml",
1035
+ description: "Update receiver",
1036
+ use_case: "update",
1037
+ },
1038
+ ],
1039
+ field_docs: {},
1040
+ optional_fields: [],
1041
+ performance_impact: {
1042
+ latency: "low",
1043
+ resource_usage: "low",
1044
+ },
1045
+ purpose: "Replace existing receiver",
1046
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
1047
+ side_effects: {
1048
+ modifies: ["receiver"],
1049
+ },
1050
+ },
1051
+ },
1052
+ {
1053
+ toolName: "f5xc-api-dataintelligence-statu-create",
1054
+ method: "POST",
1055
+ path: "/api/data-intelligence/namespaces/{namespace}/receivers/{id}/status",
1056
+ operation: "create",
1057
+ domain: "data_intelligence",
1058
+ resource: "statu",
1059
+ summary: "Update Status of Receiver.",
1060
+ description: "Update receiver object status from enable to disable and vice versa.",
1061
+ pathParameters: [
1062
+ {
1063
+ description: "ID\nReceiver Name.",
1064
+ in: "path",
1065
+ name: "id",
1066
+ required: true,
1067
+ schema: {
1068
+ type: "string",
1069
+ },
1070
+ "x-displayname": "Receiver ID.",
1071
+ "x-ves-example": "Splunk-cloud-receiver.",
1072
+ },
1073
+ {
1074
+ description: "Namespace\nNamespace in which the suggestions are scoped.",
1075
+ in: "path",
1076
+ name: "namespace",
1077
+ required: true,
1078
+ schema: {
1079
+ type: "string",
1080
+ },
1081
+ "x-displayname": "Namespace",
1082
+ "x-ves-example": "Foobar",
1083
+ },
1084
+ ],
1085
+ queryParameters: [],
1086
+ requestBodySchema: {
1087
+ $ref: "#/components/schemas/data_deliveryUpdateReceiverStatusRequest",
1088
+ },
1089
+ responseSchema: {
1090
+ $ref: "#/components/schemas/data_deliveryUpdateReceiverStatusResponse",
1091
+ },
1092
+ requiredParams: ["body", "id", "namespace"],
1093
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.UpdateReceiverStatus",
1094
+ tags: ["Other"],
1095
+ sourceFile: "domains/data_intelligence.json",
1096
+ displayName: null,
1097
+ dangerLevel: "medium",
1098
+ sideEffects: {
1099
+ creates: ["statu"],
1100
+ },
1101
+ requiredFields: ["metadata.name", "metadata.namespace", "path.id", "path.namespace"],
1102
+ cliExamples: [
1103
+ {
1104
+ command: "f5xcctl data-intelligence statu create -f {file}.yaml",
1105
+ description: "Create from YAML file",
1106
+ use_case: "file_based",
1107
+ },
1108
+ {
1109
+ command: "f5xcctl data-intelligence statu create {name} --namespace {namespace}",
1110
+ description: "Create statu",
1111
+ use_case: "basic_create",
1112
+ },
1113
+ ],
1114
+ confirmationRequired: false,
1115
+ parameterExamples: {
1116
+ id: "Splunk-cloud-receiver.",
1117
+ namespace: "Foobar",
1118
+ },
1119
+ validationRules: {},
1120
+ operationMetadata: {
1121
+ common_errors: [
1122
+ {
1123
+ code: 401,
1124
+ message: "Authentication required",
1125
+ solution: "Provide valid API credentials",
1126
+ },
1127
+ {
1128
+ code: 403,
1129
+ message: "Permission denied",
1130
+ solution: "Check access permissions for this operation",
1131
+ },
1132
+ {
1133
+ code: 404,
1134
+ message: "Resource not found",
1135
+ solution: "Verify resource name, namespace, and path",
1136
+ },
1137
+ {
1138
+ code: 409,
1139
+ message: "Resource already exists",
1140
+ solution: "Use different name or update existing resource",
1141
+ },
1142
+ {
1143
+ code: 429,
1144
+ message: "Rate limit exceeded",
1145
+ solution: "Wait before retrying the operation",
1146
+ },
1147
+ {
1148
+ code: 500,
1149
+ message: "Server error",
1150
+ solution: "Retry operation or contact support",
1151
+ },
1152
+ ],
1153
+ conditions: {
1154
+ postconditions: ["Statu resource created", "Resource assigned unique identifier"],
1155
+ prerequisites: ["Active namespace"],
1156
+ },
1157
+ confirmation_required: false,
1158
+ danger_level: "medium",
1159
+ examples: [
1160
+ {
1161
+ command: "f5xcctl data-intelligence statu create {name} --namespace {namespace}",
1162
+ description: "Create statu",
1163
+ use_case: "basic_create",
1164
+ },
1165
+ {
1166
+ command: "f5xcctl data-intelligence statu create -f {file}.yaml",
1167
+ description: "Create from YAML file",
1168
+ use_case: "file_based",
1169
+ },
1170
+ ],
1171
+ field_docs: {},
1172
+ optional_fields: [],
1173
+ performance_impact: {
1174
+ latency: "low",
1175
+ resource_usage: "low",
1176
+ },
1177
+ purpose: "Create new statu",
1178
+ required_fields: ["metadata.name", "metadata.namespace", "path.id", "path.namespace"],
1179
+ side_effects: {
1180
+ creates: ["statu"],
1181
+ },
1182
+ },
1183
+ },
1184
+ {
1185
+ toolName: "f5xc-api-dataintelligence-subscribe-create",
1186
+ method: "POST",
1187
+ path: "/api/data-intelligence/namespaces/system/data-intelligence/addon/subscribe",
1188
+ operation: "create",
1189
+ domain: "data_intelligence",
1190
+ resource: "subscribe",
1191
+ summary: "Subscribe to Data Intelligence.",
1192
+ description: "Subscribe to Data Intelligence.",
1193
+ pathParameters: [],
1194
+ queryParameters: [],
1195
+ requestBodySchema: {
1196
+ $ref: "#/components/schemas/subscriptionSubscribeRequest",
1197
+ },
1198
+ responseSchema: {
1199
+ $ref: "#/components/schemas/subscriptionSubscribeResponse",
1200
+ },
1201
+ requiredParams: ["body"],
1202
+ operationId: "ves.io.schema.shape.data_delivery.subscription.CustomAPI.Subscribe",
1203
+ tags: ["Other"],
1204
+ sourceFile: "domains/data_intelligence.json",
1205
+ displayName: null,
1206
+ dangerLevel: "medium",
1207
+ sideEffects: {
1208
+ creates: ["subscribe"],
1209
+ },
1210
+ requiredFields: ["metadata.name", "metadata.namespace"],
1211
+ cliExamples: [
1212
+ {
1213
+ command: "f5xcctl data-intelligence subscribe create -f {file}.yaml",
1214
+ description: "Create from YAML file",
1215
+ use_case: "file_based",
1216
+ },
1217
+ {
1218
+ command: "f5xcctl data-intelligence subscribe create {name} --namespace {namespace}",
1219
+ description: "Create subscribe",
1220
+ use_case: "basic_create",
1221
+ },
1222
+ ],
1223
+ confirmationRequired: false,
1224
+ parameterExamples: {},
1225
+ validationRules: {},
1226
+ operationMetadata: {
1227
+ common_errors: [
1228
+ {
1229
+ code: 401,
1230
+ message: "Authentication required",
1231
+ solution: "Provide valid API credentials",
1232
+ },
1233
+ {
1234
+ code: 403,
1235
+ message: "Permission denied",
1236
+ solution: "Check access permissions for this operation",
1237
+ },
1238
+ {
1239
+ code: 404,
1240
+ message: "Resource not found",
1241
+ solution: "Verify resource name, namespace, and path",
1242
+ },
1243
+ {
1244
+ code: 409,
1245
+ message: "Resource already exists",
1246
+ solution: "Use different name or update existing resource",
1247
+ },
1248
+ {
1249
+ code: 429,
1250
+ message: "Rate limit exceeded",
1251
+ solution: "Wait before retrying the operation",
1252
+ },
1253
+ {
1254
+ code: 500,
1255
+ message: "Server error",
1256
+ solution: "Retry operation or contact support",
1257
+ },
1258
+ ],
1259
+ conditions: {
1260
+ postconditions: ["Subscribe resource created", "Resource assigned unique identifier"],
1261
+ prerequisites: ["Active namespace"],
1262
+ },
1263
+ confirmation_required: false,
1264
+ danger_level: "medium",
1265
+ examples: [
1266
+ {
1267
+ command: "f5xcctl data-intelligence subscribe create {name} --namespace {namespace}",
1268
+ description: "Create subscribe",
1269
+ use_case: "basic_create",
1270
+ },
1271
+ {
1272
+ command: "f5xcctl data-intelligence subscribe create -f {file}.yaml",
1273
+ description: "Create from YAML file",
1274
+ use_case: "file_based",
1275
+ },
1276
+ ],
1277
+ field_docs: {},
1278
+ optional_fields: [],
1279
+ performance_impact: {
1280
+ latency: "low",
1281
+ resource_usage: "low",
1282
+ },
1283
+ purpose: "Create new subscribe",
1284
+ required_fields: ["metadata.name", "metadata.namespace"],
1285
+ side_effects: {
1286
+ creates: ["subscribe"],
1287
+ },
1288
+ },
1289
+ },
1290
+ {
1291
+ toolName: "f5xc-api-dataintelligence-suggest-value-create",
1292
+ method: "POST",
1293
+ path: "/api/data-intelligence/namespaces/{namespace}/suggest-values",
1294
+ operation: "create",
1295
+ domain: "data_intelligence",
1296
+ resource: "suggest-value",
1297
+ summary: "Suggest Values.",
1298
+ description: "Returns suggested values for the specified field in the given Create/Replace/Custom request.",
1299
+ pathParameters: [
1300
+ {
1301
+ description: "Namespace\nNamespace in which the suggestions are scoped.",
1302
+ in: "path",
1303
+ name: "namespace",
1304
+ required: true,
1305
+ schema: {
1306
+ type: "string",
1307
+ },
1308
+ "x-displayname": "Namespace",
1309
+ "x-ves-example": "Foobar",
1310
+ },
1311
+ ],
1312
+ queryParameters: [],
1313
+ requestBodySchema: {
1314
+ $ref: "#/components/schemas/namespaceSuggestValuesReq",
1315
+ },
1316
+ responseSchema: {
1317
+ $ref: "#/components/schemas/namespaceSuggestValuesResp",
1318
+ },
1319
+ requiredParams: ["body", "namespace"],
1320
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.SuggestValues",
1321
+ tags: ["Other"],
1322
+ sourceFile: "domains/data_intelligence.json",
1323
+ displayName: null,
1324
+ dangerLevel: "medium",
1325
+ sideEffects: {
1326
+ creates: ["suggest-value"],
1327
+ },
1328
+ requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
1329
+ cliExamples: [
1330
+ {
1331
+ command: "f5xcctl data-intelligence suggest-value create -f {file}.yaml",
1332
+ description: "Create from YAML file",
1333
+ use_case: "file_based",
1334
+ },
1335
+ {
1336
+ command: "f5xcctl data-intelligence suggest-value create {name} --namespace {namespace}",
1337
+ description: "Create suggest-value",
1338
+ use_case: "basic_create",
1339
+ },
1340
+ ],
1341
+ confirmationRequired: false,
1342
+ parameterExamples: {
1343
+ namespace: "Foobar",
1344
+ },
1345
+ validationRules: {},
1346
+ operationMetadata: {
1347
+ common_errors: [
1348
+ {
1349
+ code: 401,
1350
+ message: "Authentication required",
1351
+ solution: "Provide valid API credentials",
1352
+ },
1353
+ {
1354
+ code: 403,
1355
+ message: "Permission denied",
1356
+ solution: "Check access permissions for this operation",
1357
+ },
1358
+ {
1359
+ code: 404,
1360
+ message: "Resource not found",
1361
+ solution: "Verify resource name, namespace, and path",
1362
+ },
1363
+ {
1364
+ code: 409,
1365
+ message: "Resource already exists",
1366
+ solution: "Use different name or update existing resource",
1367
+ },
1368
+ {
1369
+ code: 429,
1370
+ message: "Rate limit exceeded",
1371
+ solution: "Wait before retrying the operation",
1372
+ },
1373
+ {
1374
+ code: 500,
1375
+ message: "Server error",
1376
+ solution: "Retry operation or contact support",
1377
+ },
1378
+ ],
1379
+ conditions: {
1380
+ postconditions: ["Suggest-value resource created", "Resource assigned unique identifier"],
1381
+ prerequisites: ["Active namespace"],
1382
+ },
1383
+ confirmation_required: false,
1384
+ danger_level: "medium",
1385
+ examples: [
1386
+ {
1387
+ command: "f5xcctl data-intelligence suggest-value create {name} --namespace {namespace}",
1388
+ description: "Create suggest-value",
1389
+ use_case: "basic_create",
1390
+ },
1391
+ {
1392
+ command: "f5xcctl data-intelligence suggest-value create -f {file}.yaml",
1393
+ description: "Create from YAML file",
1394
+ use_case: "file_based",
1395
+ },
1396
+ ],
1397
+ field_docs: {},
1398
+ optional_fields: [],
1399
+ performance_impact: {
1400
+ latency: "low",
1401
+ resource_usage: "low",
1402
+ },
1403
+ purpose: "Create new suggest-value",
1404
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
1405
+ side_effects: {
1406
+ creates: ["suggest-value"],
1407
+ },
1408
+ },
1409
+ },
1410
+ {
1411
+ toolName: "f5xc-api-dataintelligence-summary-create",
1412
+ method: "POST",
1413
+ path: "/api/data-intelligence/namespaces/{namespace}/di/summary",
1414
+ operation: "create",
1415
+ domain: "data_intelligence",
1416
+ resource: "summary",
1417
+ summary: "Load Executive Summary.",
1418
+ description: "Executive summary page for DI premium customers.",
1419
+ pathParameters: [
1420
+ {
1421
+ description: "Namespace\nNamespace in which the suggestions are scoped.",
1422
+ in: "path",
1423
+ name: "namespace",
1424
+ required: true,
1425
+ schema: {
1426
+ type: "string",
1427
+ },
1428
+ "x-displayname": "Namespace",
1429
+ "x-ves-example": "Foobar",
1430
+ },
1431
+ ],
1432
+ queryParameters: [],
1433
+ requestBodySchema: {
1434
+ $ref: "#/components/schemas/data_deliveryLoadExecutiveSummaryRequest",
1435
+ },
1436
+ responseSchema: {
1437
+ $ref: "#/components/schemas/data_deliveryLoadExecutiveSummaryResponse",
1438
+ },
1439
+ requiredParams: ["body", "namespace"],
1440
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.LoadExecutiveSummary",
1441
+ tags: ["Other"],
1442
+ sourceFile: "domains/data_intelligence.json",
1443
+ displayName: null,
1444
+ dangerLevel: "medium",
1445
+ sideEffects: {
1446
+ creates: ["summary"],
1447
+ },
1448
+ requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
1449
+ cliExamples: [
1450
+ {
1451
+ command: "f5xcctl data-intelligence summary create -f {file}.yaml",
1452
+ description: "Create from YAML file",
1453
+ use_case: "file_based",
1454
+ },
1455
+ {
1456
+ command: "f5xcctl data-intelligence summary create {name} --namespace {namespace}",
1457
+ description: "Create summary",
1458
+ use_case: "basic_create",
1459
+ },
1460
+ ],
1461
+ confirmationRequired: false,
1462
+ parameterExamples: {
1463
+ namespace: "Foobar",
1464
+ },
1465
+ validationRules: {},
1466
+ operationMetadata: {
1467
+ common_errors: [
1468
+ {
1469
+ code: 401,
1470
+ message: "Authentication required",
1471
+ solution: "Provide valid API credentials",
1472
+ },
1473
+ {
1474
+ code: 403,
1475
+ message: "Permission denied",
1476
+ solution: "Check access permissions for this operation",
1477
+ },
1478
+ {
1479
+ code: 404,
1480
+ message: "Resource not found",
1481
+ solution: "Verify resource name, namespace, and path",
1482
+ },
1483
+ {
1484
+ code: 409,
1485
+ message: "Resource already exists",
1486
+ solution: "Use different name or update existing resource",
1487
+ },
1488
+ {
1489
+ code: 429,
1490
+ message: "Rate limit exceeded",
1491
+ solution: "Wait before retrying the operation",
1492
+ },
1493
+ {
1494
+ code: 500,
1495
+ message: "Server error",
1496
+ solution: "Retry operation or contact support",
1497
+ },
1498
+ ],
1499
+ conditions: {
1500
+ postconditions: ["Summary resource created", "Resource assigned unique identifier"],
1501
+ prerequisites: ["Active namespace"],
1502
+ },
1503
+ confirmation_required: false,
1504
+ danger_level: "medium",
1505
+ examples: [
1506
+ {
1507
+ command: "f5xcctl data-intelligence summary create {name} --namespace {namespace}",
1508
+ description: "Create summary",
1509
+ use_case: "basic_create",
1510
+ },
1511
+ {
1512
+ command: "f5xcctl data-intelligence summary create -f {file}.yaml",
1513
+ description: "Create from YAML file",
1514
+ use_case: "file_based",
1515
+ },
1516
+ ],
1517
+ field_docs: {},
1518
+ optional_fields: [],
1519
+ performance_impact: {
1520
+ latency: "low",
1521
+ resource_usage: "low",
1522
+ },
1523
+ purpose: "Create new summary",
1524
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
1525
+ side_effects: {
1526
+ creates: ["summary"],
1527
+ },
1528
+ },
1529
+ },
1530
+ {
1531
+ toolName: "f5xc-api-dataintelligence-test-create",
1532
+ method: "POST",
1533
+ path: "/api/data-intelligence/namespaces/{namespace}/receivers/{id}/test",
1534
+ operation: "create",
1535
+ domain: "data_intelligence",
1536
+ resource: "test",
1537
+ summary: "Test Receiver.",
1538
+ description: "API to test receiver destination sink connection.",
1539
+ pathParameters: [
1540
+ {
1541
+ description: "ID\nReceiver Name.",
1542
+ in: "path",
1543
+ name: "id",
1544
+ required: true,
1545
+ schema: {
1546
+ type: "string",
1547
+ },
1548
+ "x-displayname": "Receiver ID.",
1549
+ "x-ves-example": "Splunk-cloud-receiver.",
1550
+ },
1551
+ {
1552
+ description: "Namespace\n\nx-required\nNamespace in which the receiver is configured.",
1553
+ in: "path",
1554
+ name: "namespace",
1555
+ required: true,
1556
+ schema: {
1557
+ type: "string",
1558
+ },
1559
+ "x-displayname": "Namespace",
1560
+ "x-ves-example": "System",
1561
+ },
1562
+ ],
1563
+ queryParameters: [],
1564
+ requestBodySchema: {
1565
+ $ref: "#/components/schemas/data_deliveryTestReceiverRequest",
1566
+ },
1567
+ responseSchema: {
1568
+ $ref: "#/components/schemas/data_deliveryTestReceiverResponse",
1569
+ },
1570
+ requiredParams: ["body", "id", "namespace"],
1571
+ operationId: "ves.io.schema.shape.data_delivery.CustomAPI.TestReceiver",
1572
+ tags: ["Other"],
1573
+ sourceFile: "domains/data_intelligence.json",
1574
+ displayName: null,
1575
+ dangerLevel: "medium",
1576
+ sideEffects: {
1577
+ creates: ["test"],
1578
+ },
1579
+ requiredFields: ["metadata.name", "metadata.namespace", "path.id", "path.namespace"],
1580
+ cliExamples: [
1581
+ {
1582
+ command: "f5xcctl data-intelligence test create -f {file}.yaml",
1583
+ description: "Create from YAML file",
1584
+ use_case: "file_based",
1585
+ },
1586
+ {
1587
+ command: "f5xcctl data-intelligence test create {name} --namespace {namespace}",
1588
+ description: "Create test",
1589
+ use_case: "basic_create",
1590
+ },
1591
+ ],
1592
+ confirmationRequired: false,
1593
+ parameterExamples: {
1594
+ id: "Splunk-cloud-receiver.",
1595
+ namespace: "System",
1596
+ },
1597
+ validationRules: {},
1598
+ operationMetadata: {
1599
+ common_errors: [
1600
+ {
1601
+ code: 401,
1602
+ message: "Authentication required",
1603
+ solution: "Provide valid API credentials",
1604
+ },
1605
+ {
1606
+ code: 403,
1607
+ message: "Permission denied",
1608
+ solution: "Check access permissions for this operation",
1609
+ },
1610
+ {
1611
+ code: 404,
1612
+ message: "Resource not found",
1613
+ solution: "Verify resource name, namespace, and path",
1614
+ },
1615
+ {
1616
+ code: 409,
1617
+ message: "Resource already exists",
1618
+ solution: "Use different name or update existing resource",
1619
+ },
1620
+ {
1621
+ code: 429,
1622
+ message: "Rate limit exceeded",
1623
+ solution: "Wait before retrying the operation",
1624
+ },
1625
+ {
1626
+ code: 500,
1627
+ message: "Server error",
1628
+ solution: "Retry operation or contact support",
1629
+ },
1630
+ ],
1631
+ conditions: {
1632
+ postconditions: ["Test resource created", "Resource assigned unique identifier"],
1633
+ prerequisites: ["Active namespace"],
1634
+ },
1635
+ confirmation_required: false,
1636
+ danger_level: "medium",
1637
+ examples: [
1638
+ {
1639
+ command: "f5xcctl data-intelligence test create {name} --namespace {namespace}",
1640
+ description: "Create test",
1641
+ use_case: "basic_create",
1642
+ },
1643
+ {
1644
+ command: "f5xcctl data-intelligence test create -f {file}.yaml",
1645
+ description: "Create from YAML file",
1646
+ use_case: "file_based",
1647
+ },
1648
+ ],
1649
+ field_docs: {},
1650
+ optional_fields: [],
1651
+ performance_impact: {
1652
+ latency: "low",
1653
+ resource_usage: "low",
1654
+ },
1655
+ purpose: "Create new test",
1656
+ required_fields: ["metadata.name", "metadata.namespace", "path.id", "path.namespace"],
1657
+ side_effects: {
1658
+ creates: ["test"],
1659
+ },
1660
+ },
1661
+ },
1662
+ {
1663
+ toolName: "f5xc-api-dataintelligence-unsubscribe-create",
1664
+ method: "POST",
1665
+ path: "/api/data-intelligence/namespaces/system/data-intelligence/addon/unsubscribe",
1666
+ operation: "create",
1667
+ domain: "data_intelligence",
1668
+ resource: "unsubscribe",
1669
+ summary: "Unsubscribe to Client-Side Defense.",
1670
+ description: "Unsubscribe to Client-Side Defense.",
1671
+ pathParameters: [],
1672
+ queryParameters: [],
1673
+ requestBodySchema: {
1674
+ $ref: "#/components/schemas/subscriptionUnsubscribeRequest",
1675
+ },
1676
+ responseSchema: {
1677
+ $ref: "#/components/schemas/subscriptionUnsubscribeResponse",
1678
+ },
1679
+ requiredParams: ["body"],
1680
+ operationId: "ves.io.schema.shape.data_delivery.subscription.CustomAPI.Unsubscribe",
1681
+ tags: ["Other"],
1682
+ sourceFile: "domains/data_intelligence.json",
1683
+ displayName: null,
1684
+ dangerLevel: "medium",
1685
+ sideEffects: {
1686
+ creates: ["unsubscribe"],
1687
+ },
1688
+ requiredFields: ["metadata.name", "metadata.namespace"],
1689
+ cliExamples: [
1690
+ {
1691
+ command: "f5xcctl data-intelligence unsubscribe create -f {file}.yaml",
1692
+ description: "Create from YAML file",
1693
+ use_case: "file_based",
1694
+ },
1695
+ {
1696
+ command: "f5xcctl data-intelligence unsubscribe create {name} --namespace {namespace}",
1697
+ description: "Create unsubscribe",
1698
+ use_case: "basic_create",
1699
+ },
1700
+ ],
1701
+ confirmationRequired: false,
1702
+ parameterExamples: {},
1703
+ validationRules: {},
1704
+ operationMetadata: {
1705
+ common_errors: [
1706
+ {
1707
+ code: 401,
1708
+ message: "Authentication required",
1709
+ solution: "Provide valid API credentials",
1710
+ },
1711
+ {
1712
+ code: 403,
1713
+ message: "Permission denied",
1714
+ solution: "Check access permissions for this operation",
1715
+ },
1716
+ {
1717
+ code: 404,
1718
+ message: "Resource not found",
1719
+ solution: "Verify resource name, namespace, and path",
1720
+ },
1721
+ {
1722
+ code: 409,
1723
+ message: "Resource already exists",
1724
+ solution: "Use different name or update existing resource",
1725
+ },
1726
+ {
1727
+ code: 429,
1728
+ message: "Rate limit exceeded",
1729
+ solution: "Wait before retrying the operation",
1730
+ },
1731
+ {
1732
+ code: 500,
1733
+ message: "Server error",
1734
+ solution: "Retry operation or contact support",
1735
+ },
1736
+ ],
1737
+ conditions: {
1738
+ postconditions: ["Unsubscribe resource created", "Resource assigned unique identifier"],
1739
+ prerequisites: ["Active namespace"],
1740
+ },
1741
+ confirmation_required: false,
1742
+ danger_level: "medium",
1743
+ examples: [
1744
+ {
1745
+ command: "f5xcctl data-intelligence unsubscribe create {name} --namespace {namespace}",
1746
+ description: "Create unsubscribe",
1747
+ use_case: "basic_create",
1748
+ },
1749
+ {
1750
+ command: "f5xcctl data-intelligence unsubscribe create -f {file}.yaml",
1751
+ description: "Create from YAML file",
1752
+ use_case: "file_based",
1753
+ },
1754
+ ],
1755
+ field_docs: {},
1756
+ optional_fields: [],
1757
+ performance_impact: {
1758
+ latency: "low",
1759
+ resource_usage: "low",
1760
+ },
1761
+ purpose: "Create new unsubscribe",
1762
+ required_fields: ["metadata.name", "metadata.namespace"],
1763
+ side_effects: {
1764
+ creates: ["unsubscribe"],
1765
+ },
1766
+ },
1767
+ },
1768
+ ];
1769
+ export default data_intelligenceTools;
1770
+ //# sourceMappingURL=index.js.map