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