@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.4.0

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