@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.5.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 (262) hide show
  1. package/dist/generator/openapi-parser.d.ts +355 -0
  2. package/dist/generator/openapi-parser.d.ts.map +1 -1
  3. package/dist/generator/openapi-parser.js +202 -2
  4. package/dist/generator/openapi-parser.js.map +1 -1
  5. package/dist/generator/tool-generator.d.ts +29 -2
  6. package/dist/generator/tool-generator.d.ts.map +1 -1
  7. package/dist/generator/tool-generator.js +144 -28
  8. package/dist/generator/tool-generator.js.map +1 -1
  9. package/dist/index.d.ts +2 -10
  10. package/dist/index.d.ts.map +1 -1
  11. package/dist/index.js +28 -33
  12. package/dist/index.js.map +1 -1
  13. package/dist/prompts/workflows.d.ts.map +1 -1
  14. package/dist/prompts/workflows.js +30 -174
  15. package/dist/prompts/workflows.js.map +1 -1
  16. package/dist/resources/handlers.d.ts +0 -2
  17. package/dist/resources/handlers.d.ts.map +1 -1
  18. package/dist/resources/handlers.js +0 -51
  19. package/dist/resources/handlers.js.map +1 -1
  20. package/dist/server.d.ts +1 -1
  21. package/dist/server.d.ts.map +1 -1
  22. package/dist/server.js +1 -2
  23. package/dist/server.js.map +1 -1
  24. package/dist/tools/discovery/describe.d.ts +1 -0
  25. package/dist/tools/discovery/describe.d.ts.map +1 -1
  26. package/dist/tools/discovery/describe.js +10 -8
  27. package/dist/tools/discovery/describe.js.map +1 -1
  28. package/dist/tools/discovery/execute.d.ts +1 -3
  29. package/dist/tools/discovery/execute.d.ts.map +1 -1
  30. package/dist/tools/discovery/execute.js +1 -34
  31. package/dist/tools/discovery/execute.js.map +1 -1
  32. package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
  33. package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
  34. package/dist/tools/generated/admin_console_and_ui/index.js +259 -0
  35. package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
  36. package/dist/tools/generated/api/index.d.ts +8 -0
  37. package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
  38. package/dist/tools/generated/api/index.js +5812 -0
  39. package/dist/tools/generated/api/index.js.map +1 -0
  40. package/dist/tools/generated/authentication/index.d.ts +8 -0
  41. package/dist/tools/generated/authentication/index.d.ts.map +1 -0
  42. package/dist/tools/generated/authentication/index.js +858 -0
  43. package/dist/tools/generated/authentication/index.js.map +1 -0
  44. package/dist/tools/generated/bigip/index.d.ts.map +1 -1
  45. package/dist/tools/generated/bigip/index.js +1660 -0
  46. package/dist/tools/generated/bigip/index.js.map +1 -1
  47. package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
  48. package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
  49. package/dist/tools/generated/billing_and_usage/index.js +2283 -0
  50. package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
  51. package/dist/tools/generated/blindfold/index.d.ts +8 -0
  52. package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
  53. package/dist/tools/generated/blindfold/index.js +3462 -0
  54. package/dist/tools/generated/blindfold/index.js.map +1 -0
  55. package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
  56. package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
  57. package/dist/tools/generated/bot_and_threat_defense/index.js +2264 -0
  58. package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
  59. package/dist/tools/generated/cdn/index.d.ts.map +1 -1
  60. package/dist/tools/generated/cdn/index.js +1498 -0
  61. package/dist/tools/generated/cdn/index.js.map +1 -1
  62. package/dist/tools/generated/ce_management/index.d.ts +8 -0
  63. package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
  64. package/dist/tools/generated/ce_management/index.js +3437 -0
  65. package/dist/tools/generated/ce_management/index.js.map +1 -0
  66. package/dist/tools/generated/certificates/index.d.ts +8 -0
  67. package/dist/tools/generated/certificates/index.d.ts.map +1 -0
  68. package/dist/tools/generated/certificates/index.js +2279 -0
  69. package/dist/tools/generated/certificates/index.js.map +1 -0
  70. package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
  71. package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
  72. package/dist/tools/generated/cloud_infrastructure/index.js +3585 -0
  73. package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
  74. package/dist/tools/generated/container_services/index.d.ts +8 -0
  75. package/dist/tools/generated/container_services/index.d.ts.map +1 -0
  76. package/dist/tools/generated/container_services/index.js +1806 -0
  77. package/dist/tools/generated/container_services/index.js.map +1 -0
  78. package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
  79. package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
  80. package/dist/tools/generated/data_and_privacy_security/index.js +1519 -0
  81. package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
  82. package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
  83. package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
  84. package/dist/tools/generated/data_intelligence/index.js +1495 -0
  85. package/dist/tools/generated/data_intelligence/index.js.map +1 -0
  86. package/dist/tools/generated/ddos/index.d.ts +8 -0
  87. package/dist/tools/generated/ddos/index.d.ts.map +1 -0
  88. package/dist/tools/generated/ddos/index.js +7427 -0
  89. package/dist/tools/generated/ddos/index.js.map +1 -0
  90. package/dist/tools/generated/dns/index.d.ts +8 -0
  91. package/dist/tools/generated/dns/index.d.ts.map +1 -0
  92. package/dist/tools/generated/dns/index.js +5604 -0
  93. package/dist/tools/generated/dns/index.js.map +1 -0
  94. package/dist/tools/generated/generative_ai/index.d.ts +8 -0
  95. package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
  96. package/dist/tools/generated/generative_ai/index.js +972 -0
  97. package/dist/tools/generated/generative_ai/index.js.map +1 -0
  98. package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
  99. package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
  100. package/dist/tools/generated/managed_kubernetes/index.js +2858 -0
  101. package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
  102. package/dist/tools/generated/marketplace/index.d.ts +8 -0
  103. package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
  104. package/dist/tools/generated/marketplace/index.js +4022 -0
  105. package/dist/tools/generated/marketplace/index.js.map +1 -0
  106. package/dist/tools/generated/network/index.d.ts +8 -0
  107. package/dist/tools/generated/network/index.d.ts.map +1 -0
  108. package/dist/tools/generated/network/index.js +11132 -0
  109. package/dist/tools/generated/network/index.js.map +1 -0
  110. package/dist/tools/generated/network_security/index.d.ts +8 -0
  111. package/dist/tools/generated/network_security/index.d.ts.map +1 -0
  112. package/dist/tools/generated/network_security/index.js +7827 -0
  113. package/dist/tools/generated/network_security/index.js.map +1 -0
  114. package/dist/tools/generated/nginx_one/index.d.ts +8 -0
  115. package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
  116. package/dist/tools/generated/nginx_one/index.js +1598 -0
  117. package/dist/tools/generated/nginx_one/index.js.map +1 -0
  118. package/dist/tools/generated/object_storage/index.d.ts +8 -0
  119. package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
  120. package/dist/tools/generated/object_storage/index.js +964 -0
  121. package/dist/tools/generated/object_storage/index.js.map +1 -0
  122. package/dist/tools/generated/observability/index.d.ts.map +1 -1
  123. package/dist/tools/generated/observability/index.js +3521 -4641
  124. package/dist/tools/generated/observability/index.js.map +1 -1
  125. package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
  126. package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
  127. package/dist/tools/generated/rate_limiting/index.js +1712 -0
  128. package/dist/tools/generated/rate_limiting/index.js.map +1 -0
  129. package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
  130. package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
  131. package/dist/tools/generated/secops_and_incident_response/index.js +578 -0
  132. package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
  133. package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
  134. package/dist/tools/generated/service_mesh/index.js +3810 -438
  135. package/dist/tools/generated/service_mesh/index.js.map +1 -1
  136. package/dist/tools/generated/shape/index.d.ts +8 -0
  137. package/dist/tools/generated/shape/index.d.ts.map +1 -0
  138. package/dist/tools/generated/shape/index.js +18464 -0
  139. package/dist/tools/generated/shape/index.js.map +1 -0
  140. package/dist/tools/generated/sites/index.d.ts +8 -0
  141. package/dist/tools/generated/sites/index.d.ts.map +1 -0
  142. package/dist/tools/generated/sites/index.js +11494 -0
  143. package/dist/tools/generated/sites/index.js.map +1 -0
  144. package/dist/tools/generated/statistics/index.d.ts +8 -0
  145. package/dist/tools/generated/statistics/index.d.ts.map +1 -0
  146. package/dist/tools/generated/statistics/index.js +7557 -0
  147. package/dist/tools/generated/statistics/index.js.map +1 -0
  148. package/dist/tools/generated/support/index.d.ts +8 -0
  149. package/dist/tools/generated/support/index.d.ts.map +1 -0
  150. package/dist/tools/generated/support/index.js +5334 -0
  151. package/dist/tools/generated/support/index.js.map +1 -0
  152. package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
  153. package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
  154. package/dist/tools/generated/telemetry_and_insights/index.js +2304 -0
  155. package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
  156. package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
  157. package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
  158. package/dist/tools/generated/tenant_and_identity/index.js +17560 -0
  159. package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
  160. package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
  161. package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
  162. package/dist/tools/generated/threat_campaign/index.js +99 -0
  163. package/dist/tools/generated/threat_campaign/index.js.map +1 -0
  164. package/dist/tools/generated/users/index.d.ts +8 -0
  165. package/dist/tools/generated/users/index.d.ts.map +1 -0
  166. package/dist/tools/generated/users/index.js +1376 -0
  167. package/dist/tools/generated/users/index.js.map +1 -0
  168. package/dist/tools/generated/virtual/index.d.ts +8 -0
  169. package/dist/tools/generated/virtual/index.d.ts.map +1 -0
  170. package/dist/tools/generated/virtual/index.js +10103 -0
  171. package/dist/tools/generated/virtual/index.js.map +1 -0
  172. package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
  173. package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
  174. package/dist/tools/generated/vpm_and_node_management/index.js +85 -0
  175. package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
  176. package/dist/tools/generated/waf/index.d.ts +8 -0
  177. package/dist/tools/generated/waf/index.d.ts.map +1 -0
  178. package/dist/tools/generated/waf/index.js +3802 -0
  179. package/dist/tools/generated/waf/index.js.map +1 -0
  180. package/dist/tools/registry.d.ts.map +1 -1
  181. package/dist/tools/registry.js +68 -36
  182. package/dist/tools/registry.js.map +1 -1
  183. package/package.json +3 -1
  184. package/dist/cli/index.d.ts +0 -16
  185. package/dist/cli/index.d.ts.map +0 -1
  186. package/dist/cli/index.js +0 -116
  187. package/dist/cli/index.js.map +0 -1
  188. package/dist/cli/setup.d.ts +0 -54
  189. package/dist/cli/setup.d.ts.map +0 -1
  190. package/dist/cli/setup.js +0 -347
  191. package/dist/cli/setup.js.map +0 -1
  192. package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
  193. package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
  194. package/dist/tools/generated/ai_intelligence/index.js +0 -282
  195. package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
  196. package/dist/tools/generated/api_security/index.d.ts +0 -8
  197. package/dist/tools/generated/api_security/index.d.ts.map +0 -1
  198. package/dist/tools/generated/api_security/index.js +0 -1852
  199. package/dist/tools/generated/api_security/index.js.map +0 -1
  200. package/dist/tools/generated/applications/index.d.ts +0 -8
  201. package/dist/tools/generated/applications/index.d.ts.map +0 -1
  202. package/dist/tools/generated/applications/index.js +0 -1589
  203. package/dist/tools/generated/applications/index.js.map +0 -1
  204. package/dist/tools/generated/billing/index.d.ts +0 -8
  205. package/dist/tools/generated/billing/index.d.ts.map +0 -1
  206. package/dist/tools/generated/billing/index.js +0 -759
  207. package/dist/tools/generated/billing/index.js.map +0 -1
  208. package/dist/tools/generated/config/index.d.ts +0 -8
  209. package/dist/tools/generated/config/index.d.ts.map +0 -1
  210. package/dist/tools/generated/config/index.js +0 -316
  211. package/dist/tools/generated/config/index.js.map +0 -1
  212. package/dist/tools/generated/identity/index.d.ts +0 -8
  213. package/dist/tools/generated/identity/index.d.ts.map +0 -1
  214. package/dist/tools/generated/identity/index.js +0 -5371
  215. package/dist/tools/generated/identity/index.js.map +0 -1
  216. package/dist/tools/generated/infrastructure/index.d.ts +0 -8
  217. package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
  218. package/dist/tools/generated/infrastructure/index.js +0 -5342
  219. package/dist/tools/generated/infrastructure/index.js.map +0 -1
  220. package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
  221. package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
  222. package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
  223. package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
  224. package/dist/tools/generated/integrations/index.d.ts +0 -8
  225. package/dist/tools/generated/integrations/index.d.ts.map +0 -1
  226. package/dist/tools/generated/integrations/index.js +0 -1995
  227. package/dist/tools/generated/integrations/index.js.map +0 -1
  228. package/dist/tools/generated/load_balancer/index.d.ts +0 -8
  229. package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
  230. package/dist/tools/generated/load_balancer/index.js +0 -2269
  231. package/dist/tools/generated/load_balancer/index.js.map +0 -1
  232. package/dist/tools/generated/networking/index.d.ts +0 -8
  233. package/dist/tools/generated/networking/index.d.ts.map +0 -1
  234. package/dist/tools/generated/networking/index.js +0 -11289
  235. package/dist/tools/generated/networking/index.js.map +0 -1
  236. package/dist/tools/generated/nginx/index.d.ts +0 -8
  237. package/dist/tools/generated/nginx/index.d.ts.map +0 -1
  238. package/dist/tools/generated/nginx/index.js +0 -680
  239. package/dist/tools/generated/nginx/index.js.map +0 -1
  240. package/dist/tools/generated/operations/index.d.ts +0 -8
  241. package/dist/tools/generated/operations/index.d.ts.map +0 -1
  242. package/dist/tools/generated/operations/index.js +0 -1759
  243. package/dist/tools/generated/operations/index.js.map +0 -1
  244. package/dist/tools/generated/security/index.d.ts +0 -8
  245. package/dist/tools/generated/security/index.d.ts.map +0 -1
  246. package/dist/tools/generated/security/index.js +0 -9111
  247. package/dist/tools/generated/security/index.js.map +0 -1
  248. package/dist/tools/generated/shape_security/index.d.ts +0 -8
  249. package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
  250. package/dist/tools/generated/shape_security/index.js +0 -4121
  251. package/dist/tools/generated/shape_security/index.js.map +0 -1
  252. package/dist/tools/generated/subscriptions/index.d.ts +0 -8
  253. package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
  254. package/dist/tools/generated/subscriptions/index.js +0 -778
  255. package/dist/tools/generated/subscriptions/index.js.map +0 -1
  256. package/dist/tools/generated/tenant_management/index.d.ts +0 -8
  257. package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
  258. package/dist/tools/generated/tenant_management/index.js +0 -2292
  259. package/dist/tools/generated/tenant_management/index.js.map +0 -1
  260. package/dist/tools/generated/vpn/index.d.ts +0 -8
  261. package/dist/tools/generated/vpn/index.js +0 -1183
  262. package/dist/tools/generated/vpn/index.js.map +0 -1
@@ -0,0 +1,3437 @@
1
+ /**
2
+ * Generated tool definitions for ce_management domain
3
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
4
+ */
5
+ export const ce_managementTools = [
6
+ {
7
+ toolName: "f5xc-api-cemanagement-approve-create",
8
+ method: "POST",
9
+ path: "/api/register/namespaces/{namespace}/registration/{name}/approve",
10
+ operation: "create",
11
+ domain: "ce_management",
12
+ resource: "approve",
13
+ summary: "Registration Approve.",
14
+ description: "RegistrationApprove approved pending registration and it can also decommission by changing state to RETIRED.",
15
+ pathParameters: [
16
+ {
17
+ description: 'Name\n\nx-required\nRegistration name (= "r-" + uid) to approve. Registration name is taken from listing pending registrations.',
18
+ in: "path",
19
+ name: "name",
20
+ required: true,
21
+ schema: {
22
+ type: "string",
23
+ },
24
+ "x-displayname": "Name",
25
+ "x-ves-example": "R-e9030963-639e-41cd-aba6-261504f4a6be.",
26
+ },
27
+ {
28
+ description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
29
+ in: "path",
30
+ name: "namespace",
31
+ required: true,
32
+ schema: {
33
+ type: "string",
34
+ },
35
+ "x-displayname": "Namespace",
36
+ "x-ves-example": "System",
37
+ },
38
+ ],
39
+ queryParameters: [],
40
+ requestBodySchema: {
41
+ $ref: "#/components/schemas/registrationApprovalReq",
42
+ },
43
+ responseSchema: {
44
+ $ref: "#/components/schemas/registrationObjectChangeResp",
45
+ },
46
+ requiredParams: ["body", "name", "namespace"],
47
+ operationId: "ves.io.schema.registration.CustomAPI.RegistrationApprove",
48
+ tags: ["Infrastructure"],
49
+ sourceFile: "domains/ce_management.json",
50
+ displayName: null,
51
+ dangerLevel: "medium",
52
+ sideEffects: {
53
+ creates: ["approve"],
54
+ },
55
+ requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
56
+ confirmationRequired: false,
57
+ parameterExamples: {
58
+ name: "R-e9030963-639e-41cd-aba6-261504f4a6be.",
59
+ namespace: "System",
60
+ },
61
+ validationRules: {},
62
+ operationMetadata: {
63
+ common_errors: [
64
+ {
65
+ code: 401,
66
+ message: "Authentication required",
67
+ solution: "Provide valid API credentials",
68
+ },
69
+ {
70
+ code: 403,
71
+ message: "Permission denied",
72
+ solution: "Check access permissions for this operation",
73
+ },
74
+ {
75
+ code: 404,
76
+ message: "Resource not found",
77
+ solution: "Verify resource name, namespace, and path",
78
+ },
79
+ {
80
+ code: 409,
81
+ message: "Resource already exists",
82
+ solution: "Use different name or update existing resource",
83
+ },
84
+ {
85
+ code: 429,
86
+ message: "Rate limit exceeded",
87
+ solution: "Wait before retrying the operation",
88
+ },
89
+ {
90
+ code: 500,
91
+ message: "Server error",
92
+ solution: "Retry operation or contact support",
93
+ },
94
+ ],
95
+ conditions: {
96
+ postconditions: ["Approve resource created", "Resource assigned unique identifier"],
97
+ prerequisites: ["Active namespace"],
98
+ },
99
+ confirmation_required: false,
100
+ danger_level: "medium",
101
+ field_docs: {},
102
+ optional_fields: [],
103
+ performance_impact: {
104
+ latency: "low",
105
+ resource_usage: "low",
106
+ },
107
+ purpose: "Create new approve",
108
+ required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
109
+ side_effects: {
110
+ creates: ["approve"],
111
+ },
112
+ },
113
+ curlExample: null,
114
+ },
115
+ {
116
+ toolName: "f5xc-api-cemanagement-fleet-create",
117
+ method: "POST",
118
+ path: "/api/config/namespaces/{metadata.namespace}/fleets",
119
+ operation: "create",
120
+ domain: "ce_management",
121
+ resource: "fleet",
122
+ summary: "Create Fleet.",
123
+ description: "Create fleet will create a fleet object in 'system' namespace of the user.",
124
+ pathParameters: [
125
+ {
126
+ 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 ""',
127
+ in: "path",
128
+ name: "metadata.namespace",
129
+ required: true,
130
+ schema: {
131
+ type: "string",
132
+ },
133
+ "x-displayname": "Namespace",
134
+ "x-ves-example": "Staging",
135
+ },
136
+ ],
137
+ queryParameters: [],
138
+ requestBodySchema: {
139
+ $ref: "#/components/schemas/fleetCreateRequest",
140
+ },
141
+ responseSchema: {
142
+ $ref: "#/components/schemas/fleetCreateResponse",
143
+ },
144
+ requiredParams: ["body", "metadata.namespace"],
145
+ operationId: "ves.io.schema.fleet.API.Create",
146
+ tags: ["Other"],
147
+ sourceFile: "domains/ce_management.json",
148
+ displayName: null,
149
+ dangerLevel: "medium",
150
+ sideEffects: {
151
+ creates: ["fleet"],
152
+ },
153
+ requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
154
+ confirmationRequired: false,
155
+ parameterExamples: {
156
+ "metadata.namespace": "Staging",
157
+ },
158
+ validationRules: {},
159
+ operationMetadata: {
160
+ common_errors: [
161
+ {
162
+ code: 401,
163
+ message: "Authentication required",
164
+ solution: "Provide valid API credentials",
165
+ },
166
+ {
167
+ code: 403,
168
+ message: "Permission denied",
169
+ solution: "Check access permissions for this operation",
170
+ },
171
+ {
172
+ code: 404,
173
+ message: "Resource not found",
174
+ solution: "Verify resource name, namespace, and path",
175
+ },
176
+ {
177
+ code: 409,
178
+ message: "Resource already exists",
179
+ solution: "Use different name or update existing resource",
180
+ },
181
+ {
182
+ code: 429,
183
+ message: "Rate limit exceeded",
184
+ solution: "Wait before retrying the operation",
185
+ },
186
+ {
187
+ code: 500,
188
+ message: "Server error",
189
+ solution: "Retry operation or contact support",
190
+ },
191
+ ],
192
+ conditions: {
193
+ postconditions: ["Fleet resource created", "Resource assigned unique identifier"],
194
+ prerequisites: ["Active namespace"],
195
+ },
196
+ confirmation_required: false,
197
+ danger_level: "medium",
198
+ field_docs: {},
199
+ optional_fields: [],
200
+ performance_impact: {
201
+ latency: "low",
202
+ resource_usage: "low",
203
+ },
204
+ purpose: "Create new fleet",
205
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
206
+ side_effects: {
207
+ creates: ["fleet"],
208
+ },
209
+ },
210
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/fleets" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
211
+ },
212
+ {
213
+ toolName: "f5xc-api-cemanagement-fleet-delete",
214
+ method: "DELETE",
215
+ path: "/api/config/namespaces/{namespace}/fleets/{name}",
216
+ operation: "delete",
217
+ domain: "ce_management",
218
+ resource: "fleet",
219
+ summary: "DELETE Fleet.",
220
+ description: "DELETE the specified fleet.",
221
+ pathParameters: [
222
+ {
223
+ description: "Name\nName of the configuration object.",
224
+ in: "path",
225
+ name: "name",
226
+ required: true,
227
+ schema: {
228
+ type: "string",
229
+ },
230
+ "x-displayname": "Name",
231
+ "x-ves-example": "Name",
232
+ },
233
+ {
234
+ description: "Namespace\nNamespace in which the configuration object is present.",
235
+ in: "path",
236
+ name: "namespace",
237
+ required: true,
238
+ schema: {
239
+ type: "string",
240
+ },
241
+ "x-displayname": "Namespace",
242
+ "x-ves-example": "Ns1",
243
+ },
244
+ ],
245
+ queryParameters: [],
246
+ requestBodySchema: {
247
+ $ref: "#/components/schemas/fleetDeleteRequest",
248
+ },
249
+ responseSchema: {},
250
+ requiredParams: ["body", "name", "namespace"],
251
+ operationId: "ves.io.schema.fleet.API.Delete",
252
+ tags: ["Other"],
253
+ sourceFile: "domains/ce_management.json",
254
+ displayName: null,
255
+ dangerLevel: "high",
256
+ sideEffects: {
257
+ deletes: ["fleet", "contained_resources"],
258
+ },
259
+ requiredFields: ["path.name", "path.namespace"],
260
+ confirmationRequired: true,
261
+ parameterExamples: {
262
+ name: "Name",
263
+ namespace: "Ns1",
264
+ },
265
+ validationRules: {},
266
+ operationMetadata: {
267
+ common_errors: [
268
+ {
269
+ code: 401,
270
+ message: "Authentication required",
271
+ solution: "Provide valid API credentials",
272
+ },
273
+ {
274
+ code: 403,
275
+ message: "Permission denied",
276
+ solution: "Check access permissions for this operation",
277
+ },
278
+ {
279
+ code: 404,
280
+ message: "Resource not found",
281
+ solution: "Verify resource name, namespace, and path",
282
+ },
283
+ {
284
+ code: 409,
285
+ message: "Resource already exists",
286
+ solution: "Use different name or update existing resource",
287
+ },
288
+ {
289
+ code: 429,
290
+ message: "Rate limit exceeded",
291
+ solution: "Wait before retrying the operation",
292
+ },
293
+ {
294
+ code: 500,
295
+ message: "Server error",
296
+ solution: "Retry operation or contact support",
297
+ },
298
+ ],
299
+ conditions: {
300
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
301
+ prerequisites: ["Active namespace"],
302
+ },
303
+ confirmation_required: true,
304
+ danger_level: "high",
305
+ field_docs: {},
306
+ optional_fields: [],
307
+ performance_impact: {
308
+ latency: "high",
309
+ resource_usage: "moderate",
310
+ },
311
+ purpose: "Delete fleet",
312
+ required_fields: ["path.name", "path.namespace"],
313
+ side_effects: {
314
+ deletes: ["fleet", "contained_resources"],
315
+ },
316
+ },
317
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/fleets" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
318
+ },
319
+ {
320
+ toolName: "f5xc-api-cemanagement-fleet-get",
321
+ method: "GET",
322
+ path: "/api/config/namespaces/{namespace}/fleets/{name}",
323
+ operation: "get",
324
+ domain: "ce_management",
325
+ resource: "fleet",
326
+ summary: "GET Fleet",
327
+ description: "GET fleet will GET fleet object from system namespace.",
328
+ pathParameters: [
329
+ {
330
+ description: "Name\nThe name of the configuration object to be fetched.",
331
+ in: "path",
332
+ name: "name",
333
+ required: true,
334
+ schema: {
335
+ type: "string",
336
+ },
337
+ "x-displayname": "Name",
338
+ "x-ves-example": "Name",
339
+ },
340
+ {
341
+ description: "Namespace\nThe namespace in which the configuration object is present.",
342
+ in: "path",
343
+ name: "namespace",
344
+ required: true,
345
+ schema: {
346
+ type: "string",
347
+ },
348
+ "x-displayname": "Namespace",
349
+ "x-ves-example": "Ns1",
350
+ },
351
+ ],
352
+ queryParameters: [
353
+ {
354
+ 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.",
355
+ in: "query",
356
+ name: "response_format",
357
+ required: false,
358
+ schema: {
359
+ default: "GET_RSP_FORMAT_DEFAULT",
360
+ enum: [
361
+ "GET_RSP_FORMAT_DEFAULT",
362
+ "GET_RSP_FORMAT_FOR_CREATE",
363
+ "GET_RSP_FORMAT_FOR_REPLACE",
364
+ "GET_RSP_FORMAT_STATUS",
365
+ "GET_RSP_FORMAT_READ",
366
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
367
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
368
+ ],
369
+ type: "string",
370
+ },
371
+ "x-displayname": "Broken Referred Objects.",
372
+ },
373
+ ],
374
+ requestBodySchema: null,
375
+ responseSchema: {
376
+ $ref: "#/components/schemas/fleetGetResponse",
377
+ },
378
+ requiredParams: ["name", "namespace"],
379
+ operationId: "ves.io.schema.fleet.API.Get",
380
+ tags: ["Other"],
381
+ sourceFile: "domains/ce_management.json",
382
+ displayName: null,
383
+ dangerLevel: "low",
384
+ sideEffects: null,
385
+ requiredFields: ["path.name", "path.namespace"],
386
+ confirmationRequired: false,
387
+ parameterExamples: {
388
+ name: "Name",
389
+ namespace: "Ns1",
390
+ },
391
+ validationRules: {},
392
+ operationMetadata: {
393
+ common_errors: [
394
+ {
395
+ code: 401,
396
+ message: "Authentication required",
397
+ solution: "Provide valid API credentials",
398
+ },
399
+ {
400
+ code: 403,
401
+ message: "Permission denied",
402
+ solution: "Check access permissions for this operation",
403
+ },
404
+ {
405
+ code: 404,
406
+ message: "Resource not found",
407
+ solution: "Verify resource name, namespace, and path",
408
+ },
409
+ {
410
+ code: 409,
411
+ message: "Resource already exists",
412
+ solution: "Use different name or update existing resource",
413
+ },
414
+ {
415
+ code: 429,
416
+ message: "Rate limit exceeded",
417
+ solution: "Wait before retrying the operation",
418
+ },
419
+ {
420
+ code: 500,
421
+ message: "Server error",
422
+ solution: "Retry operation or contact support",
423
+ },
424
+ ],
425
+ conditions: {
426
+ postconditions: [],
427
+ prerequisites: ["Active namespace"],
428
+ },
429
+ confirmation_required: false,
430
+ danger_level: "low",
431
+ field_docs: {},
432
+ optional_fields: [],
433
+ performance_impact: {
434
+ latency: "low",
435
+ resource_usage: "low",
436
+ },
437
+ purpose: "Retrieve specific fleet",
438
+ required_fields: ["path.name", "path.namespace"],
439
+ side_effects: {},
440
+ },
441
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/fleets" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
442
+ },
443
+ {
444
+ toolName: "f5xc-api-cemanagement-fleet-list",
445
+ method: "GET",
446
+ path: "/api/config/namespaces/{namespace}/fleets",
447
+ operation: "list",
448
+ domain: "ce_management",
449
+ resource: "fleet",
450
+ summary: "List Fleet.",
451
+ description: "List the set of fleet in a namespace.",
452
+ pathParameters: [
453
+ {
454
+ description: "Namespace\nNamespace to scope the listing of fleet.",
455
+ in: "path",
456
+ name: "namespace",
457
+ required: true,
458
+ schema: {
459
+ type: "string",
460
+ },
461
+ "x-displayname": "Namespace",
462
+ "x-ves-example": "Ns1",
463
+ },
464
+ ],
465
+ queryParameters: [
466
+ {
467
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
468
+ in: "query",
469
+ name: "label_filter",
470
+ required: false,
471
+ schema: {
472
+ type: "string",
473
+ },
474
+ "x-displayname": "Label Filter.",
475
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
476
+ },
477
+ {
478
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
479
+ in: "query",
480
+ name: "report_fields",
481
+ required: false,
482
+ schema: {
483
+ items: {
484
+ type: "string",
485
+ },
486
+ type: "array",
487
+ },
488
+ "x-displayname": "Report Fields.",
489
+ },
490
+ {
491
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
492
+ in: "query",
493
+ name: "report_status_fields",
494
+ required: false,
495
+ schema: {
496
+ items: {
497
+ type: "string",
498
+ },
499
+ type: "array",
500
+ },
501
+ "x-displayname": "Report Status Fields.",
502
+ },
503
+ ],
504
+ requestBodySchema: null,
505
+ responseSchema: {
506
+ $ref: "#/components/schemas/fleetListResponse",
507
+ },
508
+ requiredParams: ["namespace"],
509
+ operationId: "ves.io.schema.fleet.API.List",
510
+ tags: ["Other"],
511
+ sourceFile: "domains/ce_management.json",
512
+ displayName: null,
513
+ dangerLevel: "low",
514
+ sideEffects: null,
515
+ requiredFields: ["path.namespace"],
516
+ confirmationRequired: false,
517
+ parameterExamples: {
518
+ label_filter: "Env in (staging, testing), tier in (web, db)",
519
+ namespace: "Ns1",
520
+ },
521
+ validationRules: {},
522
+ operationMetadata: {
523
+ common_errors: [
524
+ {
525
+ code: 401,
526
+ message: "Authentication required",
527
+ solution: "Provide valid API credentials",
528
+ },
529
+ {
530
+ code: 403,
531
+ message: "Permission denied",
532
+ solution: "Check access permissions for this operation",
533
+ },
534
+ {
535
+ code: 404,
536
+ message: "Resource not found",
537
+ solution: "Verify resource name, namespace, and path",
538
+ },
539
+ {
540
+ code: 409,
541
+ message: "Resource already exists",
542
+ solution: "Use different name or update existing resource",
543
+ },
544
+ {
545
+ code: 429,
546
+ message: "Rate limit exceeded",
547
+ solution: "Wait before retrying the operation",
548
+ },
549
+ {
550
+ code: 500,
551
+ message: "Server error",
552
+ solution: "Retry operation or contact support",
553
+ },
554
+ ],
555
+ conditions: {
556
+ postconditions: [],
557
+ prerequisites: ["Active namespace"],
558
+ },
559
+ confirmation_required: false,
560
+ danger_level: "low",
561
+ field_docs: {},
562
+ optional_fields: [],
563
+ performance_impact: {
564
+ latency: "moderate",
565
+ resource_usage: "moderate",
566
+ },
567
+ purpose: "List all fleets",
568
+ required_fields: ["path.namespace"],
569
+ side_effects: {},
570
+ },
571
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/fleets" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
572
+ },
573
+ {
574
+ toolName: "f5xc-api-cemanagement-fleet-update",
575
+ method: "PUT",
576
+ path: "/api/config/namespaces/{metadata.namespace}/fleets/{metadata.name}",
577
+ operation: "update",
578
+ domain: "ce_management",
579
+ resource: "fleet",
580
+ summary: "Replace Fleet.",
581
+ description: "Replace fleet will replace the contents of given fleet object.",
582
+ pathParameters: [
583
+ {
584
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
585
+ in: "path",
586
+ name: "metadata.name",
587
+ required: true,
588
+ schema: {
589
+ type: "string",
590
+ },
591
+ "x-displayname": "Name",
592
+ "x-ves-example": "Example-corp-web.",
593
+ },
594
+ {
595
+ 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 ""',
596
+ in: "path",
597
+ name: "metadata.namespace",
598
+ required: true,
599
+ schema: {
600
+ type: "string",
601
+ },
602
+ "x-displayname": "Namespace",
603
+ "x-ves-example": "Staging",
604
+ },
605
+ ],
606
+ queryParameters: [],
607
+ requestBodySchema: {
608
+ $ref: "#/components/schemas/fleetReplaceRequest",
609
+ },
610
+ responseSchema: {
611
+ $ref: "#/components/schemas/fleetReplaceResponse",
612
+ },
613
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
614
+ operationId: "ves.io.schema.fleet.API.Replace",
615
+ tags: ["Other"],
616
+ sourceFile: "domains/ce_management.json",
617
+ displayName: null,
618
+ dangerLevel: "medium",
619
+ sideEffects: {
620
+ modifies: ["fleet"],
621
+ },
622
+ requiredFields: ["path.metadata.name", "path.metadata.namespace"],
623
+ confirmationRequired: false,
624
+ parameterExamples: {
625
+ "metadata.name": "Example-corp-web.",
626
+ "metadata.namespace": "Staging",
627
+ },
628
+ validationRules: {},
629
+ operationMetadata: {
630
+ common_errors: [
631
+ {
632
+ code: 401,
633
+ message: "Authentication required",
634
+ solution: "Provide valid API credentials",
635
+ },
636
+ {
637
+ code: 403,
638
+ message: "Permission denied",
639
+ solution: "Check access permissions for this operation",
640
+ },
641
+ {
642
+ code: 404,
643
+ message: "Resource not found",
644
+ solution: "Verify resource name, namespace, and path",
645
+ },
646
+ {
647
+ code: 409,
648
+ message: "Resource already exists",
649
+ solution: "Use different name or update existing resource",
650
+ },
651
+ {
652
+ code: 429,
653
+ message: "Rate limit exceeded",
654
+ solution: "Wait before retrying the operation",
655
+ },
656
+ {
657
+ code: 500,
658
+ message: "Server error",
659
+ solution: "Retry operation or contact support",
660
+ },
661
+ ],
662
+ conditions: {
663
+ postconditions: ["Resource updated with new values"],
664
+ prerequisites: ["Active namespace"],
665
+ },
666
+ confirmation_required: false,
667
+ danger_level: "medium",
668
+ field_docs: {},
669
+ optional_fields: [],
670
+ performance_impact: {
671
+ latency: "low",
672
+ resource_usage: "low",
673
+ },
674
+ purpose: "Replace existing fleet",
675
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
676
+ side_effects: {
677
+ modifies: ["fleet"],
678
+ },
679
+ },
680
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/fleets" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
681
+ },
682
+ {
683
+ toolName: "f5xc-api-cemanagement-get-image-download-url-create",
684
+ method: "POST",
685
+ path: "/api/register/namespaces/system/get-image-download-url",
686
+ operation: "create",
687
+ domain: "ce_management",
688
+ resource: "get-image-download-url",
689
+ summary: "GET Image Download URL.",
690
+ description: "Returns image download URL for each provider.",
691
+ pathParameters: [],
692
+ queryParameters: [],
693
+ requestBodySchema: {
694
+ $ref: "#/components/schemas/registrationGetImageDownloadUrlReq",
695
+ },
696
+ responseSchema: {
697
+ $ref: "#/components/schemas/registrationGetImageDownloadUrlResp",
698
+ },
699
+ requiredParams: ["body"],
700
+ operationId: "ves.io.schema.registration.CustomAPI.GetImageDownloadUrl",
701
+ tags: ["Other"],
702
+ sourceFile: "domains/ce_management.json",
703
+ displayName: null,
704
+ dangerLevel: "medium",
705
+ sideEffects: {
706
+ creates: ["get-image-download-url"],
707
+ },
708
+ requiredFields: ["metadata.name", "metadata.namespace"],
709
+ confirmationRequired: false,
710
+ parameterExamples: {},
711
+ validationRules: {},
712
+ operationMetadata: {
713
+ common_errors: [
714
+ {
715
+ code: 401,
716
+ message: "Authentication required",
717
+ solution: "Provide valid API credentials",
718
+ },
719
+ {
720
+ code: 403,
721
+ message: "Permission denied",
722
+ solution: "Check access permissions for this operation",
723
+ },
724
+ {
725
+ code: 404,
726
+ message: "Resource not found",
727
+ solution: "Verify resource name, namespace, and path",
728
+ },
729
+ {
730
+ code: 409,
731
+ message: "Resource already exists",
732
+ solution: "Use different name or update existing resource",
733
+ },
734
+ {
735
+ code: 429,
736
+ message: "Rate limit exceeded",
737
+ solution: "Wait before retrying the operation",
738
+ },
739
+ {
740
+ code: 500,
741
+ message: "Server error",
742
+ solution: "Retry operation or contact support",
743
+ },
744
+ ],
745
+ conditions: {
746
+ postconditions: [
747
+ "Get-image-download-url resource created",
748
+ "Resource assigned unique identifier",
749
+ ],
750
+ prerequisites: ["Active namespace"],
751
+ },
752
+ confirmation_required: false,
753
+ danger_level: "medium",
754
+ field_docs: {},
755
+ optional_fields: [],
756
+ performance_impact: {
757
+ latency: "low",
758
+ resource_usage: "low",
759
+ },
760
+ purpose: "Create new get-image-download-url",
761
+ required_fields: ["metadata.name", "metadata.namespace"],
762
+ side_effects: {
763
+ creates: ["get-image-download-url"],
764
+ },
765
+ },
766
+ curlExample: null,
767
+ },
768
+ {
769
+ toolName: "f5xc-api-cemanagement-get-registrations-by-token-create",
770
+ method: "POST",
771
+ path: "/api/register/namespaces/system/get-registrations-by-token",
772
+ operation: "create",
773
+ domain: "ce_management",
774
+ resource: "get-registrations-by-token",
775
+ summary: "GET Registration UID by Site Token.",
776
+ description: "Returns list of registration uids that are using particular site token.",
777
+ pathParameters: [],
778
+ queryParameters: [],
779
+ requestBodySchema: {
780
+ $ref: "#/components/schemas/registrationGetRegistrationsBySiteTokenReq",
781
+ },
782
+ responseSchema: {
783
+ $ref: "#/components/schemas/registrationGetRegistrationsBySiteTokenResp",
784
+ },
785
+ requiredParams: ["body"],
786
+ operationId: "ves.io.schema.registration.CustomAPI.GetRegistrationsBySiteToken",
787
+ tags: ["Other"],
788
+ sourceFile: "domains/ce_management.json",
789
+ displayName: null,
790
+ dangerLevel: "medium",
791
+ sideEffects: {
792
+ creates: ["get-registrations-by-token"],
793
+ },
794
+ requiredFields: ["metadata.name", "metadata.namespace"],
795
+ confirmationRequired: false,
796
+ parameterExamples: {},
797
+ validationRules: {},
798
+ operationMetadata: {
799
+ common_errors: [
800
+ {
801
+ code: 401,
802
+ message: "Authentication required",
803
+ solution: "Provide valid API credentials",
804
+ },
805
+ {
806
+ code: 403,
807
+ message: "Permission denied",
808
+ solution: "Check access permissions for this operation",
809
+ },
810
+ {
811
+ code: 404,
812
+ message: "Resource not found",
813
+ solution: "Verify resource name, namespace, and path",
814
+ },
815
+ {
816
+ code: 409,
817
+ message: "Resource already exists",
818
+ solution: "Use different name or update existing resource",
819
+ },
820
+ {
821
+ code: 429,
822
+ message: "Rate limit exceeded",
823
+ solution: "Wait before retrying the operation",
824
+ },
825
+ {
826
+ code: 500,
827
+ message: "Server error",
828
+ solution: "Retry operation or contact support",
829
+ },
830
+ ],
831
+ conditions: {
832
+ postconditions: [
833
+ "Get-registrations-by-token resource created",
834
+ "Resource assigned unique identifier",
835
+ ],
836
+ prerequisites: ["Active namespace"],
837
+ },
838
+ confirmation_required: false,
839
+ danger_level: "medium",
840
+ field_docs: {},
841
+ optional_fields: [],
842
+ performance_impact: {
843
+ latency: "low",
844
+ resource_usage: "low",
845
+ },
846
+ purpose: "Create new get-registrations-by-token",
847
+ required_fields: ["metadata.name", "metadata.namespace"],
848
+ side_effects: {
849
+ creates: ["get-registrations-by-token"],
850
+ },
851
+ },
852
+ curlExample: null,
853
+ },
854
+ {
855
+ toolName: "f5xc-api-cemanagement-listregistrationsbystate-create",
856
+ method: "POST",
857
+ path: "/api/register/namespaces/{namespace}/listregistrationsbystate",
858
+ operation: "create",
859
+ domain: "ce_management",
860
+ resource: "listregistrationsbystate",
861
+ summary: "List Registrations By State.",
862
+ description: "API endpoint for returning Registrations by status, e.g APPROVED, NEW, or RETIRED.",
863
+ pathParameters: [
864
+ {
865
+ description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
866
+ in: "path",
867
+ name: "namespace",
868
+ required: true,
869
+ schema: {
870
+ type: "string",
871
+ },
872
+ "x-displayname": "Namespace",
873
+ "x-ves-example": "System",
874
+ },
875
+ ],
876
+ queryParameters: [],
877
+ requestBodySchema: {
878
+ $ref: "#/components/schemas/registrationListStateReq",
879
+ },
880
+ responseSchema: {
881
+ $ref: "#/components/schemas/registrationListResponse",
882
+ },
883
+ requiredParams: ["body", "namespace"],
884
+ operationId: "ves.io.schema.registration.CustomAPI.ListRegistrationsByState",
885
+ tags: ["Other"],
886
+ sourceFile: "domains/ce_management.json",
887
+ displayName: null,
888
+ dangerLevel: "medium",
889
+ sideEffects: {
890
+ creates: ["listregistrationsbystate"],
891
+ },
892
+ requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
893
+ confirmationRequired: false,
894
+ parameterExamples: {
895
+ namespace: "System",
896
+ },
897
+ validationRules: {},
898
+ operationMetadata: {
899
+ common_errors: [
900
+ {
901
+ code: 401,
902
+ message: "Authentication required",
903
+ solution: "Provide valid API credentials",
904
+ },
905
+ {
906
+ code: 403,
907
+ message: "Permission denied",
908
+ solution: "Check access permissions for this operation",
909
+ },
910
+ {
911
+ code: 404,
912
+ message: "Resource not found",
913
+ solution: "Verify resource name, namespace, and path",
914
+ },
915
+ {
916
+ code: 409,
917
+ message: "Resource already exists",
918
+ solution: "Use different name or update existing resource",
919
+ },
920
+ {
921
+ code: 429,
922
+ message: "Rate limit exceeded",
923
+ solution: "Wait before retrying the operation",
924
+ },
925
+ {
926
+ code: 500,
927
+ message: "Server error",
928
+ solution: "Retry operation or contact support",
929
+ },
930
+ ],
931
+ conditions: {
932
+ postconditions: [
933
+ "Listregistrationsbystate resource created",
934
+ "Resource assigned unique identifier",
935
+ ],
936
+ prerequisites: ["Active namespace"],
937
+ },
938
+ confirmation_required: false,
939
+ danger_level: "medium",
940
+ field_docs: {},
941
+ optional_fields: [],
942
+ performance_impact: {
943
+ latency: "low",
944
+ resource_usage: "low",
945
+ },
946
+ purpose: "Create new listregistrationsbystate",
947
+ required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
948
+ side_effects: {
949
+ creates: ["listregistrationsbystate"],
950
+ },
951
+ },
952
+ curlExample: null,
953
+ },
954
+ {
955
+ toolName: "f5xc-api-cemanagement-network-interface-create",
956
+ method: "POST",
957
+ path: "/api/config/namespaces/{metadata.namespace}/network_interfaces",
958
+ operation: "create",
959
+ domain: "ce_management",
960
+ resource: "network-interface",
961
+ summary: "Create Network Interface.",
962
+ description: "Network interface represents configuration of a network device.\nIt is created by users in system namespace.",
963
+ pathParameters: [
964
+ {
965
+ 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 ""',
966
+ in: "path",
967
+ name: "metadata.namespace",
968
+ required: true,
969
+ schema: {
970
+ type: "string",
971
+ },
972
+ "x-displayname": "Namespace",
973
+ "x-ves-example": "Staging",
974
+ },
975
+ ],
976
+ queryParameters: [],
977
+ requestBodySchema: {
978
+ $ref: "#/components/schemas/network_interfaceCreateRequest",
979
+ },
980
+ responseSchema: {
981
+ $ref: "#/components/schemas/network_interfaceCreateResponse",
982
+ },
983
+ requiredParams: ["body", "metadata.namespace"],
984
+ operationId: "ves.io.schema.network_interface.API.Create",
985
+ tags: ["Other"],
986
+ sourceFile: "domains/ce_management.json",
987
+ displayName: null,
988
+ dangerLevel: "medium",
989
+ sideEffects: {
990
+ creates: ["network-interface"],
991
+ },
992
+ requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
993
+ confirmationRequired: false,
994
+ parameterExamples: {
995
+ "metadata.namespace": "Staging",
996
+ },
997
+ validationRules: {},
998
+ operationMetadata: {
999
+ common_errors: [
1000
+ {
1001
+ code: 401,
1002
+ message: "Authentication required",
1003
+ solution: "Provide valid API credentials",
1004
+ },
1005
+ {
1006
+ code: 403,
1007
+ message: "Permission denied",
1008
+ solution: "Check access permissions for this operation",
1009
+ },
1010
+ {
1011
+ code: 404,
1012
+ message: "Resource not found",
1013
+ solution: "Verify resource name, namespace, and path",
1014
+ },
1015
+ {
1016
+ code: 409,
1017
+ message: "Resource already exists",
1018
+ solution: "Use different name or update existing resource",
1019
+ },
1020
+ {
1021
+ code: 429,
1022
+ message: "Rate limit exceeded",
1023
+ solution: "Wait before retrying the operation",
1024
+ },
1025
+ {
1026
+ code: 500,
1027
+ message: "Server error",
1028
+ solution: "Retry operation or contact support",
1029
+ },
1030
+ ],
1031
+ conditions: {
1032
+ postconditions: [
1033
+ "Network-interface resource created",
1034
+ "Resource assigned unique identifier",
1035
+ ],
1036
+ prerequisites: ["Active namespace"],
1037
+ },
1038
+ confirmation_required: false,
1039
+ danger_level: "medium",
1040
+ field_docs: {},
1041
+ optional_fields: [],
1042
+ performance_impact: {
1043
+ latency: "low",
1044
+ resource_usage: "low",
1045
+ },
1046
+ purpose: "Create new network-interface",
1047
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1048
+ side_effects: {
1049
+ creates: ["network-interface"],
1050
+ },
1051
+ },
1052
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/network_interfaces" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
1053
+ },
1054
+ {
1055
+ toolName: "f5xc-api-cemanagement-network-interface-delete",
1056
+ method: "DELETE",
1057
+ path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
1058
+ operation: "delete",
1059
+ domain: "ce_management",
1060
+ resource: "network-interface",
1061
+ summary: "DELETE Network Interface.",
1062
+ description: "DELETE the specified network_interface.",
1063
+ pathParameters: [
1064
+ {
1065
+ description: "Name\nName of the configuration object.",
1066
+ in: "path",
1067
+ name: "name",
1068
+ required: true,
1069
+ schema: {
1070
+ type: "string",
1071
+ },
1072
+ "x-displayname": "Name",
1073
+ "x-ves-example": "Name",
1074
+ },
1075
+ {
1076
+ description: "Namespace\nNamespace in which the configuration object is present.",
1077
+ in: "path",
1078
+ name: "namespace",
1079
+ required: true,
1080
+ schema: {
1081
+ type: "string",
1082
+ },
1083
+ "x-displayname": "Namespace",
1084
+ "x-ves-example": "Ns1",
1085
+ },
1086
+ ],
1087
+ queryParameters: [],
1088
+ requestBodySchema: {
1089
+ $ref: "#/components/schemas/network_interfaceDeleteRequest",
1090
+ },
1091
+ responseSchema: {},
1092
+ requiredParams: ["body", "name", "namespace"],
1093
+ operationId: "ves.io.schema.network_interface.API.Delete",
1094
+ tags: ["Other"],
1095
+ sourceFile: "domains/ce_management.json",
1096
+ displayName: null,
1097
+ dangerLevel: "high",
1098
+ sideEffects: {
1099
+ deletes: ["network-interface", "contained_resources"],
1100
+ },
1101
+ requiredFields: ["path.name", "path.namespace"],
1102
+ confirmationRequired: true,
1103
+ parameterExamples: {
1104
+ name: "Name",
1105
+ namespace: "Ns1",
1106
+ },
1107
+ validationRules: {},
1108
+ operationMetadata: {
1109
+ common_errors: [
1110
+ {
1111
+ code: 401,
1112
+ message: "Authentication required",
1113
+ solution: "Provide valid API credentials",
1114
+ },
1115
+ {
1116
+ code: 403,
1117
+ message: "Permission denied",
1118
+ solution: "Check access permissions for this operation",
1119
+ },
1120
+ {
1121
+ code: 404,
1122
+ message: "Resource not found",
1123
+ solution: "Verify resource name, namespace, and path",
1124
+ },
1125
+ {
1126
+ code: 409,
1127
+ message: "Resource already exists",
1128
+ solution: "Use different name or update existing resource",
1129
+ },
1130
+ {
1131
+ code: 429,
1132
+ message: "Rate limit exceeded",
1133
+ solution: "Wait before retrying the operation",
1134
+ },
1135
+ {
1136
+ code: 500,
1137
+ message: "Server error",
1138
+ solution: "Retry operation or contact support",
1139
+ },
1140
+ ],
1141
+ conditions: {
1142
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
1143
+ prerequisites: ["Active namespace"],
1144
+ },
1145
+ confirmation_required: true,
1146
+ danger_level: "high",
1147
+ field_docs: {},
1148
+ optional_fields: [],
1149
+ performance_impact: {
1150
+ latency: "high",
1151
+ resource_usage: "moderate",
1152
+ },
1153
+ purpose: "Delete network-interface",
1154
+ required_fields: ["path.name", "path.namespace"],
1155
+ side_effects: {
1156
+ deletes: ["network-interface", "contained_resources"],
1157
+ },
1158
+ },
1159
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/network_interfaces" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
1160
+ },
1161
+ {
1162
+ toolName: "f5xc-api-cemanagement-network-interface-get",
1163
+ method: "GET",
1164
+ path: "/api/config/namespaces/{namespace}/network_interfaces/{name}",
1165
+ operation: "get",
1166
+ domain: "ce_management",
1167
+ resource: "network-interface",
1168
+ summary: "GET Network Interface.",
1169
+ description: "GET network interface from system namespace.",
1170
+ pathParameters: [
1171
+ {
1172
+ description: "Name\nThe name of the configuration object to be fetched.",
1173
+ in: "path",
1174
+ name: "name",
1175
+ required: true,
1176
+ schema: {
1177
+ type: "string",
1178
+ },
1179
+ "x-displayname": "Name",
1180
+ "x-ves-example": "Name",
1181
+ },
1182
+ {
1183
+ description: "Namespace\nThe namespace in which the configuration object is present.",
1184
+ in: "path",
1185
+ name: "namespace",
1186
+ required: true,
1187
+ schema: {
1188
+ type: "string",
1189
+ },
1190
+ "x-displayname": "Namespace",
1191
+ "x-ves-example": "Ns1",
1192
+ },
1193
+ ],
1194
+ queryParameters: [
1195
+ {
1196
+ 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.",
1197
+ in: "query",
1198
+ name: "response_format",
1199
+ required: false,
1200
+ schema: {
1201
+ default: "GET_RSP_FORMAT_DEFAULT",
1202
+ enum: [
1203
+ "GET_RSP_FORMAT_DEFAULT",
1204
+ "GET_RSP_FORMAT_FOR_CREATE",
1205
+ "GET_RSP_FORMAT_FOR_REPLACE",
1206
+ "GET_RSP_FORMAT_STATUS",
1207
+ "GET_RSP_FORMAT_READ",
1208
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
1209
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
1210
+ ],
1211
+ type: "string",
1212
+ },
1213
+ "x-displayname": "Broken Referred Objects.",
1214
+ },
1215
+ ],
1216
+ requestBodySchema: null,
1217
+ responseSchema: {
1218
+ $ref: "#/components/schemas/network_interfaceGetResponse",
1219
+ },
1220
+ requiredParams: ["name", "namespace"],
1221
+ operationId: "ves.io.schema.network_interface.API.Get",
1222
+ tags: ["Other"],
1223
+ sourceFile: "domains/ce_management.json",
1224
+ displayName: null,
1225
+ dangerLevel: "low",
1226
+ sideEffects: null,
1227
+ requiredFields: ["path.name", "path.namespace"],
1228
+ confirmationRequired: false,
1229
+ parameterExamples: {
1230
+ name: "Name",
1231
+ namespace: "Ns1",
1232
+ },
1233
+ validationRules: {},
1234
+ operationMetadata: {
1235
+ common_errors: [
1236
+ {
1237
+ code: 401,
1238
+ message: "Authentication required",
1239
+ solution: "Provide valid API credentials",
1240
+ },
1241
+ {
1242
+ code: 403,
1243
+ message: "Permission denied",
1244
+ solution: "Check access permissions for this operation",
1245
+ },
1246
+ {
1247
+ code: 404,
1248
+ message: "Resource not found",
1249
+ solution: "Verify resource name, namespace, and path",
1250
+ },
1251
+ {
1252
+ code: 409,
1253
+ message: "Resource already exists",
1254
+ solution: "Use different name or update existing resource",
1255
+ },
1256
+ {
1257
+ code: 429,
1258
+ message: "Rate limit exceeded",
1259
+ solution: "Wait before retrying the operation",
1260
+ },
1261
+ {
1262
+ code: 500,
1263
+ message: "Server error",
1264
+ solution: "Retry operation or contact support",
1265
+ },
1266
+ ],
1267
+ conditions: {
1268
+ postconditions: [],
1269
+ prerequisites: ["Active namespace"],
1270
+ },
1271
+ confirmation_required: false,
1272
+ danger_level: "low",
1273
+ field_docs: {},
1274
+ optional_fields: [],
1275
+ performance_impact: {
1276
+ latency: "low",
1277
+ resource_usage: "low",
1278
+ },
1279
+ purpose: "Retrieve specific network-interface",
1280
+ required_fields: ["path.name", "path.namespace"],
1281
+ side_effects: {},
1282
+ },
1283
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/network_interfaces" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
1284
+ },
1285
+ {
1286
+ toolName: "f5xc-api-cemanagement-network-interface-list",
1287
+ method: "GET",
1288
+ path: "/api/config/namespaces/{namespace}/network_interfaces",
1289
+ operation: "list",
1290
+ domain: "ce_management",
1291
+ resource: "network-interface",
1292
+ summary: "List Network Interface.",
1293
+ description: "List the set of network_interface in a namespace.",
1294
+ pathParameters: [
1295
+ {
1296
+ description: "Namespace\nNamespace to scope the listing of network_interface.",
1297
+ in: "path",
1298
+ name: "namespace",
1299
+ required: true,
1300
+ schema: {
1301
+ type: "string",
1302
+ },
1303
+ "x-displayname": "Namespace",
1304
+ "x-ves-example": "Ns1",
1305
+ },
1306
+ ],
1307
+ queryParameters: [
1308
+ {
1309
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
1310
+ in: "query",
1311
+ name: "label_filter",
1312
+ required: false,
1313
+ schema: {
1314
+ type: "string",
1315
+ },
1316
+ "x-displayname": "Label Filter.",
1317
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
1318
+ },
1319
+ {
1320
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
1321
+ in: "query",
1322
+ name: "report_fields",
1323
+ required: false,
1324
+ schema: {
1325
+ items: {
1326
+ type: "string",
1327
+ },
1328
+ type: "array",
1329
+ },
1330
+ "x-displayname": "Report Fields.",
1331
+ },
1332
+ {
1333
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
1334
+ in: "query",
1335
+ name: "report_status_fields",
1336
+ required: false,
1337
+ schema: {
1338
+ items: {
1339
+ type: "string",
1340
+ },
1341
+ type: "array",
1342
+ },
1343
+ "x-displayname": "Report Status Fields.",
1344
+ },
1345
+ ],
1346
+ requestBodySchema: null,
1347
+ responseSchema: {
1348
+ $ref: "#/components/schemas/network_interfaceListResponse",
1349
+ },
1350
+ requiredParams: ["namespace"],
1351
+ operationId: "ves.io.schema.network_interface.API.List",
1352
+ tags: ["Other"],
1353
+ sourceFile: "domains/ce_management.json",
1354
+ displayName: null,
1355
+ dangerLevel: "low",
1356
+ sideEffects: null,
1357
+ requiredFields: ["path.namespace"],
1358
+ confirmationRequired: false,
1359
+ parameterExamples: {
1360
+ label_filter: "Env in (staging, testing), tier in (web, db)",
1361
+ namespace: "Ns1",
1362
+ },
1363
+ validationRules: {},
1364
+ operationMetadata: {
1365
+ common_errors: [
1366
+ {
1367
+ code: 401,
1368
+ message: "Authentication required",
1369
+ solution: "Provide valid API credentials",
1370
+ },
1371
+ {
1372
+ code: 403,
1373
+ message: "Permission denied",
1374
+ solution: "Check access permissions for this operation",
1375
+ },
1376
+ {
1377
+ code: 404,
1378
+ message: "Resource not found",
1379
+ solution: "Verify resource name, namespace, and path",
1380
+ },
1381
+ {
1382
+ code: 409,
1383
+ message: "Resource already exists",
1384
+ solution: "Use different name or update existing resource",
1385
+ },
1386
+ {
1387
+ code: 429,
1388
+ message: "Rate limit exceeded",
1389
+ solution: "Wait before retrying the operation",
1390
+ },
1391
+ {
1392
+ code: 500,
1393
+ message: "Server error",
1394
+ solution: "Retry operation or contact support",
1395
+ },
1396
+ ],
1397
+ conditions: {
1398
+ postconditions: [],
1399
+ prerequisites: ["Active namespace"],
1400
+ },
1401
+ confirmation_required: false,
1402
+ danger_level: "low",
1403
+ field_docs: {},
1404
+ optional_fields: [],
1405
+ performance_impact: {
1406
+ latency: "moderate",
1407
+ resource_usage: "moderate",
1408
+ },
1409
+ purpose: "List all network-interfaces",
1410
+ required_fields: ["path.namespace"],
1411
+ side_effects: {},
1412
+ },
1413
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/network_interfaces" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
1414
+ },
1415
+ {
1416
+ toolName: "f5xc-api-cemanagement-network-interface-update",
1417
+ method: "PUT",
1418
+ path: "/api/config/namespaces/{metadata.namespace}/network_interfaces/{metadata.name}",
1419
+ operation: "update",
1420
+ domain: "ce_management",
1421
+ resource: "network-interface",
1422
+ summary: "Replace Network Interface.",
1423
+ description: "Network interface represents configuration of a network device.\nReplace network interface will replace the contents of given network interface object.",
1424
+ pathParameters: [
1425
+ {
1426
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
1427
+ in: "path",
1428
+ name: "metadata.name",
1429
+ required: true,
1430
+ schema: {
1431
+ type: "string",
1432
+ },
1433
+ "x-displayname": "Name",
1434
+ "x-ves-example": "Example-corp-web.",
1435
+ },
1436
+ {
1437
+ 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 ""',
1438
+ in: "path",
1439
+ name: "metadata.namespace",
1440
+ required: true,
1441
+ schema: {
1442
+ type: "string",
1443
+ },
1444
+ "x-displayname": "Namespace",
1445
+ "x-ves-example": "Staging",
1446
+ },
1447
+ ],
1448
+ queryParameters: [],
1449
+ requestBodySchema: {
1450
+ $ref: "#/components/schemas/network_interfaceReplaceRequest",
1451
+ },
1452
+ responseSchema: {
1453
+ $ref: "#/components/schemas/network_interfaceReplaceResponse",
1454
+ },
1455
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
1456
+ operationId: "ves.io.schema.network_interface.API.Replace",
1457
+ tags: ["Other"],
1458
+ sourceFile: "domains/ce_management.json",
1459
+ displayName: null,
1460
+ dangerLevel: "medium",
1461
+ sideEffects: {
1462
+ modifies: ["network-interface"],
1463
+ },
1464
+ requiredFields: ["path.metadata.name", "path.metadata.namespace"],
1465
+ confirmationRequired: false,
1466
+ parameterExamples: {
1467
+ "metadata.name": "Example-corp-web.",
1468
+ "metadata.namespace": "Staging",
1469
+ },
1470
+ validationRules: {},
1471
+ operationMetadata: {
1472
+ common_errors: [
1473
+ {
1474
+ code: 401,
1475
+ message: "Authentication required",
1476
+ solution: "Provide valid API credentials",
1477
+ },
1478
+ {
1479
+ code: 403,
1480
+ message: "Permission denied",
1481
+ solution: "Check access permissions for this operation",
1482
+ },
1483
+ {
1484
+ code: 404,
1485
+ message: "Resource not found",
1486
+ solution: "Verify resource name, namespace, and path",
1487
+ },
1488
+ {
1489
+ code: 409,
1490
+ message: "Resource already exists",
1491
+ solution: "Use different name or update existing resource",
1492
+ },
1493
+ {
1494
+ code: 429,
1495
+ message: "Rate limit exceeded",
1496
+ solution: "Wait before retrying the operation",
1497
+ },
1498
+ {
1499
+ code: 500,
1500
+ message: "Server error",
1501
+ solution: "Retry operation or contact support",
1502
+ },
1503
+ ],
1504
+ conditions: {
1505
+ postconditions: ["Resource updated with new values"],
1506
+ prerequisites: ["Active namespace"],
1507
+ },
1508
+ confirmation_required: false,
1509
+ danger_level: "medium",
1510
+ field_docs: {},
1511
+ optional_fields: [],
1512
+ performance_impact: {
1513
+ latency: "low",
1514
+ resource_usage: "low",
1515
+ },
1516
+ purpose: "Replace existing network-interface",
1517
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
1518
+ side_effects: {
1519
+ modifies: ["network-interface"],
1520
+ },
1521
+ },
1522
+ curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/network_interfaces" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
1523
+ },
1524
+ {
1525
+ toolName: "f5xc-api-cemanagement-pre-upgrade-check-get",
1526
+ method: "GET",
1527
+ path: "/api/maurice/namespaces/{namespace}/sites/{name}/pre_upgrade_check",
1528
+ operation: "get",
1529
+ domain: "ce_management",
1530
+ resource: "pre-upgrade-check",
1531
+ summary: "Pre upgrade check.",
1532
+ description: "API to check if site is ready for upgrade.",
1533
+ pathParameters: [
1534
+ {
1535
+ description: "Name\nFetch upgrade status for the name of site.",
1536
+ in: "path",
1537
+ name: "name",
1538
+ required: true,
1539
+ schema: {
1540
+ type: "string",
1541
+ },
1542
+ "x-displayname": "Site Name",
1543
+ "x-ves-example": "Blogging-app.",
1544
+ },
1545
+ {
1546
+ description: "Namespace\nFetch upgrade status for the given namespace.",
1547
+ in: "path",
1548
+ name: "namespace",
1549
+ required: true,
1550
+ schema: {
1551
+ type: "string",
1552
+ },
1553
+ "x-displayname": "Namespace",
1554
+ "x-ves-example": "Shared",
1555
+ },
1556
+ ],
1557
+ queryParameters: [
1558
+ {
1559
+ description: "Software version to upgrade to.",
1560
+ in: "query",
1561
+ name: "sw_version",
1562
+ required: false,
1563
+ schema: {
1564
+ type: "string",
1565
+ },
1566
+ "x-displayname": "SW Version to upgrade to.",
1567
+ "x-ves-example": "Crt-20241107-1123.",
1568
+ },
1569
+ ],
1570
+ requestBodySchema: null,
1571
+ responseSchema: {
1572
+ $ref: "#/components/schemas/upgrade_statusPreUpgradeCheckResponse",
1573
+ },
1574
+ requiredParams: ["name", "namespace"],
1575
+ operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.PreUpgradeCheck",
1576
+ tags: ["Other"],
1577
+ sourceFile: "domains/ce_management.json",
1578
+ displayName: null,
1579
+ dangerLevel: "low",
1580
+ sideEffects: null,
1581
+ requiredFields: ["path.name", "path.namespace"],
1582
+ confirmationRequired: false,
1583
+ parameterExamples: {
1584
+ name: "Blogging-app.",
1585
+ namespace: "Shared",
1586
+ sw_version: "Crt-20241107-1123.",
1587
+ },
1588
+ validationRules: {},
1589
+ operationMetadata: {
1590
+ common_errors: [
1591
+ {
1592
+ code: 401,
1593
+ message: "Authentication required",
1594
+ solution: "Provide valid API credentials",
1595
+ },
1596
+ {
1597
+ code: 403,
1598
+ message: "Permission denied",
1599
+ solution: "Check access permissions for this operation",
1600
+ },
1601
+ {
1602
+ code: 404,
1603
+ message: "Resource not found",
1604
+ solution: "Verify resource name, namespace, and path",
1605
+ },
1606
+ {
1607
+ code: 409,
1608
+ message: "Resource already exists",
1609
+ solution: "Use different name or update existing resource",
1610
+ },
1611
+ {
1612
+ code: 429,
1613
+ message: "Rate limit exceeded",
1614
+ solution: "Wait before retrying the operation",
1615
+ },
1616
+ {
1617
+ code: 500,
1618
+ message: "Server error",
1619
+ solution: "Retry operation or contact support",
1620
+ },
1621
+ ],
1622
+ conditions: {
1623
+ postconditions: [],
1624
+ prerequisites: ["Active namespace"],
1625
+ },
1626
+ confirmation_required: false,
1627
+ danger_level: "low",
1628
+ field_docs: {},
1629
+ optional_fields: [],
1630
+ performance_impact: {
1631
+ latency: "moderate",
1632
+ resource_usage: "moderate",
1633
+ },
1634
+ purpose: "Retrieve specific pre-upgrade-check",
1635
+ required_fields: ["path.name", "path.namespace"],
1636
+ side_effects: {},
1637
+ },
1638
+ curlExample: null,
1639
+ },
1640
+ {
1641
+ toolName: "f5xc-api-cemanagement-registerbootstrap-create",
1642
+ method: "POST",
1643
+ path: "/api/register/registerBootstrap",
1644
+ operation: "create",
1645
+ domain: "ce_management",
1646
+ resource: "registerBootstrap",
1647
+ summary: "Registration Create.",
1648
+ description: "Registration request to create registration is sent by the node on first boot. User never creates registration on her own.",
1649
+ pathParameters: [],
1650
+ queryParameters: [],
1651
+ requestBodySchema: {
1652
+ $ref: "#/components/schemas/registrationRegistrationCreateRequest",
1653
+ },
1654
+ responseSchema: {
1655
+ $ref: "#/components/schemas/registrationObject",
1656
+ },
1657
+ requiredParams: ["body"],
1658
+ operationId: "ves.io.schema.registration.CustomAPI.RegistrationCreate",
1659
+ tags: ["Other"],
1660
+ sourceFile: "domains/ce_management.json",
1661
+ displayName: null,
1662
+ dangerLevel: "medium",
1663
+ sideEffects: {
1664
+ creates: ["registerBootstrap"],
1665
+ },
1666
+ requiredFields: ["metadata.name", "metadata.namespace"],
1667
+ confirmationRequired: false,
1668
+ parameterExamples: {},
1669
+ validationRules: {},
1670
+ operationMetadata: {
1671
+ common_errors: [
1672
+ {
1673
+ code: 401,
1674
+ message: "Authentication required",
1675
+ solution: "Provide valid API credentials",
1676
+ },
1677
+ {
1678
+ code: 403,
1679
+ message: "Permission denied",
1680
+ solution: "Check access permissions for this operation",
1681
+ },
1682
+ {
1683
+ code: 404,
1684
+ message: "Resource not found",
1685
+ solution: "Verify resource name, namespace, and path",
1686
+ },
1687
+ {
1688
+ code: 409,
1689
+ message: "Resource already exists",
1690
+ solution: "Use different name or update existing resource",
1691
+ },
1692
+ {
1693
+ code: 429,
1694
+ message: "Rate limit exceeded",
1695
+ solution: "Wait before retrying the operation",
1696
+ },
1697
+ {
1698
+ code: 500,
1699
+ message: "Server error",
1700
+ solution: "Retry operation or contact support",
1701
+ },
1702
+ ],
1703
+ conditions: {
1704
+ postconditions: [
1705
+ "Registerbootstrap resource created",
1706
+ "Resource assigned unique identifier",
1707
+ ],
1708
+ prerequisites: [],
1709
+ },
1710
+ confirmation_required: false,
1711
+ danger_level: "medium",
1712
+ field_docs: {},
1713
+ optional_fields: [],
1714
+ performance_impact: {
1715
+ latency: "low",
1716
+ resource_usage: "low",
1717
+ },
1718
+ purpose: "Create new registerBootstrap",
1719
+ required_fields: ["metadata.name", "metadata.namespace"],
1720
+ side_effects: {
1721
+ creates: ["registerBootstrap"],
1722
+ },
1723
+ },
1724
+ curlExample: null,
1725
+ },
1726
+ {
1727
+ toolName: "f5xc-api-cemanagement-registration-create",
1728
+ method: "POST",
1729
+ path: "/api/register/namespaces/{metadata.namespace}/registrations",
1730
+ operation: "create",
1731
+ domain: "ce_management",
1732
+ resource: "registration",
1733
+ summary: "Create Registration.",
1734
+ description: "VPM creates registration using this message, never used by users.",
1735
+ pathParameters: [
1736
+ {
1737
+ 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 ""',
1738
+ in: "path",
1739
+ name: "metadata.namespace",
1740
+ required: true,
1741
+ schema: {
1742
+ type: "string",
1743
+ },
1744
+ "x-displayname": "Namespace",
1745
+ "x-ves-example": "Staging",
1746
+ },
1747
+ ],
1748
+ queryParameters: [],
1749
+ requestBodySchema: {
1750
+ $ref: "#/components/schemas/registrationCreateRequest",
1751
+ },
1752
+ responseSchema: {
1753
+ $ref: "#/components/schemas/registrationCreateResponse",
1754
+ },
1755
+ requiredParams: ["body", "metadata.namespace"],
1756
+ operationId: "ves.io.schema.registration.API.Create",
1757
+ tags: ["Other"],
1758
+ sourceFile: "domains/ce_management.json",
1759
+ displayName: null,
1760
+ dangerLevel: "medium",
1761
+ sideEffects: {
1762
+ creates: ["registration"],
1763
+ },
1764
+ requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1765
+ confirmationRequired: false,
1766
+ parameterExamples: {
1767
+ "metadata.namespace": "Staging",
1768
+ },
1769
+ validationRules: {},
1770
+ operationMetadata: {
1771
+ common_errors: [
1772
+ {
1773
+ code: 401,
1774
+ message: "Authentication required",
1775
+ solution: "Provide valid API credentials",
1776
+ },
1777
+ {
1778
+ code: 403,
1779
+ message: "Permission denied",
1780
+ solution: "Check access permissions for this operation",
1781
+ },
1782
+ {
1783
+ code: 404,
1784
+ message: "Resource not found",
1785
+ solution: "Verify resource name, namespace, and path",
1786
+ },
1787
+ {
1788
+ code: 409,
1789
+ message: "Resource already exists",
1790
+ solution: "Use different name or update existing resource",
1791
+ },
1792
+ {
1793
+ code: 429,
1794
+ message: "Rate limit exceeded",
1795
+ solution: "Wait before retrying the operation",
1796
+ },
1797
+ {
1798
+ code: 500,
1799
+ message: "Server error",
1800
+ solution: "Retry operation or contact support",
1801
+ },
1802
+ ],
1803
+ conditions: {
1804
+ postconditions: ["Registration resource created", "Resource assigned unique identifier"],
1805
+ prerequisites: ["Active namespace"],
1806
+ },
1807
+ confirmation_required: false,
1808
+ danger_level: "medium",
1809
+ field_docs: {},
1810
+ optional_fields: [],
1811
+ performance_impact: {
1812
+ latency: "low",
1813
+ resource_usage: "low",
1814
+ },
1815
+ purpose: "Create new registration",
1816
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
1817
+ side_effects: {
1818
+ creates: ["registration"],
1819
+ },
1820
+ },
1821
+ curlExample: null,
1822
+ },
1823
+ {
1824
+ toolName: "f5xc-api-cemanagement-registration-delete",
1825
+ method: "DELETE",
1826
+ path: "/api/register/namespaces/{namespace}/registrations/{name}",
1827
+ operation: "delete",
1828
+ domain: "ce_management",
1829
+ resource: "registration",
1830
+ summary: "DELETE Registration.",
1831
+ description: "DELETE the specified registration.",
1832
+ pathParameters: [
1833
+ {
1834
+ description: "Name\nName of the configuration object.",
1835
+ in: "path",
1836
+ name: "name",
1837
+ required: true,
1838
+ schema: {
1839
+ type: "string",
1840
+ },
1841
+ "x-displayname": "Name",
1842
+ "x-ves-example": "Name",
1843
+ },
1844
+ {
1845
+ description: "Namespace\nNamespace in which the configuration object is present.",
1846
+ in: "path",
1847
+ name: "namespace",
1848
+ required: true,
1849
+ schema: {
1850
+ type: "string",
1851
+ },
1852
+ "x-displayname": "Namespace",
1853
+ "x-ves-example": "Ns1",
1854
+ },
1855
+ ],
1856
+ queryParameters: [
1857
+ {
1858
+ description: "Fail the DELETE operation if this object is being referred by other objects.",
1859
+ in: "query",
1860
+ name: "fail_if_referred",
1861
+ required: false,
1862
+ schema: {
1863
+ format: "boolean",
1864
+ type: "boolean",
1865
+ },
1866
+ "x-displayname": "Fail-If-Referred.",
1867
+ },
1868
+ ],
1869
+ requestBodySchema: null,
1870
+ responseSchema: {},
1871
+ requiredParams: ["name", "namespace"],
1872
+ operationId: "ves.io.schema.registration.CustomAPI.Delete",
1873
+ tags: ["Other"],
1874
+ sourceFile: "domains/ce_management.json",
1875
+ displayName: null,
1876
+ dangerLevel: "high",
1877
+ sideEffects: {
1878
+ deletes: ["registration", "contained_resources"],
1879
+ },
1880
+ requiredFields: ["path.name", "path.namespace"],
1881
+ confirmationRequired: true,
1882
+ parameterExamples: {
1883
+ name: "Name",
1884
+ namespace: "Ns1",
1885
+ },
1886
+ validationRules: {},
1887
+ operationMetadata: {
1888
+ common_errors: [
1889
+ {
1890
+ code: 401,
1891
+ message: "Authentication required",
1892
+ solution: "Provide valid API credentials",
1893
+ },
1894
+ {
1895
+ code: 403,
1896
+ message: "Permission denied",
1897
+ solution: "Check access permissions for this operation",
1898
+ },
1899
+ {
1900
+ code: 404,
1901
+ message: "Resource not found",
1902
+ solution: "Verify resource name, namespace, and path",
1903
+ },
1904
+ {
1905
+ code: 409,
1906
+ message: "Resource already exists",
1907
+ solution: "Use different name or update existing resource",
1908
+ },
1909
+ {
1910
+ code: 429,
1911
+ message: "Rate limit exceeded",
1912
+ solution: "Wait before retrying the operation",
1913
+ },
1914
+ {
1915
+ code: 500,
1916
+ message: "Server error",
1917
+ solution: "Retry operation or contact support",
1918
+ },
1919
+ ],
1920
+ conditions: {
1921
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
1922
+ prerequisites: ["Active namespace"],
1923
+ },
1924
+ confirmation_required: true,
1925
+ danger_level: "high",
1926
+ field_docs: {},
1927
+ optional_fields: [],
1928
+ performance_impact: {
1929
+ latency: "high",
1930
+ resource_usage: "moderate",
1931
+ },
1932
+ purpose: "Delete registration",
1933
+ required_fields: ["path.name", "path.namespace"],
1934
+ side_effects: {
1935
+ deletes: ["registration", "contained_resources"],
1936
+ },
1937
+ },
1938
+ curlExample: null,
1939
+ },
1940
+ {
1941
+ toolName: "f5xc-api-cemanagement-registration-get",
1942
+ method: "GET",
1943
+ path: "/api/register/namespaces/{namespace}/registrations/{name}",
1944
+ operation: "get",
1945
+ domain: "ce_management",
1946
+ resource: "registration",
1947
+ summary: "GET Registration.",
1948
+ description: "GET registration specification.",
1949
+ pathParameters: [
1950
+ {
1951
+ description: "Name\nThe name of the configuration object to be fetched.",
1952
+ in: "path",
1953
+ name: "name",
1954
+ required: true,
1955
+ schema: {
1956
+ type: "string",
1957
+ },
1958
+ "x-displayname": "Name",
1959
+ "x-ves-example": "Name",
1960
+ },
1961
+ {
1962
+ description: "Namespace\nThe namespace in which the configuration object is present.",
1963
+ in: "path",
1964
+ name: "namespace",
1965
+ required: true,
1966
+ schema: {
1967
+ type: "string",
1968
+ },
1969
+ "x-displayname": "Namespace",
1970
+ "x-ves-example": "Ns1",
1971
+ },
1972
+ ],
1973
+ queryParameters: [
1974
+ {
1975
+ 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 format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
1976
+ in: "query",
1977
+ name: "response_format",
1978
+ required: false,
1979
+ schema: {
1980
+ default: "GET_RSP_FORMAT_DEFAULT",
1981
+ enum: [
1982
+ "GET_RSP_FORMAT_DEFAULT",
1983
+ "GET_RSP_FORMAT_FOR_CREATE",
1984
+ "GET_RSP_FORMAT_FOR_REPLACE",
1985
+ "GET_RSP_FORMAT_READ",
1986
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
1987
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
1988
+ ],
1989
+ type: "string",
1990
+ },
1991
+ "x-displayname": "Broken Referred Objects.",
1992
+ },
1993
+ ],
1994
+ requestBodySchema: null,
1995
+ responseSchema: {
1996
+ $ref: "#/components/schemas/registrationGetResponse",
1997
+ },
1998
+ requiredParams: ["name", "namespace"],
1999
+ operationId: "ves.io.schema.registration.CustomAPI.Get",
2000
+ tags: ["Other"],
2001
+ sourceFile: "domains/ce_management.json",
2002
+ displayName: null,
2003
+ dangerLevel: "low",
2004
+ sideEffects: null,
2005
+ requiredFields: ["path.name", "path.namespace"],
2006
+ confirmationRequired: false,
2007
+ parameterExamples: {
2008
+ name: "Name",
2009
+ namespace: "Ns1",
2010
+ },
2011
+ validationRules: {},
2012
+ operationMetadata: {
2013
+ common_errors: [
2014
+ {
2015
+ code: 401,
2016
+ message: "Authentication required",
2017
+ solution: "Provide valid API credentials",
2018
+ },
2019
+ {
2020
+ code: 403,
2021
+ message: "Permission denied",
2022
+ solution: "Check access permissions for this operation",
2023
+ },
2024
+ {
2025
+ code: 404,
2026
+ message: "Resource not found",
2027
+ solution: "Verify resource name, namespace, and path",
2028
+ },
2029
+ {
2030
+ code: 409,
2031
+ message: "Resource already exists",
2032
+ solution: "Use different name or update existing resource",
2033
+ },
2034
+ {
2035
+ code: 429,
2036
+ message: "Rate limit exceeded",
2037
+ solution: "Wait before retrying the operation",
2038
+ },
2039
+ {
2040
+ code: 500,
2041
+ message: "Server error",
2042
+ solution: "Retry operation or contact support",
2043
+ },
2044
+ ],
2045
+ conditions: {
2046
+ postconditions: [],
2047
+ prerequisites: ["Active namespace"],
2048
+ },
2049
+ confirmation_required: false,
2050
+ danger_level: "low",
2051
+ field_docs: {},
2052
+ optional_fields: [],
2053
+ performance_impact: {
2054
+ latency: "low",
2055
+ resource_usage: "low",
2056
+ },
2057
+ purpose: "Retrieve specific registration",
2058
+ required_fields: ["path.name", "path.namespace"],
2059
+ side_effects: {},
2060
+ },
2061
+ curlExample: null,
2062
+ },
2063
+ {
2064
+ toolName: "f5xc-api-cemanagement-registration-list",
2065
+ method: "GET",
2066
+ path: "/api/register/namespaces/{namespace}/registrations",
2067
+ operation: "list",
2068
+ domain: "ce_management",
2069
+ resource: "registration",
2070
+ summary: "List Registration.",
2071
+ description: "List the set of registration in a namespace.",
2072
+ pathParameters: [
2073
+ {
2074
+ description: "Namespace\nNamespace to scope the listing of registration.",
2075
+ in: "path",
2076
+ name: "namespace",
2077
+ required: true,
2078
+ schema: {
2079
+ type: "string",
2080
+ },
2081
+ "x-displayname": "Namespace",
2082
+ "x-ves-example": "Ns1",
2083
+ },
2084
+ ],
2085
+ queryParameters: [
2086
+ {
2087
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
2088
+ in: "query",
2089
+ name: "label_filter",
2090
+ required: false,
2091
+ schema: {
2092
+ type: "string",
2093
+ },
2094
+ "x-displayname": "Label Filter.",
2095
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
2096
+ },
2097
+ {
2098
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
2099
+ in: "query",
2100
+ name: "report_fields",
2101
+ required: false,
2102
+ schema: {
2103
+ items: {
2104
+ type: "string",
2105
+ },
2106
+ type: "array",
2107
+ },
2108
+ "x-displayname": "Report Fields.",
2109
+ },
2110
+ {
2111
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
2112
+ in: "query",
2113
+ name: "report_status_fields",
2114
+ required: false,
2115
+ schema: {
2116
+ items: {
2117
+ type: "string",
2118
+ },
2119
+ type: "array",
2120
+ },
2121
+ "x-displayname": "Report Status Fields.",
2122
+ },
2123
+ ],
2124
+ requestBodySchema: null,
2125
+ responseSchema: {
2126
+ $ref: "#/components/schemas/registrationListResponse",
2127
+ },
2128
+ requiredParams: ["namespace"],
2129
+ operationId: "ves.io.schema.registration.CustomAPI.List",
2130
+ tags: ["Other"],
2131
+ sourceFile: "domains/ce_management.json",
2132
+ displayName: null,
2133
+ dangerLevel: "low",
2134
+ sideEffects: null,
2135
+ requiredFields: ["path.namespace"],
2136
+ confirmationRequired: false,
2137
+ parameterExamples: {
2138
+ label_filter: "Env in (staging, testing), tier in (web, db)",
2139
+ namespace: "Ns1",
2140
+ },
2141
+ validationRules: {},
2142
+ operationMetadata: {
2143
+ common_errors: [
2144
+ {
2145
+ code: 401,
2146
+ message: "Authentication required",
2147
+ solution: "Provide valid API credentials",
2148
+ },
2149
+ {
2150
+ code: 403,
2151
+ message: "Permission denied",
2152
+ solution: "Check access permissions for this operation",
2153
+ },
2154
+ {
2155
+ code: 404,
2156
+ message: "Resource not found",
2157
+ solution: "Verify resource name, namespace, and path",
2158
+ },
2159
+ {
2160
+ code: 409,
2161
+ message: "Resource already exists",
2162
+ solution: "Use different name or update existing resource",
2163
+ },
2164
+ {
2165
+ code: 429,
2166
+ message: "Rate limit exceeded",
2167
+ solution: "Wait before retrying the operation",
2168
+ },
2169
+ {
2170
+ code: 500,
2171
+ message: "Server error",
2172
+ solution: "Retry operation or contact support",
2173
+ },
2174
+ ],
2175
+ conditions: {
2176
+ postconditions: [],
2177
+ prerequisites: ["Active namespace"],
2178
+ },
2179
+ confirmation_required: false,
2180
+ danger_level: "low",
2181
+ field_docs: {},
2182
+ optional_fields: [],
2183
+ performance_impact: {
2184
+ latency: "moderate",
2185
+ resource_usage: "moderate",
2186
+ },
2187
+ purpose: "List all registrations",
2188
+ required_fields: ["path.namespace"],
2189
+ side_effects: {},
2190
+ },
2191
+ curlExample: null,
2192
+ },
2193
+ {
2194
+ toolName: "f5xc-api-cemanagement-registration-update",
2195
+ method: "PUT",
2196
+ path: "/api/register/namespaces/{metadata.namespace}/registrations/{metadata.name}",
2197
+ operation: "update",
2198
+ domain: "ce_management",
2199
+ resource: "registration",
2200
+ summary: "Replace Registration.",
2201
+ description: "NO fields are allowed to be replaced.",
2202
+ pathParameters: [
2203
+ {
2204
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
2205
+ in: "path",
2206
+ name: "metadata.name",
2207
+ required: true,
2208
+ schema: {
2209
+ type: "string",
2210
+ },
2211
+ "x-displayname": "Name",
2212
+ "x-ves-example": "Example-corp-web.",
2213
+ },
2214
+ {
2215
+ 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 ""',
2216
+ in: "path",
2217
+ name: "metadata.namespace",
2218
+ required: true,
2219
+ schema: {
2220
+ type: "string",
2221
+ },
2222
+ "x-displayname": "Namespace",
2223
+ "x-ves-example": "Staging",
2224
+ },
2225
+ ],
2226
+ queryParameters: [],
2227
+ requestBodySchema: {
2228
+ $ref: "#/components/schemas/registrationReplaceRequest",
2229
+ },
2230
+ responseSchema: {
2231
+ $ref: "#/components/schemas/registrationReplaceResponse",
2232
+ },
2233
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
2234
+ operationId: "ves.io.schema.registration.API.Replace",
2235
+ tags: ["Other"],
2236
+ sourceFile: "domains/ce_management.json",
2237
+ displayName: null,
2238
+ dangerLevel: "medium",
2239
+ sideEffects: {
2240
+ modifies: ["registration"],
2241
+ },
2242
+ requiredFields: ["path.metadata.name", "path.metadata.namespace"],
2243
+ confirmationRequired: false,
2244
+ parameterExamples: {
2245
+ "metadata.name": "Example-corp-web.",
2246
+ "metadata.namespace": "Staging",
2247
+ },
2248
+ validationRules: {},
2249
+ operationMetadata: {
2250
+ common_errors: [
2251
+ {
2252
+ code: 401,
2253
+ message: "Authentication required",
2254
+ solution: "Provide valid API credentials",
2255
+ },
2256
+ {
2257
+ code: 403,
2258
+ message: "Permission denied",
2259
+ solution: "Check access permissions for this operation",
2260
+ },
2261
+ {
2262
+ code: 404,
2263
+ message: "Resource not found",
2264
+ solution: "Verify resource name, namespace, and path",
2265
+ },
2266
+ {
2267
+ code: 409,
2268
+ message: "Resource already exists",
2269
+ solution: "Use different name or update existing resource",
2270
+ },
2271
+ {
2272
+ code: 429,
2273
+ message: "Rate limit exceeded",
2274
+ solution: "Wait before retrying the operation",
2275
+ },
2276
+ {
2277
+ code: 500,
2278
+ message: "Server error",
2279
+ solution: "Retry operation or contact support",
2280
+ },
2281
+ ],
2282
+ conditions: {
2283
+ postconditions: ["Resource updated with new values"],
2284
+ prerequisites: ["Active namespace"],
2285
+ },
2286
+ confirmation_required: false,
2287
+ danger_level: "medium",
2288
+ field_docs: {},
2289
+ optional_fields: [],
2290
+ performance_impact: {
2291
+ latency: "low",
2292
+ resource_usage: "low",
2293
+ },
2294
+ purpose: "Replace existing registration",
2295
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
2296
+ side_effects: {
2297
+ modifies: ["registration"],
2298
+ },
2299
+ },
2300
+ curlExample: null,
2301
+ },
2302
+ {
2303
+ toolName: "f5xc-api-cemanagement-registrations-by-site-list",
2304
+ method: "GET",
2305
+ path: "/api/register/namespaces/{namespace}/registrations_by_site/{site_name}",
2306
+ operation: "list",
2307
+ domain: "ce_management",
2308
+ resource: "registrations-by-site",
2309
+ summary: "List registrations by site.",
2310
+ description: "List all registration in site.",
2311
+ pathParameters: [
2312
+ {
2313
+ description: 'Namespace\n\nx-required\nRegistration namespace, only "system" namespaces is accepted.',
2314
+ in: "path",
2315
+ name: "namespace",
2316
+ required: true,
2317
+ schema: {
2318
+ type: "string",
2319
+ },
2320
+ "x-displayname": "Namespace",
2321
+ "x-ves-example": "System",
2322
+ },
2323
+ {
2324
+ description: "SiteName\n\nx-required\nSite name to be used for registration filtering.",
2325
+ in: "path",
2326
+ name: "site_name",
2327
+ required: true,
2328
+ schema: {
2329
+ type: "string",
2330
+ },
2331
+ "x-displayname": "Site name",
2332
+ "x-ves-example": "Ce02",
2333
+ },
2334
+ ],
2335
+ queryParameters: [],
2336
+ requestBodySchema: null,
2337
+ responseSchema: {
2338
+ $ref: "#/components/schemas/registrationListResponse",
2339
+ },
2340
+ requiredParams: ["namespace", "site_name"],
2341
+ operationId: "ves.io.schema.registration.CustomAPI.ListRegistrationsBySite",
2342
+ tags: ["Other"],
2343
+ sourceFile: "domains/ce_management.json",
2344
+ displayName: null,
2345
+ dangerLevel: "low",
2346
+ sideEffects: null,
2347
+ requiredFields: ["path.namespace", "path.site_name"],
2348
+ confirmationRequired: false,
2349
+ parameterExamples: {
2350
+ namespace: "System",
2351
+ site_name: "Ce02",
2352
+ },
2353
+ validationRules: {},
2354
+ operationMetadata: {
2355
+ common_errors: [
2356
+ {
2357
+ code: 401,
2358
+ message: "Authentication required",
2359
+ solution: "Provide valid API credentials",
2360
+ },
2361
+ {
2362
+ code: 403,
2363
+ message: "Permission denied",
2364
+ solution: "Check access permissions for this operation",
2365
+ },
2366
+ {
2367
+ code: 404,
2368
+ message: "Resource not found",
2369
+ solution: "Verify resource name, namespace, and path",
2370
+ },
2371
+ {
2372
+ code: 409,
2373
+ message: "Resource already exists",
2374
+ solution: "Use different name or update existing resource",
2375
+ },
2376
+ {
2377
+ code: 429,
2378
+ message: "Rate limit exceeded",
2379
+ solution: "Wait before retrying the operation",
2380
+ },
2381
+ {
2382
+ code: 500,
2383
+ message: "Server error",
2384
+ solution: "Retry operation or contact support",
2385
+ },
2386
+ ],
2387
+ conditions: {
2388
+ postconditions: [],
2389
+ prerequisites: ["Active namespace"],
2390
+ },
2391
+ confirmation_required: false,
2392
+ danger_level: "low",
2393
+ field_docs: {},
2394
+ optional_fields: [],
2395
+ performance_impact: {
2396
+ latency: "low",
2397
+ resource_usage: "low",
2398
+ },
2399
+ purpose: "List all registrations-by-sites",
2400
+ required_fields: ["path.namespace", "path.site_name"],
2401
+ side_effects: {},
2402
+ },
2403
+ curlExample: null,
2404
+ },
2405
+ {
2406
+ toolName: "f5xc-api-cemanagement-requestconfig-create",
2407
+ method: "POST",
2408
+ path: "/api/register/requestConfig",
2409
+ operation: "create",
2410
+ domain: "ce_management",
2411
+ resource: "requestConfig",
2412
+ summary: "Registration Config.",
2413
+ description: "API endpoint for returning configuration for admitted registrations.\nIt will fail with known error for non-ADMITTED registration.",
2414
+ pathParameters: [],
2415
+ queryParameters: [],
2416
+ requestBodySchema: {
2417
+ $ref: "#/components/schemas/registrationConfigReq",
2418
+ },
2419
+ responseSchema: {
2420
+ $ref: "#/components/schemas/registrationConfigResp",
2421
+ },
2422
+ requiredParams: ["body"],
2423
+ operationId: "ves.io.schema.registration.CustomAPI.RegistrationConfig",
2424
+ tags: ["Other"],
2425
+ sourceFile: "domains/ce_management.json",
2426
+ displayName: null,
2427
+ dangerLevel: "medium",
2428
+ sideEffects: {
2429
+ creates: ["requestConfig"],
2430
+ },
2431
+ requiredFields: ["metadata.name", "metadata.namespace"],
2432
+ confirmationRequired: false,
2433
+ parameterExamples: {},
2434
+ validationRules: {},
2435
+ operationMetadata: {
2436
+ common_errors: [
2437
+ {
2438
+ code: 401,
2439
+ message: "Authentication required",
2440
+ solution: "Provide valid API credentials",
2441
+ },
2442
+ {
2443
+ code: 403,
2444
+ message: "Permission denied",
2445
+ solution: "Check access permissions for this operation",
2446
+ },
2447
+ {
2448
+ code: 404,
2449
+ message: "Resource not found",
2450
+ solution: "Verify resource name, namespace, and path",
2451
+ },
2452
+ {
2453
+ code: 409,
2454
+ message: "Resource already exists",
2455
+ solution: "Use different name or update existing resource",
2456
+ },
2457
+ {
2458
+ code: 429,
2459
+ message: "Rate limit exceeded",
2460
+ solution: "Wait before retrying the operation",
2461
+ },
2462
+ {
2463
+ code: 500,
2464
+ message: "Server error",
2465
+ solution: "Retry operation or contact support",
2466
+ },
2467
+ ],
2468
+ conditions: {
2469
+ postconditions: ["Requestconfig resource created", "Resource assigned unique identifier"],
2470
+ prerequisites: [],
2471
+ },
2472
+ confirmation_required: false,
2473
+ danger_level: "medium",
2474
+ field_docs: {},
2475
+ optional_fields: [],
2476
+ performance_impact: {
2477
+ latency: "low",
2478
+ resource_usage: "low",
2479
+ },
2480
+ purpose: "Create new requestConfig",
2481
+ required_fields: ["metadata.name", "metadata.namespace"],
2482
+ side_effects: {
2483
+ creates: ["requestConfig"],
2484
+ },
2485
+ },
2486
+ curlExample: null,
2487
+ },
2488
+ {
2489
+ toolName: "f5xc-api-cemanagement-setting-list",
2490
+ method: "GET",
2491
+ path: "/api/config/namespaces/{namespace}/module_management/settings",
2492
+ operation: "list",
2493
+ domain: "ce_management",
2494
+ resource: "setting",
2495
+ summary: "Module Management Settings.",
2496
+ description: "Receive the module settings.",
2497
+ pathParameters: [
2498
+ {
2499
+ description: "Namespace\nThe namespace this item belongs to.",
2500
+ in: "path",
2501
+ name: "namespace",
2502
+ required: true,
2503
+ schema: {
2504
+ type: "string",
2505
+ },
2506
+ "x-displayname": "Namespace",
2507
+ "x-ves-example": "Ns1",
2508
+ },
2509
+ ],
2510
+ queryParameters: [],
2511
+ requestBodySchema: null,
2512
+ responseSchema: {
2513
+ $ref: "#/components/schemas/module_managementModuleManagementResponse",
2514
+ },
2515
+ requiredParams: ["namespace"],
2516
+ operationId: "ves.io.schema.module_management.ModuleManagementAPI.GetModuleManagementSettings",
2517
+ tags: ["Infrastructure"],
2518
+ sourceFile: "domains/ce_management.json",
2519
+ displayName: null,
2520
+ dangerLevel: "low",
2521
+ sideEffects: null,
2522
+ requiredFields: ["path.namespace"],
2523
+ confirmationRequired: false,
2524
+ parameterExamples: {
2525
+ namespace: "Ns1",
2526
+ },
2527
+ validationRules: {},
2528
+ operationMetadata: {
2529
+ common_errors: [
2530
+ {
2531
+ code: 401,
2532
+ message: "Authentication required",
2533
+ solution: "Provide valid API credentials",
2534
+ },
2535
+ {
2536
+ code: 403,
2537
+ message: "Permission denied",
2538
+ solution: "Check access permissions for this operation",
2539
+ },
2540
+ {
2541
+ code: 404,
2542
+ message: "Resource not found",
2543
+ solution: "Verify resource name, namespace, and path",
2544
+ },
2545
+ {
2546
+ code: 409,
2547
+ message: "Resource already exists",
2548
+ solution: "Use different name or update existing resource",
2549
+ },
2550
+ {
2551
+ code: 429,
2552
+ message: "Rate limit exceeded",
2553
+ solution: "Wait before retrying the operation",
2554
+ },
2555
+ {
2556
+ code: 500,
2557
+ message: "Server error",
2558
+ solution: "Retry operation or contact support",
2559
+ },
2560
+ ],
2561
+ conditions: {
2562
+ postconditions: [],
2563
+ prerequisites: ["Active namespace"],
2564
+ },
2565
+ confirmation_required: false,
2566
+ danger_level: "low",
2567
+ field_docs: {},
2568
+ optional_fields: [],
2569
+ performance_impact: {
2570
+ latency: "moderate",
2571
+ resource_usage: "moderate",
2572
+ },
2573
+ purpose: "List all settings",
2574
+ required_fields: ["path.namespace"],
2575
+ side_effects: {},
2576
+ },
2577
+ curlExample: null,
2578
+ },
2579
+ {
2580
+ toolName: "f5xc-api-cemanagement-suggest-value-create",
2581
+ method: "POST",
2582
+ path: "/api/register/namespaces/system/suggest-values",
2583
+ operation: "create",
2584
+ domain: "ce_management",
2585
+ resource: "suggest-value",
2586
+ summary: "Suggest Values.",
2587
+ description: "Returns suggested values for the specified field in the given Create/Replace/Custom request.",
2588
+ pathParameters: [],
2589
+ queryParameters: [],
2590
+ requestBodySchema: {
2591
+ $ref: "#/components/schemas/registrationSuggestValuesReq",
2592
+ },
2593
+ responseSchema: {
2594
+ $ref: "#/components/schemas/schemaregistrationSuggestValuesResp",
2595
+ },
2596
+ requiredParams: ["body"],
2597
+ operationId: "ves.io.schema.registration.CustomAPI.SuggestValues",
2598
+ tags: ["Other"],
2599
+ sourceFile: "domains/ce_management.json",
2600
+ displayName: null,
2601
+ dangerLevel: "medium",
2602
+ sideEffects: {
2603
+ creates: ["suggest-value"],
2604
+ },
2605
+ requiredFields: ["metadata.name", "metadata.namespace"],
2606
+ confirmationRequired: false,
2607
+ parameterExamples: {},
2608
+ validationRules: {},
2609
+ operationMetadata: {
2610
+ common_errors: [
2611
+ {
2612
+ code: 401,
2613
+ message: "Authentication required",
2614
+ solution: "Provide valid API credentials",
2615
+ },
2616
+ {
2617
+ code: 403,
2618
+ message: "Permission denied",
2619
+ solution: "Check access permissions for this operation",
2620
+ },
2621
+ {
2622
+ code: 404,
2623
+ message: "Resource not found",
2624
+ solution: "Verify resource name, namespace, and path",
2625
+ },
2626
+ {
2627
+ code: 409,
2628
+ message: "Resource already exists",
2629
+ solution: "Use different name or update existing resource",
2630
+ },
2631
+ {
2632
+ code: 429,
2633
+ message: "Rate limit exceeded",
2634
+ solution: "Wait before retrying the operation",
2635
+ },
2636
+ {
2637
+ code: 500,
2638
+ message: "Server error",
2639
+ solution: "Retry operation or contact support",
2640
+ },
2641
+ ],
2642
+ conditions: {
2643
+ postconditions: ["Suggest-value resource created", "Resource assigned unique identifier"],
2644
+ prerequisites: ["Active namespace"],
2645
+ },
2646
+ confirmation_required: false,
2647
+ danger_level: "medium",
2648
+ field_docs: {},
2649
+ optional_fields: [],
2650
+ performance_impact: {
2651
+ latency: "low",
2652
+ resource_usage: "low",
2653
+ },
2654
+ purpose: "Create new suggest-value",
2655
+ required_fields: ["metadata.name", "metadata.namespace"],
2656
+ side_effects: {
2657
+ creates: ["suggest-value"],
2658
+ },
2659
+ },
2660
+ curlExample: null,
2661
+ },
2662
+ {
2663
+ toolName: "f5xc-api-cemanagement-upgradable-sw-version-list",
2664
+ method: "GET",
2665
+ path: "/api/maurice/upgradable_sw_versions",
2666
+ operation: "list",
2667
+ domain: "ce_management",
2668
+ resource: "upgradable-sw-version",
2669
+ summary: "GET Upgradable SW Versions.",
2670
+ description: "API to GET list of sw versions that can be upgraded to.",
2671
+ pathParameters: [],
2672
+ queryParameters: [
2673
+ {
2674
+ description: "Fetch upgradable sw versions for site.",
2675
+ in: "query",
2676
+ name: "current_os_version",
2677
+ required: false,
2678
+ schema: {
2679
+ type: "string",
2680
+ },
2681
+ "x-displayname": "Current OS Version.",
2682
+ "x-ves-example": "9.2023.23",
2683
+ },
2684
+ {
2685
+ description: "Fetch upgradable sw versions for site.",
2686
+ in: "query",
2687
+ name: "current_sw_version",
2688
+ required: false,
2689
+ schema: {
2690
+ type: "string",
2691
+ },
2692
+ "x-displayname": "Current SW Version.",
2693
+ "x-ves-example": "Crt-20241107-1123.",
2694
+ },
2695
+ ],
2696
+ requestBodySchema: null,
2697
+ responseSchema: {
2698
+ $ref: "#/components/schemas/upgrade_statusGetUpgradableSWVersionsResponse",
2699
+ },
2700
+ requiredParams: [],
2701
+ operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradableSWVersions",
2702
+ tags: ["Other"],
2703
+ sourceFile: "domains/ce_management.json",
2704
+ displayName: null,
2705
+ dangerLevel: "low",
2706
+ sideEffects: null,
2707
+ requiredFields: [],
2708
+ confirmationRequired: false,
2709
+ parameterExamples: {
2710
+ current_os_version: "9.2023.23",
2711
+ current_sw_version: "Crt-20241107-1123.",
2712
+ },
2713
+ validationRules: {},
2714
+ operationMetadata: {
2715
+ common_errors: [
2716
+ {
2717
+ code: 401,
2718
+ message: "Authentication required",
2719
+ solution: "Provide valid API credentials",
2720
+ },
2721
+ {
2722
+ code: 403,
2723
+ message: "Permission denied",
2724
+ solution: "Check access permissions for this operation",
2725
+ },
2726
+ {
2727
+ code: 404,
2728
+ message: "Resource not found",
2729
+ solution: "Verify resource name, namespace, and path",
2730
+ },
2731
+ {
2732
+ code: 409,
2733
+ message: "Resource already exists",
2734
+ solution: "Use different name or update existing resource",
2735
+ },
2736
+ {
2737
+ code: 429,
2738
+ message: "Rate limit exceeded",
2739
+ solution: "Wait before retrying the operation",
2740
+ },
2741
+ {
2742
+ code: 500,
2743
+ message: "Server error",
2744
+ solution: "Retry operation or contact support",
2745
+ },
2746
+ ],
2747
+ conditions: {
2748
+ postconditions: [],
2749
+ prerequisites: [],
2750
+ },
2751
+ confirmation_required: false,
2752
+ danger_level: "low",
2753
+ field_docs: {},
2754
+ optional_fields: [],
2755
+ performance_impact: {
2756
+ latency: "moderate",
2757
+ resource_usage: "moderate",
2758
+ },
2759
+ purpose: "List all upgradable-sw-versions",
2760
+ required_fields: [],
2761
+ side_effects: {},
2762
+ },
2763
+ curlExample: null,
2764
+ },
2765
+ {
2766
+ toolName: "f5xc-api-cemanagement-upgrade-statu-get",
2767
+ method: "GET",
2768
+ path: "/api/maurice/namespaces/{namespace}/sites/{name}/upgrade_status",
2769
+ operation: "get",
2770
+ domain: "ce_management",
2771
+ resource: "upgrade-statu",
2772
+ summary: "GET Upgrade Status.",
2773
+ description: "API to GET upgrade status of a site.",
2774
+ pathParameters: [
2775
+ {
2776
+ description: "Name\nFetch upgrade status for the name of site.",
2777
+ in: "path",
2778
+ name: "name",
2779
+ required: true,
2780
+ schema: {
2781
+ type: "string",
2782
+ },
2783
+ "x-displayname": "Site Name",
2784
+ "x-ves-example": "Blogging-app.",
2785
+ },
2786
+ {
2787
+ description: "Namespace\nFetch upgrade status for the given namespace.",
2788
+ in: "path",
2789
+ name: "namespace",
2790
+ required: true,
2791
+ schema: {
2792
+ type: "string",
2793
+ },
2794
+ "x-displayname": "Namespace",
2795
+ "x-ves-example": "Shared",
2796
+ },
2797
+ ],
2798
+ queryParameters: [],
2799
+ requestBodySchema: null,
2800
+ responseSchema: {
2801
+ $ref: "#/components/schemas/upgrade_statusGetUpgradeStatusResponse",
2802
+ },
2803
+ requiredParams: ["name", "namespace"],
2804
+ operationId: "ves.io.schema.upgrade_status.UpgradeStatusCustomApi.GetUpgradeStatus",
2805
+ tags: ["Other"],
2806
+ sourceFile: "domains/ce_management.json",
2807
+ displayName: null,
2808
+ dangerLevel: "low",
2809
+ sideEffects: null,
2810
+ requiredFields: ["path.name", "path.namespace"],
2811
+ confirmationRequired: false,
2812
+ parameterExamples: {
2813
+ name: "Blogging-app.",
2814
+ namespace: "Shared",
2815
+ },
2816
+ validationRules: {},
2817
+ operationMetadata: {
2818
+ common_errors: [
2819
+ {
2820
+ code: 401,
2821
+ message: "Authentication required",
2822
+ solution: "Provide valid API credentials",
2823
+ },
2824
+ {
2825
+ code: 403,
2826
+ message: "Permission denied",
2827
+ solution: "Check access permissions for this operation",
2828
+ },
2829
+ {
2830
+ code: 404,
2831
+ message: "Resource not found",
2832
+ solution: "Verify resource name, namespace, and path",
2833
+ },
2834
+ {
2835
+ code: 409,
2836
+ message: "Resource already exists",
2837
+ solution: "Use different name or update existing resource",
2838
+ },
2839
+ {
2840
+ code: 429,
2841
+ message: "Rate limit exceeded",
2842
+ solution: "Wait before retrying the operation",
2843
+ },
2844
+ {
2845
+ code: 500,
2846
+ message: "Server error",
2847
+ solution: "Retry operation or contact support",
2848
+ },
2849
+ ],
2850
+ conditions: {
2851
+ postconditions: [],
2852
+ prerequisites: ["Active namespace"],
2853
+ },
2854
+ confirmation_required: false,
2855
+ danger_level: "low",
2856
+ field_docs: {},
2857
+ optional_fields: [],
2858
+ performance_impact: {
2859
+ latency: "moderate",
2860
+ resource_usage: "moderate",
2861
+ },
2862
+ purpose: "Retrieve specific upgrade-statu",
2863
+ required_fields: ["path.name", "path.namespace"],
2864
+ side_effects: {},
2865
+ },
2866
+ curlExample: null,
2867
+ },
2868
+ {
2869
+ toolName: "f5xc-api-cemanagement-usb-policy-create",
2870
+ method: "POST",
2871
+ path: "/api/config/namespaces/{metadata.namespace}/usb_policys",
2872
+ operation: "create",
2873
+ domain: "ce_management",
2874
+ resource: "usb-policy",
2875
+ summary: "Create USB policy.",
2876
+ description: "Creates a new USB policy object.",
2877
+ pathParameters: [
2878
+ {
2879
+ 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 ""',
2880
+ in: "path",
2881
+ name: "metadata.namespace",
2882
+ required: true,
2883
+ schema: {
2884
+ type: "string",
2885
+ },
2886
+ "x-displayname": "Namespace",
2887
+ "x-ves-example": "Staging",
2888
+ },
2889
+ ],
2890
+ queryParameters: [],
2891
+ requestBodySchema: {
2892
+ $ref: "#/components/schemas/usb_policyCreateRequest",
2893
+ },
2894
+ responseSchema: {
2895
+ $ref: "#/components/schemas/usb_policyCreateResponse",
2896
+ },
2897
+ requiredParams: ["body", "metadata.namespace"],
2898
+ operationId: "ves.io.schema.usb_policy.API.Create",
2899
+ tags: ["Other"],
2900
+ sourceFile: "domains/ce_management.json",
2901
+ displayName: null,
2902
+ dangerLevel: "medium",
2903
+ sideEffects: {
2904
+ creates: ["usb-policy"],
2905
+ },
2906
+ requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
2907
+ confirmationRequired: false,
2908
+ parameterExamples: {
2909
+ "metadata.namespace": "Staging",
2910
+ },
2911
+ validationRules: {},
2912
+ operationMetadata: {
2913
+ common_errors: [
2914
+ {
2915
+ code: 401,
2916
+ message: "Authentication required",
2917
+ solution: "Provide valid API credentials",
2918
+ },
2919
+ {
2920
+ code: 403,
2921
+ message: "Permission denied",
2922
+ solution: "Check access permissions for this operation",
2923
+ },
2924
+ {
2925
+ code: 404,
2926
+ message: "Resource not found",
2927
+ solution: "Verify resource name, namespace, and path",
2928
+ },
2929
+ {
2930
+ code: 409,
2931
+ message: "Resource already exists",
2932
+ solution: "Use different name or update existing resource",
2933
+ },
2934
+ {
2935
+ code: 429,
2936
+ message: "Rate limit exceeded",
2937
+ solution: "Wait before retrying the operation",
2938
+ },
2939
+ {
2940
+ code: 500,
2941
+ message: "Server error",
2942
+ solution: "Retry operation or contact support",
2943
+ },
2944
+ ],
2945
+ conditions: {
2946
+ postconditions: ["Usb-policy resource created", "Resource assigned unique identifier"],
2947
+ prerequisites: ["Active namespace", "Policy parameters defined"],
2948
+ },
2949
+ confirmation_required: false,
2950
+ danger_level: "medium",
2951
+ field_docs: {},
2952
+ optional_fields: [],
2953
+ performance_impact: {
2954
+ latency: "low",
2955
+ resource_usage: "low",
2956
+ },
2957
+ purpose: "Create new usb-policy",
2958
+ required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
2959
+ side_effects: {
2960
+ creates: ["usb-policy"],
2961
+ },
2962
+ },
2963
+ curlExample: null,
2964
+ },
2965
+ {
2966
+ toolName: "f5xc-api-cemanagement-usb-policy-delete",
2967
+ method: "DELETE",
2968
+ path: "/api/config/namespaces/{namespace}/usb_policys/{name}",
2969
+ operation: "delete",
2970
+ domain: "ce_management",
2971
+ resource: "usb-policy",
2972
+ summary: "DELETE USB policy.",
2973
+ description: "DELETE the specified usb_policy.",
2974
+ pathParameters: [
2975
+ {
2976
+ description: "Name\nName of the configuration object.",
2977
+ in: "path",
2978
+ name: "name",
2979
+ required: true,
2980
+ schema: {
2981
+ type: "string",
2982
+ },
2983
+ "x-displayname": "Name",
2984
+ "x-ves-example": "Name",
2985
+ },
2986
+ {
2987
+ description: "Namespace\nNamespace in which the configuration object is present.",
2988
+ in: "path",
2989
+ name: "namespace",
2990
+ required: true,
2991
+ schema: {
2992
+ type: "string",
2993
+ },
2994
+ "x-displayname": "Namespace",
2995
+ "x-ves-example": "Ns1",
2996
+ },
2997
+ ],
2998
+ queryParameters: [],
2999
+ requestBodySchema: {
3000
+ $ref: "#/components/schemas/usb_policyDeleteRequest",
3001
+ },
3002
+ responseSchema: {},
3003
+ requiredParams: ["body", "name", "namespace"],
3004
+ operationId: "ves.io.schema.usb_policy.API.Delete",
3005
+ tags: ["Other"],
3006
+ sourceFile: "domains/ce_management.json",
3007
+ displayName: null,
3008
+ dangerLevel: "high",
3009
+ sideEffects: {
3010
+ deletes: ["usb-policy", "contained_resources"],
3011
+ },
3012
+ requiredFields: ["path.name", "path.namespace"],
3013
+ confirmationRequired: true,
3014
+ parameterExamples: {
3015
+ name: "Name",
3016
+ namespace: "Ns1",
3017
+ },
3018
+ validationRules: {},
3019
+ operationMetadata: {
3020
+ common_errors: [
3021
+ {
3022
+ code: 401,
3023
+ message: "Authentication required",
3024
+ solution: "Provide valid API credentials",
3025
+ },
3026
+ {
3027
+ code: 403,
3028
+ message: "Permission denied",
3029
+ solution: "Check access permissions for this operation",
3030
+ },
3031
+ {
3032
+ code: 404,
3033
+ message: "Resource not found",
3034
+ solution: "Verify resource name, namespace, and path",
3035
+ },
3036
+ {
3037
+ code: 409,
3038
+ message: "Resource already exists",
3039
+ solution: "Use different name or update existing resource",
3040
+ },
3041
+ {
3042
+ code: 429,
3043
+ message: "Rate limit exceeded",
3044
+ solution: "Wait before retrying the operation",
3045
+ },
3046
+ {
3047
+ code: 500,
3048
+ message: "Server error",
3049
+ solution: "Retry operation or contact support",
3050
+ },
3051
+ ],
3052
+ conditions: {
3053
+ postconditions: ["Resource removed from system", "Associated resources may be affected"],
3054
+ prerequisites: ["Active namespace", "Policy parameters defined"],
3055
+ },
3056
+ confirmation_required: true,
3057
+ danger_level: "high",
3058
+ field_docs: {},
3059
+ optional_fields: [],
3060
+ performance_impact: {
3061
+ latency: "high",
3062
+ resource_usage: "moderate",
3063
+ },
3064
+ purpose: "Delete usb-policy",
3065
+ required_fields: ["path.name", "path.namespace"],
3066
+ side_effects: {
3067
+ deletes: ["usb-policy", "contained_resources"],
3068
+ },
3069
+ },
3070
+ curlExample: null,
3071
+ },
3072
+ {
3073
+ toolName: "f5xc-api-cemanagement-usb-policy-get",
3074
+ method: "GET",
3075
+ path: "/api/config/namespaces/{namespace}/usb_policys/{name}",
3076
+ operation: "get",
3077
+ domain: "ce_management",
3078
+ resource: "usb-policy",
3079
+ summary: "GET USB policy.",
3080
+ description: "GET the USB policy object.",
3081
+ pathParameters: [
3082
+ {
3083
+ description: "Name\nThe name of the configuration object to be fetched.",
3084
+ in: "path",
3085
+ name: "name",
3086
+ required: true,
3087
+ schema: {
3088
+ type: "string",
3089
+ },
3090
+ "x-displayname": "Name",
3091
+ "x-ves-example": "Name",
3092
+ },
3093
+ {
3094
+ description: "Namespace\nThe namespace in which the configuration object is present.",
3095
+ in: "path",
3096
+ name: "namespace",
3097
+ required: true,
3098
+ schema: {
3099
+ type: "string",
3100
+ },
3101
+ "x-displayname": "Namespace",
3102
+ "x-ves-example": "Ns1",
3103
+ },
3104
+ ],
3105
+ queryParameters: [
3106
+ {
3107
+ 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.",
3108
+ in: "query",
3109
+ name: "response_format",
3110
+ required: false,
3111
+ schema: {
3112
+ default: "GET_RSP_FORMAT_DEFAULT",
3113
+ enum: [
3114
+ "GET_RSP_FORMAT_DEFAULT",
3115
+ "GET_RSP_FORMAT_FOR_CREATE",
3116
+ "GET_RSP_FORMAT_FOR_REPLACE",
3117
+ "GET_RSP_FORMAT_STATUS",
3118
+ "GET_RSP_FORMAT_READ",
3119
+ "GET_RSP_FORMAT_REFERRING_OBJECTS",
3120
+ "GET_RSP_FORMAT_BROKEN_REFERENCES",
3121
+ ],
3122
+ type: "string",
3123
+ },
3124
+ "x-displayname": "Broken Referred Objects.",
3125
+ },
3126
+ ],
3127
+ requestBodySchema: null,
3128
+ responseSchema: {
3129
+ $ref: "#/components/schemas/usb_policyGetResponse",
3130
+ },
3131
+ requiredParams: ["name", "namespace"],
3132
+ operationId: "ves.io.schema.usb_policy.API.Get",
3133
+ tags: ["Other"],
3134
+ sourceFile: "domains/ce_management.json",
3135
+ displayName: null,
3136
+ dangerLevel: "low",
3137
+ sideEffects: null,
3138
+ requiredFields: ["path.name", "path.namespace"],
3139
+ confirmationRequired: false,
3140
+ parameterExamples: {
3141
+ name: "Name",
3142
+ namespace: "Ns1",
3143
+ },
3144
+ validationRules: {},
3145
+ operationMetadata: {
3146
+ common_errors: [
3147
+ {
3148
+ code: 401,
3149
+ message: "Authentication required",
3150
+ solution: "Provide valid API credentials",
3151
+ },
3152
+ {
3153
+ code: 403,
3154
+ message: "Permission denied",
3155
+ solution: "Check access permissions for this operation",
3156
+ },
3157
+ {
3158
+ code: 404,
3159
+ message: "Resource not found",
3160
+ solution: "Verify resource name, namespace, and path",
3161
+ },
3162
+ {
3163
+ code: 409,
3164
+ message: "Resource already exists",
3165
+ solution: "Use different name or update existing resource",
3166
+ },
3167
+ {
3168
+ code: 429,
3169
+ message: "Rate limit exceeded",
3170
+ solution: "Wait before retrying the operation",
3171
+ },
3172
+ {
3173
+ code: 500,
3174
+ message: "Server error",
3175
+ solution: "Retry operation or contact support",
3176
+ },
3177
+ ],
3178
+ conditions: {
3179
+ postconditions: [],
3180
+ prerequisites: ["Active namespace", "Policy parameters defined"],
3181
+ },
3182
+ confirmation_required: false,
3183
+ danger_level: "low",
3184
+ field_docs: {},
3185
+ optional_fields: [],
3186
+ performance_impact: {
3187
+ latency: "low",
3188
+ resource_usage: "low",
3189
+ },
3190
+ purpose: "Retrieve specific usb-policy",
3191
+ required_fields: ["path.name", "path.namespace"],
3192
+ side_effects: {},
3193
+ },
3194
+ curlExample: null,
3195
+ },
3196
+ {
3197
+ toolName: "f5xc-api-cemanagement-usb-policy-list",
3198
+ method: "GET",
3199
+ path: "/api/config/namespaces/{namespace}/usb_policys",
3200
+ operation: "list",
3201
+ domain: "ce_management",
3202
+ resource: "usb-policy",
3203
+ summary: "List USB policy.",
3204
+ description: "List the set of usb_policy in a namespace.",
3205
+ pathParameters: [
3206
+ {
3207
+ description: "Namespace\nNamespace to scope the listing of usb_policy.",
3208
+ in: "path",
3209
+ name: "namespace",
3210
+ required: true,
3211
+ schema: {
3212
+ type: "string",
3213
+ },
3214
+ "x-displayname": "Namespace",
3215
+ "x-ves-example": "Ns1",
3216
+ },
3217
+ ],
3218
+ queryParameters: [
3219
+ {
3220
+ description: "A LabelSelectorType expression that every item in list response will satisfy.",
3221
+ in: "query",
3222
+ name: "label_filter",
3223
+ required: false,
3224
+ schema: {
3225
+ type: "string",
3226
+ },
3227
+ "x-displayname": "Label Filter.",
3228
+ "x-ves-example": "Env in (staging, testing), tier in (web, db)",
3229
+ },
3230
+ {
3231
+ description: 'X-example: ""\nExtra fields to return along with summary fields.',
3232
+ in: "query",
3233
+ name: "report_fields",
3234
+ required: false,
3235
+ schema: {
3236
+ items: {
3237
+ type: "string",
3238
+ },
3239
+ type: "array",
3240
+ },
3241
+ "x-displayname": "Report Fields.",
3242
+ },
3243
+ {
3244
+ description: 'X-example: ""\nExtra status fields to return along with summary fields.',
3245
+ in: "query",
3246
+ name: "report_status_fields",
3247
+ required: false,
3248
+ schema: {
3249
+ items: {
3250
+ type: "string",
3251
+ },
3252
+ type: "array",
3253
+ },
3254
+ "x-displayname": "Report Status Fields.",
3255
+ },
3256
+ ],
3257
+ requestBodySchema: null,
3258
+ responseSchema: {
3259
+ $ref: "#/components/schemas/usb_policyListResponse",
3260
+ },
3261
+ requiredParams: ["namespace"],
3262
+ operationId: "ves.io.schema.usb_policy.API.List",
3263
+ tags: ["Other"],
3264
+ sourceFile: "domains/ce_management.json",
3265
+ displayName: null,
3266
+ dangerLevel: "low",
3267
+ sideEffects: null,
3268
+ requiredFields: ["path.namespace"],
3269
+ confirmationRequired: false,
3270
+ parameterExamples: {
3271
+ label_filter: "Env in (staging, testing), tier in (web, db)",
3272
+ namespace: "Ns1",
3273
+ },
3274
+ validationRules: {},
3275
+ operationMetadata: {
3276
+ common_errors: [
3277
+ {
3278
+ code: 401,
3279
+ message: "Authentication required",
3280
+ solution: "Provide valid API credentials",
3281
+ },
3282
+ {
3283
+ code: 403,
3284
+ message: "Permission denied",
3285
+ solution: "Check access permissions for this operation",
3286
+ },
3287
+ {
3288
+ code: 404,
3289
+ message: "Resource not found",
3290
+ solution: "Verify resource name, namespace, and path",
3291
+ },
3292
+ {
3293
+ code: 409,
3294
+ message: "Resource already exists",
3295
+ solution: "Use different name or update existing resource",
3296
+ },
3297
+ {
3298
+ code: 429,
3299
+ message: "Rate limit exceeded",
3300
+ solution: "Wait before retrying the operation",
3301
+ },
3302
+ {
3303
+ code: 500,
3304
+ message: "Server error",
3305
+ solution: "Retry operation or contact support",
3306
+ },
3307
+ ],
3308
+ conditions: {
3309
+ postconditions: [],
3310
+ prerequisites: ["Active namespace", "Policy parameters defined"],
3311
+ },
3312
+ confirmation_required: false,
3313
+ danger_level: "low",
3314
+ field_docs: {},
3315
+ optional_fields: [],
3316
+ performance_impact: {
3317
+ latency: "moderate",
3318
+ resource_usage: "moderate",
3319
+ },
3320
+ purpose: "List all usb-policys",
3321
+ required_fields: ["path.namespace"],
3322
+ side_effects: {},
3323
+ },
3324
+ curlExample: null,
3325
+ },
3326
+ {
3327
+ toolName: "f5xc-api-cemanagement-usb-policy-update",
3328
+ method: "PUT",
3329
+ path: "/api/config/namespaces/{metadata.namespace}/usb_policys/{metadata.name}",
3330
+ operation: "update",
3331
+ domain: "ce_management",
3332
+ resource: "usb-policy",
3333
+ summary: "Replace USB policy.",
3334
+ description: "Replaces the content of an USB policy object.",
3335
+ pathParameters: [
3336
+ {
3337
+ description: "Name\nThe configuration object to be replaced will be looked up by name.",
3338
+ in: "path",
3339
+ name: "metadata.name",
3340
+ required: true,
3341
+ schema: {
3342
+ type: "string",
3343
+ },
3344
+ "x-displayname": "Name",
3345
+ "x-ves-example": "Example-corp-web.",
3346
+ },
3347
+ {
3348
+ 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 ""',
3349
+ in: "path",
3350
+ name: "metadata.namespace",
3351
+ required: true,
3352
+ schema: {
3353
+ type: "string",
3354
+ },
3355
+ "x-displayname": "Namespace",
3356
+ "x-ves-example": "Staging",
3357
+ },
3358
+ ],
3359
+ queryParameters: [],
3360
+ requestBodySchema: {
3361
+ $ref: "#/components/schemas/usb_policyReplaceRequest",
3362
+ },
3363
+ responseSchema: {
3364
+ $ref: "#/components/schemas/usb_policyReplaceResponse",
3365
+ },
3366
+ requiredParams: ["body", "metadata.name", "metadata.namespace"],
3367
+ operationId: "ves.io.schema.usb_policy.API.Replace",
3368
+ tags: ["Other"],
3369
+ sourceFile: "domains/ce_management.json",
3370
+ displayName: null,
3371
+ dangerLevel: "medium",
3372
+ sideEffects: {
3373
+ modifies: ["usb-policy"],
3374
+ },
3375
+ requiredFields: ["path.metadata.name", "path.metadata.namespace"],
3376
+ confirmationRequired: false,
3377
+ parameterExamples: {
3378
+ "metadata.name": "Example-corp-web.",
3379
+ "metadata.namespace": "Staging",
3380
+ },
3381
+ validationRules: {},
3382
+ operationMetadata: {
3383
+ common_errors: [
3384
+ {
3385
+ code: 401,
3386
+ message: "Authentication required",
3387
+ solution: "Provide valid API credentials",
3388
+ },
3389
+ {
3390
+ code: 403,
3391
+ message: "Permission denied",
3392
+ solution: "Check access permissions for this operation",
3393
+ },
3394
+ {
3395
+ code: 404,
3396
+ message: "Resource not found",
3397
+ solution: "Verify resource name, namespace, and path",
3398
+ },
3399
+ {
3400
+ code: 409,
3401
+ message: "Resource already exists",
3402
+ solution: "Use different name or update existing resource",
3403
+ },
3404
+ {
3405
+ code: 429,
3406
+ message: "Rate limit exceeded",
3407
+ solution: "Wait before retrying the operation",
3408
+ },
3409
+ {
3410
+ code: 500,
3411
+ message: "Server error",
3412
+ solution: "Retry operation or contact support",
3413
+ },
3414
+ ],
3415
+ conditions: {
3416
+ postconditions: ["Resource updated with new values"],
3417
+ prerequisites: ["Active namespace", "Policy parameters defined"],
3418
+ },
3419
+ confirmation_required: false,
3420
+ danger_level: "medium",
3421
+ field_docs: {},
3422
+ optional_fields: [],
3423
+ performance_impact: {
3424
+ latency: "low",
3425
+ resource_usage: "low",
3426
+ },
3427
+ purpose: "Replace existing usb-policy",
3428
+ required_fields: ["path.metadata.name", "path.metadata.namespace"],
3429
+ side_effects: {
3430
+ modifies: ["usb-policy"],
3431
+ },
3432
+ },
3433
+ curlExample: null,
3434
+ },
3435
+ ];
3436
+ export default ce_managementTools;
3437
+ //# sourceMappingURL=index.js.map