@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generator/openapi-parser.d.ts +355 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +202 -2
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -2
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +144 -28
- package/dist/generator/tool-generator.js.map +1 -1
- package/dist/index.d.ts +2 -10
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +28 -33
- package/dist/index.js.map +1 -1
- package/dist/prompts/workflows.d.ts.map +1 -1
- package/dist/prompts/workflows.js +30 -174
- package/dist/prompts/workflows.js.map +1 -1
- package/dist/resources/handlers.d.ts +0 -2
- package/dist/resources/handlers.d.ts.map +1 -1
- package/dist/resources/handlers.js +0 -51
- package/dist/resources/handlers.js.map +1 -1
- package/dist/server.d.ts +1 -1
- package/dist/server.d.ts.map +1 -1
- package/dist/server.js +1 -2
- package/dist/server.js.map +1 -1
- package/dist/tools/discovery/describe.d.ts +1 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -1
- package/dist/tools/discovery/describe.js +10 -8
- package/dist/tools/discovery/describe.js.map +1 -1
- package/dist/tools/discovery/execute.d.ts +1 -3
- package/dist/tools/discovery/execute.d.ts.map +1 -1
- package/dist/tools/discovery/execute.js +1 -34
- package/dist/tools/discovery/execute.js.map +1 -1
- package/dist/tools/generated/admin_console_and_ui/index.d.ts +8 -0
- package/dist/tools/generated/admin_console_and_ui/index.d.ts.map +1 -0
- package/dist/tools/generated/admin_console_and_ui/index.js +259 -0
- package/dist/tools/generated/admin_console_and_ui/index.js.map +1 -0
- package/dist/tools/generated/api/index.d.ts +8 -0
- package/dist/tools/generated/{vpn → api}/index.d.ts.map +1 -1
- package/dist/tools/generated/api/index.js +5812 -0
- package/dist/tools/generated/api/index.js.map +1 -0
- package/dist/tools/generated/authentication/index.d.ts +8 -0
- package/dist/tools/generated/authentication/index.d.ts.map +1 -0
- package/dist/tools/generated/authentication/index.js +858 -0
- package/dist/tools/generated/authentication/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -1
- package/dist/tools/generated/bigip/index.js +1660 -0
- package/dist/tools/generated/bigip/index.js.map +1 -1
- package/dist/tools/generated/billing_and_usage/index.d.ts +8 -0
- package/dist/tools/generated/billing_and_usage/index.d.ts.map +1 -0
- package/dist/tools/generated/billing_and_usage/index.js +2283 -0
- package/dist/tools/generated/billing_and_usage/index.js.map +1 -0
- package/dist/tools/generated/blindfold/index.d.ts +8 -0
- package/dist/tools/generated/blindfold/index.d.ts.map +1 -0
- package/dist/tools/generated/blindfold/index.js +3462 -0
- package/dist/tools/generated/blindfold/index.js.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts +8 -0
- package/dist/tools/generated/bot_and_threat_defense/index.d.ts.map +1 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js +2264 -0
- package/dist/tools/generated/bot_and_threat_defense/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -1
- package/dist/tools/generated/cdn/index.js +1498 -0
- package/dist/tools/generated/cdn/index.js.map +1 -1
- package/dist/tools/generated/ce_management/index.d.ts +8 -0
- package/dist/tools/generated/ce_management/index.d.ts.map +1 -0
- package/dist/tools/generated/ce_management/index.js +3437 -0
- package/dist/tools/generated/ce_management/index.js.map +1 -0
- package/dist/tools/generated/certificates/index.d.ts +8 -0
- package/dist/tools/generated/certificates/index.d.ts.map +1 -0
- package/dist/tools/generated/certificates/index.js +2279 -0
- package/dist/tools/generated/certificates/index.js.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/cloud_infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/cloud_infrastructure/index.js +3585 -0
- package/dist/tools/generated/cloud_infrastructure/index.js.map +1 -0
- package/dist/tools/generated/container_services/index.d.ts +8 -0
- package/dist/tools/generated/container_services/index.d.ts.map +1 -0
- package/dist/tools/generated/container_services/index.js +1806 -0
- package/dist/tools/generated/container_services/index.js.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts +8 -0
- package/dist/tools/generated/data_and_privacy_security/index.d.ts.map +1 -0
- package/dist/tools/generated/data_and_privacy_security/index.js +1519 -0
- package/dist/tools/generated/data_and_privacy_security/index.js.map +1 -0
- package/dist/tools/generated/data_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/data_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/data_intelligence/index.js +1495 -0
- package/dist/tools/generated/data_intelligence/index.js.map +1 -0
- package/dist/tools/generated/ddos/index.d.ts +8 -0
- package/dist/tools/generated/ddos/index.d.ts.map +1 -0
- package/dist/tools/generated/ddos/index.js +7427 -0
- package/dist/tools/generated/ddos/index.js.map +1 -0
- package/dist/tools/generated/dns/index.d.ts +8 -0
- package/dist/tools/generated/dns/index.d.ts.map +1 -0
- package/dist/tools/generated/dns/index.js +5604 -0
- package/dist/tools/generated/dns/index.js.map +1 -0
- package/dist/tools/generated/generative_ai/index.d.ts +8 -0
- package/dist/tools/generated/generative_ai/index.d.ts.map +1 -0
- package/dist/tools/generated/generative_ai/index.js +972 -0
- package/dist/tools/generated/generative_ai/index.js.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts +8 -0
- package/dist/tools/generated/managed_kubernetes/index.d.ts.map +1 -0
- package/dist/tools/generated/managed_kubernetes/index.js +2858 -0
- package/dist/tools/generated/managed_kubernetes/index.js.map +1 -0
- package/dist/tools/generated/marketplace/index.d.ts +8 -0
- package/dist/tools/generated/marketplace/index.d.ts.map +1 -0
- package/dist/tools/generated/marketplace/index.js +4022 -0
- package/dist/tools/generated/marketplace/index.js.map +1 -0
- package/dist/tools/generated/network/index.d.ts +8 -0
- package/dist/tools/generated/network/index.d.ts.map +1 -0
- package/dist/tools/generated/network/index.js +11132 -0
- package/dist/tools/generated/network/index.js.map +1 -0
- package/dist/tools/generated/network_security/index.d.ts +8 -0
- package/dist/tools/generated/network_security/index.d.ts.map +1 -0
- package/dist/tools/generated/network_security/index.js +7827 -0
- package/dist/tools/generated/network_security/index.js.map +1 -0
- package/dist/tools/generated/nginx_one/index.d.ts +8 -0
- package/dist/tools/generated/nginx_one/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx_one/index.js +1598 -0
- package/dist/tools/generated/nginx_one/index.js.map +1 -0
- package/dist/tools/generated/object_storage/index.d.ts +8 -0
- package/dist/tools/generated/object_storage/index.d.ts.map +1 -0
- package/dist/tools/generated/object_storage/index.js +964 -0
- package/dist/tools/generated/object_storage/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -1
- package/dist/tools/generated/observability/index.js +3521 -4641
- package/dist/tools/generated/observability/index.js.map +1 -1
- package/dist/tools/generated/rate_limiting/index.d.ts +8 -0
- package/dist/tools/generated/rate_limiting/index.d.ts.map +1 -0
- package/dist/tools/generated/rate_limiting/index.js +1712 -0
- package/dist/tools/generated/rate_limiting/index.js.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts +8 -0
- package/dist/tools/generated/secops_and_incident_response/index.d.ts.map +1 -0
- package/dist/tools/generated/secops_and_incident_response/index.js +578 -0
- package/dist/tools/generated/secops_and_incident_response/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -1
- package/dist/tools/generated/service_mesh/index.js +3810 -438
- package/dist/tools/generated/service_mesh/index.js.map +1 -1
- package/dist/tools/generated/shape/index.d.ts +8 -0
- package/dist/tools/generated/shape/index.d.ts.map +1 -0
- package/dist/tools/generated/shape/index.js +18464 -0
- package/dist/tools/generated/shape/index.js.map +1 -0
- package/dist/tools/generated/sites/index.d.ts +8 -0
- package/dist/tools/generated/sites/index.d.ts.map +1 -0
- package/dist/tools/generated/sites/index.js +11494 -0
- package/dist/tools/generated/sites/index.js.map +1 -0
- package/dist/tools/generated/statistics/index.d.ts +8 -0
- package/dist/tools/generated/statistics/index.d.ts.map +1 -0
- package/dist/tools/generated/statistics/index.js +7557 -0
- package/dist/tools/generated/statistics/index.js.map +1 -0
- package/dist/tools/generated/support/index.d.ts +8 -0
- package/dist/tools/generated/support/index.d.ts.map +1 -0
- package/dist/tools/generated/support/index.js +5334 -0
- package/dist/tools/generated/support/index.js.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts +8 -0
- package/dist/tools/generated/telemetry_and_insights/index.d.ts.map +1 -0
- package/dist/tools/generated/telemetry_and_insights/index.js +2304 -0
- package/dist/tools/generated/telemetry_and_insights/index.js.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts +8 -0
- package/dist/tools/generated/tenant_and_identity/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_and_identity/index.js +17560 -0
- package/dist/tools/generated/tenant_and_identity/index.js.map +1 -0
- package/dist/tools/generated/threat_campaign/index.d.ts +8 -0
- package/dist/tools/generated/threat_campaign/index.d.ts.map +1 -0
- package/dist/tools/generated/threat_campaign/index.js +99 -0
- package/dist/tools/generated/threat_campaign/index.js.map +1 -0
- package/dist/tools/generated/users/index.d.ts +8 -0
- package/dist/tools/generated/users/index.d.ts.map +1 -0
- package/dist/tools/generated/users/index.js +1376 -0
- package/dist/tools/generated/users/index.js.map +1 -0
- package/dist/tools/generated/virtual/index.d.ts +8 -0
- package/dist/tools/generated/virtual/index.d.ts.map +1 -0
- package/dist/tools/generated/virtual/index.js +10103 -0
- package/dist/tools/generated/virtual/index.js.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts +8 -0
- package/dist/tools/generated/vpm_and_node_management/index.d.ts.map +1 -0
- package/dist/tools/generated/vpm_and_node_management/index.js +85 -0
- package/dist/tools/generated/vpm_and_node_management/index.js.map +1 -0
- package/dist/tools/generated/waf/index.d.ts +8 -0
- package/dist/tools/generated/waf/index.d.ts.map +1 -0
- package/dist/tools/generated/waf/index.js +3802 -0
- package/dist/tools/generated/waf/index.js.map +1 -0
- package/dist/tools/registry.d.ts.map +1 -1
- package/dist/tools/registry.js +68 -36
- package/dist/tools/registry.js.map +1 -1
- package/package.json +3 -1
- package/dist/cli/index.d.ts +0 -16
- package/dist/cli/index.d.ts.map +0 -1
- package/dist/cli/index.js +0 -116
- package/dist/cli/index.js.map +0 -1
- package/dist/cli/setup.d.ts +0 -54
- package/dist/cli/setup.d.ts.map +0 -1
- package/dist/cli/setup.js +0 -347
- package/dist/cli/setup.js.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.d.ts +0 -8
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +0 -1
- package/dist/tools/generated/ai_intelligence/index.js +0 -282
- package/dist/tools/generated/ai_intelligence/index.js.map +0 -1
- package/dist/tools/generated/api_security/index.d.ts +0 -8
- package/dist/tools/generated/api_security/index.d.ts.map +0 -1
- package/dist/tools/generated/api_security/index.js +0 -1852
- package/dist/tools/generated/api_security/index.js.map +0 -1
- package/dist/tools/generated/applications/index.d.ts +0 -8
- package/dist/tools/generated/applications/index.d.ts.map +0 -1
- package/dist/tools/generated/applications/index.js +0 -1589
- package/dist/tools/generated/applications/index.js.map +0 -1
- package/dist/tools/generated/billing/index.d.ts +0 -8
- package/dist/tools/generated/billing/index.d.ts.map +0 -1
- package/dist/tools/generated/billing/index.js +0 -759
- package/dist/tools/generated/billing/index.js.map +0 -1
- package/dist/tools/generated/config/index.d.ts +0 -8
- package/dist/tools/generated/config/index.d.ts.map +0 -1
- package/dist/tools/generated/config/index.js +0 -316
- package/dist/tools/generated/config/index.js.map +0 -1
- package/dist/tools/generated/identity/index.d.ts +0 -8
- package/dist/tools/generated/identity/index.d.ts.map +0 -1
- package/dist/tools/generated/identity/index.js +0 -5371
- package/dist/tools/generated/identity/index.js.map +0 -1
- package/dist/tools/generated/infrastructure/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure/index.js +0 -5342
- package/dist/tools/generated/infrastructure/index.js.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.d.ts +0 -8
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +0 -1
- package/dist/tools/generated/infrastructure_protection/index.js +0 -2919
- package/dist/tools/generated/infrastructure_protection/index.js.map +0 -1
- package/dist/tools/generated/integrations/index.d.ts +0 -8
- package/dist/tools/generated/integrations/index.d.ts.map +0 -1
- package/dist/tools/generated/integrations/index.js +0 -1995
- package/dist/tools/generated/integrations/index.js.map +0 -1
- package/dist/tools/generated/load_balancer/index.d.ts +0 -8
- package/dist/tools/generated/load_balancer/index.d.ts.map +0 -1
- package/dist/tools/generated/load_balancer/index.js +0 -2269
- package/dist/tools/generated/load_balancer/index.js.map +0 -1
- package/dist/tools/generated/networking/index.d.ts +0 -8
- package/dist/tools/generated/networking/index.d.ts.map +0 -1
- package/dist/tools/generated/networking/index.js +0 -11289
- package/dist/tools/generated/networking/index.js.map +0 -1
- package/dist/tools/generated/nginx/index.d.ts +0 -8
- package/dist/tools/generated/nginx/index.d.ts.map +0 -1
- package/dist/tools/generated/nginx/index.js +0 -680
- package/dist/tools/generated/nginx/index.js.map +0 -1
- package/dist/tools/generated/operations/index.d.ts +0 -8
- package/dist/tools/generated/operations/index.d.ts.map +0 -1
- package/dist/tools/generated/operations/index.js +0 -1759
- package/dist/tools/generated/operations/index.js.map +0 -1
- package/dist/tools/generated/security/index.d.ts +0 -8
- package/dist/tools/generated/security/index.d.ts.map +0 -1
- package/dist/tools/generated/security/index.js +0 -9111
- package/dist/tools/generated/security/index.js.map +0 -1
- package/dist/tools/generated/shape_security/index.d.ts +0 -8
- package/dist/tools/generated/shape_security/index.d.ts.map +0 -1
- package/dist/tools/generated/shape_security/index.js +0 -4121
- package/dist/tools/generated/shape_security/index.js.map +0 -1
- package/dist/tools/generated/subscriptions/index.d.ts +0 -8
- package/dist/tools/generated/subscriptions/index.d.ts.map +0 -1
- package/dist/tools/generated/subscriptions/index.js +0 -778
- package/dist/tools/generated/subscriptions/index.js.map +0 -1
- package/dist/tools/generated/tenant_management/index.d.ts +0 -8
- package/dist/tools/generated/tenant_management/index.d.ts.map +0 -1
- package/dist/tools/generated/tenant_management/index.js +0 -2292
- package/dist/tools/generated/tenant_management/index.js.map +0 -1
- package/dist/tools/generated/vpn/index.d.ts +0 -8
- package/dist/tools/generated/vpn/index.js +0 -1183
- package/dist/tools/generated/vpn/index.js.map +0 -1
|
@@ -21,6 +21,8 @@ export const cdnTools = [
|
|
|
21
21
|
schema: {
|
|
22
22
|
type: "string",
|
|
23
23
|
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "Value",
|
|
24
26
|
},
|
|
25
27
|
],
|
|
26
28
|
queryParameters: [],
|
|
@@ -34,6 +36,69 @@ export const cdnTools = [
|
|
|
34
36
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNAccessLogs",
|
|
35
37
|
tags: ["CDN"],
|
|
36
38
|
sourceFile: "domains/cdn.json",
|
|
39
|
+
displayName: null,
|
|
40
|
+
dangerLevel: "medium",
|
|
41
|
+
sideEffects: {
|
|
42
|
+
creates: ["access-log"],
|
|
43
|
+
},
|
|
44
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
45
|
+
confirmationRequired: false,
|
|
46
|
+
parameterExamples: {
|
|
47
|
+
namespace: "Value",
|
|
48
|
+
},
|
|
49
|
+
validationRules: {},
|
|
50
|
+
operationMetadata: {
|
|
51
|
+
common_errors: [
|
|
52
|
+
{
|
|
53
|
+
code: 401,
|
|
54
|
+
message: "Authentication required",
|
|
55
|
+
solution: "Provide valid API credentials",
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
code: 403,
|
|
59
|
+
message: "Permission denied",
|
|
60
|
+
solution: "Check access permissions for this operation",
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
code: 404,
|
|
64
|
+
message: "Resource not found",
|
|
65
|
+
solution: "Verify resource name, namespace, and path",
|
|
66
|
+
},
|
|
67
|
+
{
|
|
68
|
+
code: 409,
|
|
69
|
+
message: "Resource already exists",
|
|
70
|
+
solution: "Use different name or update existing resource",
|
|
71
|
+
},
|
|
72
|
+
{
|
|
73
|
+
code: 429,
|
|
74
|
+
message: "Rate limit exceeded",
|
|
75
|
+
solution: "Wait before retrying the operation",
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
code: 500,
|
|
79
|
+
message: "Server error",
|
|
80
|
+
solution: "Retry operation or contact support",
|
|
81
|
+
},
|
|
82
|
+
],
|
|
83
|
+
conditions: {
|
|
84
|
+
postconditions: ["Access-log resource created", "Resource assigned unique identifier"],
|
|
85
|
+
prerequisites: ["Active namespace"],
|
|
86
|
+
},
|
|
87
|
+
confirmation_required: false,
|
|
88
|
+
danger_level: "medium",
|
|
89
|
+
field_docs: {},
|
|
90
|
+
optional_fields: [],
|
|
91
|
+
performance_impact: {
|
|
92
|
+
latency: "low",
|
|
93
|
+
resource_usage: "low",
|
|
94
|
+
},
|
|
95
|
+
purpose: "Create new access-log",
|
|
96
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
97
|
+
side_effects: {
|
|
98
|
+
creates: ["access-log"],
|
|
99
|
+
},
|
|
100
|
+
},
|
|
101
|
+
curlExample: null,
|
|
37
102
|
},
|
|
38
103
|
{
|
|
39
104
|
toolName: "f5xc-api-cdn-aggregation-create",
|
|
@@ -53,6 +118,8 @@ export const cdnTools = [
|
|
|
53
118
|
schema: {
|
|
54
119
|
type: "string",
|
|
55
120
|
},
|
|
121
|
+
"x-displayname": "Namespace",
|
|
122
|
+
"x-ves-example": "Value",
|
|
56
123
|
},
|
|
57
124
|
],
|
|
58
125
|
queryParameters: [],
|
|
@@ -66,6 +133,69 @@ export const cdnTools = [
|
|
|
66
133
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNAccessLogAggregationQuery",
|
|
67
134
|
tags: ["CDN"],
|
|
68
135
|
sourceFile: "domains/cdn.json",
|
|
136
|
+
displayName: null,
|
|
137
|
+
dangerLevel: "medium",
|
|
138
|
+
sideEffects: {
|
|
139
|
+
creates: ["aggregation"],
|
|
140
|
+
},
|
|
141
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
142
|
+
confirmationRequired: false,
|
|
143
|
+
parameterExamples: {
|
|
144
|
+
namespace: "Value",
|
|
145
|
+
},
|
|
146
|
+
validationRules: {},
|
|
147
|
+
operationMetadata: {
|
|
148
|
+
common_errors: [
|
|
149
|
+
{
|
|
150
|
+
code: 401,
|
|
151
|
+
message: "Authentication required",
|
|
152
|
+
solution: "Provide valid API credentials",
|
|
153
|
+
},
|
|
154
|
+
{
|
|
155
|
+
code: 403,
|
|
156
|
+
message: "Permission denied",
|
|
157
|
+
solution: "Check access permissions for this operation",
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
code: 404,
|
|
161
|
+
message: "Resource not found",
|
|
162
|
+
solution: "Verify resource name, namespace, and path",
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
code: 409,
|
|
166
|
+
message: "Resource already exists",
|
|
167
|
+
solution: "Use different name or update existing resource",
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
code: 429,
|
|
171
|
+
message: "Rate limit exceeded",
|
|
172
|
+
solution: "Wait before retrying the operation",
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
code: 500,
|
|
176
|
+
message: "Server error",
|
|
177
|
+
solution: "Retry operation or contact support",
|
|
178
|
+
},
|
|
179
|
+
],
|
|
180
|
+
conditions: {
|
|
181
|
+
postconditions: ["Aggregation resource created", "Resource assigned unique identifier"],
|
|
182
|
+
prerequisites: ["Active namespace"],
|
|
183
|
+
},
|
|
184
|
+
confirmation_required: false,
|
|
185
|
+
danger_level: "medium",
|
|
186
|
+
field_docs: {},
|
|
187
|
+
optional_fields: [],
|
|
188
|
+
performance_impact: {
|
|
189
|
+
latency: "low",
|
|
190
|
+
resource_usage: "low",
|
|
191
|
+
},
|
|
192
|
+
purpose: "Create new aggregation",
|
|
193
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
194
|
+
side_effects: {
|
|
195
|
+
creates: ["aggregation"],
|
|
196
|
+
},
|
|
197
|
+
},
|
|
198
|
+
curlExample: null,
|
|
69
199
|
},
|
|
70
200
|
{
|
|
71
201
|
toolName: "f5xc-api-cdn-cache-purge-create",
|
|
@@ -85,6 +215,8 @@ export const cdnTools = [
|
|
|
85
215
|
schema: {
|
|
86
216
|
type: "string",
|
|
87
217
|
},
|
|
218
|
+
"x-displayname": "Name of the CDN distrubition.",
|
|
219
|
+
"x-ves-example": "CDN-1",
|
|
88
220
|
},
|
|
89
221
|
{
|
|
90
222
|
description: "Namespace\nx-required\nNamespace scope of the metric request.",
|
|
@@ -94,6 +226,8 @@ export const cdnTools = [
|
|
|
94
226
|
schema: {
|
|
95
227
|
type: "string",
|
|
96
228
|
},
|
|
229
|
+
"x-displayname": "Namespace",
|
|
230
|
+
"x-ves-example": "Default",
|
|
97
231
|
},
|
|
98
232
|
],
|
|
99
233
|
queryParameters: [],
|
|
@@ -107,6 +241,70 @@ export const cdnTools = [
|
|
|
107
241
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNCachePurge",
|
|
108
242
|
tags: ["CDN"],
|
|
109
243
|
sourceFile: "domains/cdn.json",
|
|
244
|
+
displayName: null,
|
|
245
|
+
dangerLevel: "medium",
|
|
246
|
+
sideEffects: {
|
|
247
|
+
creates: ["cache-purge"],
|
|
248
|
+
},
|
|
249
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
250
|
+
confirmationRequired: false,
|
|
251
|
+
parameterExamples: {
|
|
252
|
+
name: "CDN-1",
|
|
253
|
+
namespace: "Default",
|
|
254
|
+
},
|
|
255
|
+
validationRules: {},
|
|
256
|
+
operationMetadata: {
|
|
257
|
+
common_errors: [
|
|
258
|
+
{
|
|
259
|
+
code: 401,
|
|
260
|
+
message: "Authentication required",
|
|
261
|
+
solution: "Provide valid API credentials",
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
code: 403,
|
|
265
|
+
message: "Permission denied",
|
|
266
|
+
solution: "Check access permissions for this operation",
|
|
267
|
+
},
|
|
268
|
+
{
|
|
269
|
+
code: 404,
|
|
270
|
+
message: "Resource not found",
|
|
271
|
+
solution: "Verify resource name, namespace, and path",
|
|
272
|
+
},
|
|
273
|
+
{
|
|
274
|
+
code: 409,
|
|
275
|
+
message: "Resource already exists",
|
|
276
|
+
solution: "Use different name or update existing resource",
|
|
277
|
+
},
|
|
278
|
+
{
|
|
279
|
+
code: 429,
|
|
280
|
+
message: "Rate limit exceeded",
|
|
281
|
+
solution: "Wait before retrying the operation",
|
|
282
|
+
},
|
|
283
|
+
{
|
|
284
|
+
code: 500,
|
|
285
|
+
message: "Server error",
|
|
286
|
+
solution: "Retry operation or contact support",
|
|
287
|
+
},
|
|
288
|
+
],
|
|
289
|
+
conditions: {
|
|
290
|
+
postconditions: ["Cache-purge resource created", "Resource assigned unique identifier"],
|
|
291
|
+
prerequisites: ["Active namespace"],
|
|
292
|
+
},
|
|
293
|
+
confirmation_required: false,
|
|
294
|
+
danger_level: "medium",
|
|
295
|
+
field_docs: {},
|
|
296
|
+
optional_fields: [],
|
|
297
|
+
performance_impact: {
|
|
298
|
+
latency: "low",
|
|
299
|
+
resource_usage: "low",
|
|
300
|
+
},
|
|
301
|
+
purpose: "Create new cache-purge",
|
|
302
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
303
|
+
side_effects: {
|
|
304
|
+
creates: ["cache-purge"],
|
|
305
|
+
},
|
|
306
|
+
},
|
|
307
|
+
curlExample: null,
|
|
110
308
|
},
|
|
111
309
|
{
|
|
112
310
|
toolName: "f5xc-api-cdn-cdn-cache-rule-create",
|
|
@@ -126,6 +324,8 @@ export const cdnTools = [
|
|
|
126
324
|
schema: {
|
|
127
325
|
type: "string",
|
|
128
326
|
},
|
|
327
|
+
"x-displayname": "Namespace",
|
|
328
|
+
"x-ves-example": "Staging",
|
|
129
329
|
},
|
|
130
330
|
],
|
|
131
331
|
queryParameters: [],
|
|
@@ -139,6 +339,69 @@ export const cdnTools = [
|
|
|
139
339
|
operationId: "ves.io.schema.cdn_cache_rule.API.Create",
|
|
140
340
|
tags: ["Other"],
|
|
141
341
|
sourceFile: "domains/cdn.json",
|
|
342
|
+
displayName: null,
|
|
343
|
+
dangerLevel: "medium",
|
|
344
|
+
sideEffects: {
|
|
345
|
+
creates: ["cdn-cache-rule"],
|
|
346
|
+
},
|
|
347
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
348
|
+
confirmationRequired: false,
|
|
349
|
+
parameterExamples: {
|
|
350
|
+
"metadata.namespace": "Staging",
|
|
351
|
+
},
|
|
352
|
+
validationRules: {},
|
|
353
|
+
operationMetadata: {
|
|
354
|
+
common_errors: [
|
|
355
|
+
{
|
|
356
|
+
code: 401,
|
|
357
|
+
message: "Authentication required",
|
|
358
|
+
solution: "Provide valid API credentials",
|
|
359
|
+
},
|
|
360
|
+
{
|
|
361
|
+
code: 403,
|
|
362
|
+
message: "Permission denied",
|
|
363
|
+
solution: "Check access permissions for this operation",
|
|
364
|
+
},
|
|
365
|
+
{
|
|
366
|
+
code: 404,
|
|
367
|
+
message: "Resource not found",
|
|
368
|
+
solution: "Verify resource name, namespace, and path",
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
code: 409,
|
|
372
|
+
message: "Resource already exists",
|
|
373
|
+
solution: "Use different name or update existing resource",
|
|
374
|
+
},
|
|
375
|
+
{
|
|
376
|
+
code: 429,
|
|
377
|
+
message: "Rate limit exceeded",
|
|
378
|
+
solution: "Wait before retrying the operation",
|
|
379
|
+
},
|
|
380
|
+
{
|
|
381
|
+
code: 500,
|
|
382
|
+
message: "Server error",
|
|
383
|
+
solution: "Retry operation or contact support",
|
|
384
|
+
},
|
|
385
|
+
],
|
|
386
|
+
conditions: {
|
|
387
|
+
postconditions: ["Cdn-cache-rule resource created", "Resource assigned unique identifier"],
|
|
388
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
389
|
+
},
|
|
390
|
+
confirmation_required: false,
|
|
391
|
+
danger_level: "medium",
|
|
392
|
+
field_docs: {},
|
|
393
|
+
optional_fields: [],
|
|
394
|
+
performance_impact: {
|
|
395
|
+
latency: "low",
|
|
396
|
+
resource_usage: "low",
|
|
397
|
+
},
|
|
398
|
+
purpose: "Create new cdn-cache-rule",
|
|
399
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
400
|
+
side_effects: {
|
|
401
|
+
creates: ["cdn-cache-rule"],
|
|
402
|
+
},
|
|
403
|
+
},
|
|
404
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_cache_rules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
142
405
|
},
|
|
143
406
|
{
|
|
144
407
|
toolName: "f5xc-api-cdn-cdn-cache-rule-delete",
|
|
@@ -158,6 +421,8 @@ export const cdnTools = [
|
|
|
158
421
|
schema: {
|
|
159
422
|
type: "string",
|
|
160
423
|
},
|
|
424
|
+
"x-displayname": "Name",
|
|
425
|
+
"x-ves-example": "Name",
|
|
161
426
|
},
|
|
162
427
|
{
|
|
163
428
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -167,6 +432,8 @@ export const cdnTools = [
|
|
|
167
432
|
schema: {
|
|
168
433
|
type: "string",
|
|
169
434
|
},
|
|
435
|
+
"x-displayname": "Namespace",
|
|
436
|
+
"x-ves-example": "Ns1",
|
|
170
437
|
},
|
|
171
438
|
],
|
|
172
439
|
queryParameters: [],
|
|
@@ -178,6 +445,70 @@ export const cdnTools = [
|
|
|
178
445
|
operationId: "ves.io.schema.cdn_cache_rule.API.Delete",
|
|
179
446
|
tags: ["Other"],
|
|
180
447
|
sourceFile: "domains/cdn.json",
|
|
448
|
+
displayName: null,
|
|
449
|
+
dangerLevel: "high",
|
|
450
|
+
sideEffects: {
|
|
451
|
+
deletes: ["cdn-cache-rule", "contained_resources"],
|
|
452
|
+
},
|
|
453
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
454
|
+
confirmationRequired: true,
|
|
455
|
+
parameterExamples: {
|
|
456
|
+
name: "Name",
|
|
457
|
+
namespace: "Ns1",
|
|
458
|
+
},
|
|
459
|
+
validationRules: {},
|
|
460
|
+
operationMetadata: {
|
|
461
|
+
common_errors: [
|
|
462
|
+
{
|
|
463
|
+
code: 401,
|
|
464
|
+
message: "Authentication required",
|
|
465
|
+
solution: "Provide valid API credentials",
|
|
466
|
+
},
|
|
467
|
+
{
|
|
468
|
+
code: 403,
|
|
469
|
+
message: "Permission denied",
|
|
470
|
+
solution: "Check access permissions for this operation",
|
|
471
|
+
},
|
|
472
|
+
{
|
|
473
|
+
code: 404,
|
|
474
|
+
message: "Resource not found",
|
|
475
|
+
solution: "Verify resource name, namespace, and path",
|
|
476
|
+
},
|
|
477
|
+
{
|
|
478
|
+
code: 409,
|
|
479
|
+
message: "Resource already exists",
|
|
480
|
+
solution: "Use different name or update existing resource",
|
|
481
|
+
},
|
|
482
|
+
{
|
|
483
|
+
code: 429,
|
|
484
|
+
message: "Rate limit exceeded",
|
|
485
|
+
solution: "Wait before retrying the operation",
|
|
486
|
+
},
|
|
487
|
+
{
|
|
488
|
+
code: 500,
|
|
489
|
+
message: "Server error",
|
|
490
|
+
solution: "Retry operation or contact support",
|
|
491
|
+
},
|
|
492
|
+
],
|
|
493
|
+
conditions: {
|
|
494
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
495
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
496
|
+
},
|
|
497
|
+
confirmation_required: true,
|
|
498
|
+
danger_level: "high",
|
|
499
|
+
field_docs: {},
|
|
500
|
+
optional_fields: [],
|
|
501
|
+
performance_impact: {
|
|
502
|
+
latency: "high",
|
|
503
|
+
resource_usage: "moderate",
|
|
504
|
+
},
|
|
505
|
+
purpose: "Delete cdn-cache-rule",
|
|
506
|
+
required_fields: ["path.name", "path.namespace"],
|
|
507
|
+
side_effects: {
|
|
508
|
+
deletes: ["cdn-cache-rule", "contained_resources"],
|
|
509
|
+
},
|
|
510
|
+
},
|
|
511
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_cache_rules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
181
512
|
},
|
|
182
513
|
{
|
|
183
514
|
toolName: "f5xc-api-cdn-cdn-cache-rule-get",
|
|
@@ -197,6 +528,8 @@ export const cdnTools = [
|
|
|
197
528
|
schema: {
|
|
198
529
|
type: "string",
|
|
199
530
|
},
|
|
531
|
+
"x-displayname": "Name",
|
|
532
|
+
"x-ves-example": "Name",
|
|
200
533
|
},
|
|
201
534
|
{
|
|
202
535
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -206,6 +539,8 @@ export const cdnTools = [
|
|
|
206
539
|
schema: {
|
|
207
540
|
type: "string",
|
|
208
541
|
},
|
|
542
|
+
"x-displayname": "Namespace",
|
|
543
|
+
"x-ves-example": "Ns1",
|
|
209
544
|
},
|
|
210
545
|
],
|
|
211
546
|
queryParameters: [
|
|
@@ -226,6 +561,7 @@ export const cdnTools = [
|
|
|
226
561
|
],
|
|
227
562
|
type: "string",
|
|
228
563
|
},
|
|
564
|
+
"x-displayname": "Broken Referred Objects.",
|
|
229
565
|
},
|
|
230
566
|
],
|
|
231
567
|
requestBodySchema: null,
|
|
@@ -236,6 +572,66 @@ export const cdnTools = [
|
|
|
236
572
|
operationId: "ves.io.schema.cdn_cache_rule.API.Get",
|
|
237
573
|
tags: ["Other"],
|
|
238
574
|
sourceFile: "domains/cdn.json",
|
|
575
|
+
displayName: null,
|
|
576
|
+
dangerLevel: "low",
|
|
577
|
+
sideEffects: null,
|
|
578
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
579
|
+
confirmationRequired: false,
|
|
580
|
+
parameterExamples: {
|
|
581
|
+
name: "Name",
|
|
582
|
+
namespace: "Ns1",
|
|
583
|
+
},
|
|
584
|
+
validationRules: {},
|
|
585
|
+
operationMetadata: {
|
|
586
|
+
common_errors: [
|
|
587
|
+
{
|
|
588
|
+
code: 401,
|
|
589
|
+
message: "Authentication required",
|
|
590
|
+
solution: "Provide valid API credentials",
|
|
591
|
+
},
|
|
592
|
+
{
|
|
593
|
+
code: 403,
|
|
594
|
+
message: "Permission denied",
|
|
595
|
+
solution: "Check access permissions for this operation",
|
|
596
|
+
},
|
|
597
|
+
{
|
|
598
|
+
code: 404,
|
|
599
|
+
message: "Resource not found",
|
|
600
|
+
solution: "Verify resource name, namespace, and path",
|
|
601
|
+
},
|
|
602
|
+
{
|
|
603
|
+
code: 409,
|
|
604
|
+
message: "Resource already exists",
|
|
605
|
+
solution: "Use different name or update existing resource",
|
|
606
|
+
},
|
|
607
|
+
{
|
|
608
|
+
code: 429,
|
|
609
|
+
message: "Rate limit exceeded",
|
|
610
|
+
solution: "Wait before retrying the operation",
|
|
611
|
+
},
|
|
612
|
+
{
|
|
613
|
+
code: 500,
|
|
614
|
+
message: "Server error",
|
|
615
|
+
solution: "Retry operation or contact support",
|
|
616
|
+
},
|
|
617
|
+
],
|
|
618
|
+
conditions: {
|
|
619
|
+
postconditions: [],
|
|
620
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
621
|
+
},
|
|
622
|
+
confirmation_required: false,
|
|
623
|
+
danger_level: "low",
|
|
624
|
+
field_docs: {},
|
|
625
|
+
optional_fields: [],
|
|
626
|
+
performance_impact: {
|
|
627
|
+
latency: "low",
|
|
628
|
+
resource_usage: "low",
|
|
629
|
+
},
|
|
630
|
+
purpose: "Retrieve specific cdn-cache-rule",
|
|
631
|
+
required_fields: ["path.name", "path.namespace"],
|
|
632
|
+
side_effects: {},
|
|
633
|
+
},
|
|
634
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_cache_rules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
239
635
|
},
|
|
240
636
|
{
|
|
241
637
|
toolName: "f5xc-api-cdn-cdn-cache-rule-list",
|
|
@@ -255,6 +651,8 @@ export const cdnTools = [
|
|
|
255
651
|
schema: {
|
|
256
652
|
type: "string",
|
|
257
653
|
},
|
|
654
|
+
"x-displayname": "Namespace",
|
|
655
|
+
"x-ves-example": "Ns1",
|
|
258
656
|
},
|
|
259
657
|
],
|
|
260
658
|
queryParameters: [
|
|
@@ -266,6 +664,8 @@ export const cdnTools = [
|
|
|
266
664
|
schema: {
|
|
267
665
|
type: "string",
|
|
268
666
|
},
|
|
667
|
+
"x-displayname": "Label Filter.",
|
|
668
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
269
669
|
},
|
|
270
670
|
{
|
|
271
671
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -278,6 +678,7 @@ export const cdnTools = [
|
|
|
278
678
|
},
|
|
279
679
|
type: "array",
|
|
280
680
|
},
|
|
681
|
+
"x-displayname": "Report Fields.",
|
|
281
682
|
},
|
|
282
683
|
{
|
|
283
684
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -290,6 +691,7 @@ export const cdnTools = [
|
|
|
290
691
|
},
|
|
291
692
|
type: "array",
|
|
292
693
|
},
|
|
694
|
+
"x-displayname": "Report Status Fields.",
|
|
293
695
|
},
|
|
294
696
|
],
|
|
295
697
|
requestBodySchema: null,
|
|
@@ -300,6 +702,66 @@ export const cdnTools = [
|
|
|
300
702
|
operationId: "ves.io.schema.cdn_cache_rule.API.List",
|
|
301
703
|
tags: ["Other"],
|
|
302
704
|
sourceFile: "domains/cdn.json",
|
|
705
|
+
displayName: null,
|
|
706
|
+
dangerLevel: "low",
|
|
707
|
+
sideEffects: null,
|
|
708
|
+
requiredFields: ["path.namespace"],
|
|
709
|
+
confirmationRequired: false,
|
|
710
|
+
parameterExamples: {
|
|
711
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
712
|
+
namespace: "Ns1",
|
|
713
|
+
},
|
|
714
|
+
validationRules: {},
|
|
715
|
+
operationMetadata: {
|
|
716
|
+
common_errors: [
|
|
717
|
+
{
|
|
718
|
+
code: 401,
|
|
719
|
+
message: "Authentication required",
|
|
720
|
+
solution: "Provide valid API credentials",
|
|
721
|
+
},
|
|
722
|
+
{
|
|
723
|
+
code: 403,
|
|
724
|
+
message: "Permission denied",
|
|
725
|
+
solution: "Check access permissions for this operation",
|
|
726
|
+
},
|
|
727
|
+
{
|
|
728
|
+
code: 404,
|
|
729
|
+
message: "Resource not found",
|
|
730
|
+
solution: "Verify resource name, namespace, and path",
|
|
731
|
+
},
|
|
732
|
+
{
|
|
733
|
+
code: 409,
|
|
734
|
+
message: "Resource already exists",
|
|
735
|
+
solution: "Use different name or update existing resource",
|
|
736
|
+
},
|
|
737
|
+
{
|
|
738
|
+
code: 429,
|
|
739
|
+
message: "Rate limit exceeded",
|
|
740
|
+
solution: "Wait before retrying the operation",
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
code: 500,
|
|
744
|
+
message: "Server error",
|
|
745
|
+
solution: "Retry operation or contact support",
|
|
746
|
+
},
|
|
747
|
+
],
|
|
748
|
+
conditions: {
|
|
749
|
+
postconditions: [],
|
|
750
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
751
|
+
},
|
|
752
|
+
confirmation_required: false,
|
|
753
|
+
danger_level: "low",
|
|
754
|
+
field_docs: {},
|
|
755
|
+
optional_fields: [],
|
|
756
|
+
performance_impact: {
|
|
757
|
+
latency: "moderate",
|
|
758
|
+
resource_usage: "moderate",
|
|
759
|
+
},
|
|
760
|
+
purpose: "List all cdn-cache-rules",
|
|
761
|
+
required_fields: ["path.namespace"],
|
|
762
|
+
side_effects: {},
|
|
763
|
+
},
|
|
764
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_cache_rules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
303
765
|
},
|
|
304
766
|
{
|
|
305
767
|
toolName: "f5xc-api-cdn-cdn-cache-rule-update",
|
|
@@ -319,6 +781,8 @@ export const cdnTools = [
|
|
|
319
781
|
schema: {
|
|
320
782
|
type: "string",
|
|
321
783
|
},
|
|
784
|
+
"x-displayname": "Name",
|
|
785
|
+
"x-ves-example": "Example-corp-web.",
|
|
322
786
|
},
|
|
323
787
|
{
|
|
324
788
|
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 ""',
|
|
@@ -328,6 +792,8 @@ export const cdnTools = [
|
|
|
328
792
|
schema: {
|
|
329
793
|
type: "string",
|
|
330
794
|
},
|
|
795
|
+
"x-displayname": "Namespace",
|
|
796
|
+
"x-ves-example": "Staging",
|
|
331
797
|
},
|
|
332
798
|
],
|
|
333
799
|
queryParameters: [],
|
|
@@ -341,6 +807,70 @@ export const cdnTools = [
|
|
|
341
807
|
operationId: "ves.io.schema.cdn_cache_rule.API.Replace",
|
|
342
808
|
tags: ["Other"],
|
|
343
809
|
sourceFile: "domains/cdn.json",
|
|
810
|
+
displayName: null,
|
|
811
|
+
dangerLevel: "medium",
|
|
812
|
+
sideEffects: {
|
|
813
|
+
modifies: ["cdn-cache-rule"],
|
|
814
|
+
},
|
|
815
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
816
|
+
confirmationRequired: false,
|
|
817
|
+
parameterExamples: {
|
|
818
|
+
"metadata.name": "Example-corp-web.",
|
|
819
|
+
"metadata.namespace": "Staging",
|
|
820
|
+
},
|
|
821
|
+
validationRules: {},
|
|
822
|
+
operationMetadata: {
|
|
823
|
+
common_errors: [
|
|
824
|
+
{
|
|
825
|
+
code: 401,
|
|
826
|
+
message: "Authentication required",
|
|
827
|
+
solution: "Provide valid API credentials",
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
code: 403,
|
|
831
|
+
message: "Permission denied",
|
|
832
|
+
solution: "Check access permissions for this operation",
|
|
833
|
+
},
|
|
834
|
+
{
|
|
835
|
+
code: 404,
|
|
836
|
+
message: "Resource not found",
|
|
837
|
+
solution: "Verify resource name, namespace, and path",
|
|
838
|
+
},
|
|
839
|
+
{
|
|
840
|
+
code: 409,
|
|
841
|
+
message: "Resource already exists",
|
|
842
|
+
solution: "Use different name or update existing resource",
|
|
843
|
+
},
|
|
844
|
+
{
|
|
845
|
+
code: 429,
|
|
846
|
+
message: "Rate limit exceeded",
|
|
847
|
+
solution: "Wait before retrying the operation",
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
code: 500,
|
|
851
|
+
message: "Server error",
|
|
852
|
+
solution: "Retry operation or contact support",
|
|
853
|
+
},
|
|
854
|
+
],
|
|
855
|
+
conditions: {
|
|
856
|
+
postconditions: ["Resource updated with new values"],
|
|
857
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
858
|
+
},
|
|
859
|
+
confirmation_required: false,
|
|
860
|
+
danger_level: "medium",
|
|
861
|
+
field_docs: {},
|
|
862
|
+
optional_fields: [],
|
|
863
|
+
performance_impact: {
|
|
864
|
+
latency: "low",
|
|
865
|
+
resource_usage: "low",
|
|
866
|
+
},
|
|
867
|
+
purpose: "Replace existing cdn-cache-rule",
|
|
868
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
869
|
+
side_effects: {
|
|
870
|
+
modifies: ["cdn-cache-rule"],
|
|
871
|
+
},
|
|
872
|
+
},
|
|
873
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_cache_rules" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
344
874
|
},
|
|
345
875
|
{
|
|
346
876
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-create",
|
|
@@ -360,6 +890,8 @@ export const cdnTools = [
|
|
|
360
890
|
schema: {
|
|
361
891
|
type: "string",
|
|
362
892
|
},
|
|
893
|
+
"x-displayname": "Namespace",
|
|
894
|
+
"x-ves-example": "Staging",
|
|
363
895
|
},
|
|
364
896
|
],
|
|
365
897
|
queryParameters: [],
|
|
@@ -373,6 +905,72 @@ export const cdnTools = [
|
|
|
373
905
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Create",
|
|
374
906
|
tags: ["Other"],
|
|
375
907
|
sourceFile: "domains/cdn.json",
|
|
908
|
+
displayName: null,
|
|
909
|
+
dangerLevel: "medium",
|
|
910
|
+
sideEffects: {
|
|
911
|
+
creates: ["cdn-loadbalancer"],
|
|
912
|
+
},
|
|
913
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
914
|
+
confirmationRequired: false,
|
|
915
|
+
parameterExamples: {
|
|
916
|
+
"metadata.namespace": "Staging",
|
|
917
|
+
},
|
|
918
|
+
validationRules: {},
|
|
919
|
+
operationMetadata: {
|
|
920
|
+
common_errors: [
|
|
921
|
+
{
|
|
922
|
+
code: 401,
|
|
923
|
+
message: "Authentication required",
|
|
924
|
+
solution: "Provide valid API credentials",
|
|
925
|
+
},
|
|
926
|
+
{
|
|
927
|
+
code: 403,
|
|
928
|
+
message: "Permission denied",
|
|
929
|
+
solution: "Check access permissions for this operation",
|
|
930
|
+
},
|
|
931
|
+
{
|
|
932
|
+
code: 404,
|
|
933
|
+
message: "Resource not found",
|
|
934
|
+
solution: "Verify resource name, namespace, and path",
|
|
935
|
+
},
|
|
936
|
+
{
|
|
937
|
+
code: 409,
|
|
938
|
+
message: "Resource already exists",
|
|
939
|
+
solution: "Use different name or update existing resource",
|
|
940
|
+
},
|
|
941
|
+
{
|
|
942
|
+
code: 429,
|
|
943
|
+
message: "Rate limit exceeded",
|
|
944
|
+
solution: "Wait before retrying the operation",
|
|
945
|
+
},
|
|
946
|
+
{
|
|
947
|
+
code: 500,
|
|
948
|
+
message: "Server error",
|
|
949
|
+
solution: "Retry operation or contact support",
|
|
950
|
+
},
|
|
951
|
+
],
|
|
952
|
+
conditions: {
|
|
953
|
+
postconditions: [
|
|
954
|
+
"Cdn-loadbalancer resource created",
|
|
955
|
+
"Resource assigned unique identifier",
|
|
956
|
+
],
|
|
957
|
+
prerequisites: ["Active namespace"],
|
|
958
|
+
},
|
|
959
|
+
confirmation_required: false,
|
|
960
|
+
danger_level: "medium",
|
|
961
|
+
field_docs: {},
|
|
962
|
+
optional_fields: [],
|
|
963
|
+
performance_impact: {
|
|
964
|
+
latency: "low",
|
|
965
|
+
resource_usage: "low",
|
|
966
|
+
},
|
|
967
|
+
purpose: "Create new cdn-loadbalancer",
|
|
968
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
969
|
+
side_effects: {
|
|
970
|
+
creates: ["cdn-loadbalancer"],
|
|
971
|
+
},
|
|
972
|
+
},
|
|
973
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_loadbalancers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
376
974
|
},
|
|
377
975
|
{
|
|
378
976
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-delete",
|
|
@@ -392,6 +990,8 @@ export const cdnTools = [
|
|
|
392
990
|
schema: {
|
|
393
991
|
type: "string",
|
|
394
992
|
},
|
|
993
|
+
"x-displayname": "Name",
|
|
994
|
+
"x-ves-example": "Name",
|
|
395
995
|
},
|
|
396
996
|
{
|
|
397
997
|
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
@@ -401,6 +1001,8 @@ export const cdnTools = [
|
|
|
401
1001
|
schema: {
|
|
402
1002
|
type: "string",
|
|
403
1003
|
},
|
|
1004
|
+
"x-displayname": "Namespace",
|
|
1005
|
+
"x-ves-example": "Ns1",
|
|
404
1006
|
},
|
|
405
1007
|
],
|
|
406
1008
|
queryParameters: [],
|
|
@@ -412,6 +1014,70 @@ export const cdnTools = [
|
|
|
412
1014
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Delete",
|
|
413
1015
|
tags: ["Other"],
|
|
414
1016
|
sourceFile: "domains/cdn.json",
|
|
1017
|
+
displayName: null,
|
|
1018
|
+
dangerLevel: "high",
|
|
1019
|
+
sideEffects: {
|
|
1020
|
+
deletes: ["cdn-loadbalancer", "contained_resources"],
|
|
1021
|
+
},
|
|
1022
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1023
|
+
confirmationRequired: true,
|
|
1024
|
+
parameterExamples: {
|
|
1025
|
+
name: "Name",
|
|
1026
|
+
namespace: "Ns1",
|
|
1027
|
+
},
|
|
1028
|
+
validationRules: {},
|
|
1029
|
+
operationMetadata: {
|
|
1030
|
+
common_errors: [
|
|
1031
|
+
{
|
|
1032
|
+
code: 401,
|
|
1033
|
+
message: "Authentication required",
|
|
1034
|
+
solution: "Provide valid API credentials",
|
|
1035
|
+
},
|
|
1036
|
+
{
|
|
1037
|
+
code: 403,
|
|
1038
|
+
message: "Permission denied",
|
|
1039
|
+
solution: "Check access permissions for this operation",
|
|
1040
|
+
},
|
|
1041
|
+
{
|
|
1042
|
+
code: 404,
|
|
1043
|
+
message: "Resource not found",
|
|
1044
|
+
solution: "Verify resource name, namespace, and path",
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
code: 409,
|
|
1048
|
+
message: "Resource already exists",
|
|
1049
|
+
solution: "Use different name or update existing resource",
|
|
1050
|
+
},
|
|
1051
|
+
{
|
|
1052
|
+
code: 429,
|
|
1053
|
+
message: "Rate limit exceeded",
|
|
1054
|
+
solution: "Wait before retrying the operation",
|
|
1055
|
+
},
|
|
1056
|
+
{
|
|
1057
|
+
code: 500,
|
|
1058
|
+
message: "Server error",
|
|
1059
|
+
solution: "Retry operation or contact support",
|
|
1060
|
+
},
|
|
1061
|
+
],
|
|
1062
|
+
conditions: {
|
|
1063
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1064
|
+
prerequisites: ["Active namespace"],
|
|
1065
|
+
},
|
|
1066
|
+
confirmation_required: true,
|
|
1067
|
+
danger_level: "high",
|
|
1068
|
+
field_docs: {},
|
|
1069
|
+
optional_fields: [],
|
|
1070
|
+
performance_impact: {
|
|
1071
|
+
latency: "high",
|
|
1072
|
+
resource_usage: "moderate",
|
|
1073
|
+
},
|
|
1074
|
+
purpose: "Delete cdn-loadbalancer",
|
|
1075
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1076
|
+
side_effects: {
|
|
1077
|
+
deletes: ["cdn-loadbalancer", "contained_resources"],
|
|
1078
|
+
},
|
|
1079
|
+
},
|
|
1080
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_loadbalancers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
415
1081
|
},
|
|
416
1082
|
{
|
|
417
1083
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-get",
|
|
@@ -431,6 +1097,8 @@ export const cdnTools = [
|
|
|
431
1097
|
schema: {
|
|
432
1098
|
type: "string",
|
|
433
1099
|
},
|
|
1100
|
+
"x-displayname": "Name",
|
|
1101
|
+
"x-ves-example": "Name",
|
|
434
1102
|
},
|
|
435
1103
|
{
|
|
436
1104
|
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
@@ -440,6 +1108,8 @@ export const cdnTools = [
|
|
|
440
1108
|
schema: {
|
|
441
1109
|
type: "string",
|
|
442
1110
|
},
|
|
1111
|
+
"x-displayname": "Namespace",
|
|
1112
|
+
"x-ves-example": "Ns1",
|
|
443
1113
|
},
|
|
444
1114
|
],
|
|
445
1115
|
queryParameters: [
|
|
@@ -461,6 +1131,7 @@ export const cdnTools = [
|
|
|
461
1131
|
],
|
|
462
1132
|
type: "string",
|
|
463
1133
|
},
|
|
1134
|
+
"x-displayname": "Broken Referred Objects.",
|
|
464
1135
|
},
|
|
465
1136
|
],
|
|
466
1137
|
requestBodySchema: null,
|
|
@@ -471,6 +1142,66 @@ export const cdnTools = [
|
|
|
471
1142
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Get",
|
|
472
1143
|
tags: ["Other"],
|
|
473
1144
|
sourceFile: "domains/cdn.json",
|
|
1145
|
+
displayName: null,
|
|
1146
|
+
dangerLevel: "low",
|
|
1147
|
+
sideEffects: null,
|
|
1148
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1149
|
+
confirmationRequired: false,
|
|
1150
|
+
parameterExamples: {
|
|
1151
|
+
name: "Name",
|
|
1152
|
+
namespace: "Ns1",
|
|
1153
|
+
},
|
|
1154
|
+
validationRules: {},
|
|
1155
|
+
operationMetadata: {
|
|
1156
|
+
common_errors: [
|
|
1157
|
+
{
|
|
1158
|
+
code: 401,
|
|
1159
|
+
message: "Authentication required",
|
|
1160
|
+
solution: "Provide valid API credentials",
|
|
1161
|
+
},
|
|
1162
|
+
{
|
|
1163
|
+
code: 403,
|
|
1164
|
+
message: "Permission denied",
|
|
1165
|
+
solution: "Check access permissions for this operation",
|
|
1166
|
+
},
|
|
1167
|
+
{
|
|
1168
|
+
code: 404,
|
|
1169
|
+
message: "Resource not found",
|
|
1170
|
+
solution: "Verify resource name, namespace, and path",
|
|
1171
|
+
},
|
|
1172
|
+
{
|
|
1173
|
+
code: 409,
|
|
1174
|
+
message: "Resource already exists",
|
|
1175
|
+
solution: "Use different name or update existing resource",
|
|
1176
|
+
},
|
|
1177
|
+
{
|
|
1178
|
+
code: 429,
|
|
1179
|
+
message: "Rate limit exceeded",
|
|
1180
|
+
solution: "Wait before retrying the operation",
|
|
1181
|
+
},
|
|
1182
|
+
{
|
|
1183
|
+
code: 500,
|
|
1184
|
+
message: "Server error",
|
|
1185
|
+
solution: "Retry operation or contact support",
|
|
1186
|
+
},
|
|
1187
|
+
],
|
|
1188
|
+
conditions: {
|
|
1189
|
+
postconditions: [],
|
|
1190
|
+
prerequisites: ["Active namespace"],
|
|
1191
|
+
},
|
|
1192
|
+
confirmation_required: false,
|
|
1193
|
+
danger_level: "low",
|
|
1194
|
+
field_docs: {},
|
|
1195
|
+
optional_fields: [],
|
|
1196
|
+
performance_impact: {
|
|
1197
|
+
latency: "low",
|
|
1198
|
+
resource_usage: "low",
|
|
1199
|
+
},
|
|
1200
|
+
purpose: "Retrieve specific cdn-loadbalancer",
|
|
1201
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1202
|
+
side_effects: {},
|
|
1203
|
+
},
|
|
1204
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_loadbalancers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
474
1205
|
},
|
|
475
1206
|
{
|
|
476
1207
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-list",
|
|
@@ -490,6 +1221,8 @@ export const cdnTools = [
|
|
|
490
1221
|
schema: {
|
|
491
1222
|
type: "string",
|
|
492
1223
|
},
|
|
1224
|
+
"x-displayname": "Namespace",
|
|
1225
|
+
"x-ves-example": "Ns1",
|
|
493
1226
|
},
|
|
494
1227
|
],
|
|
495
1228
|
queryParameters: [
|
|
@@ -501,6 +1234,8 @@ export const cdnTools = [
|
|
|
501
1234
|
schema: {
|
|
502
1235
|
type: "string",
|
|
503
1236
|
},
|
|
1237
|
+
"x-displayname": "Label Filter.",
|
|
1238
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
504
1239
|
},
|
|
505
1240
|
{
|
|
506
1241
|
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
@@ -513,6 +1248,7 @@ export const cdnTools = [
|
|
|
513
1248
|
},
|
|
514
1249
|
type: "array",
|
|
515
1250
|
},
|
|
1251
|
+
"x-displayname": "Report Fields.",
|
|
516
1252
|
},
|
|
517
1253
|
{
|
|
518
1254
|
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
@@ -525,6 +1261,7 @@ export const cdnTools = [
|
|
|
525
1261
|
},
|
|
526
1262
|
type: "array",
|
|
527
1263
|
},
|
|
1264
|
+
"x-displayname": "Report Status Fields.",
|
|
528
1265
|
},
|
|
529
1266
|
],
|
|
530
1267
|
requestBodySchema: null,
|
|
@@ -535,6 +1272,66 @@ export const cdnTools = [
|
|
|
535
1272
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.List",
|
|
536
1273
|
tags: ["Other"],
|
|
537
1274
|
sourceFile: "domains/cdn.json",
|
|
1275
|
+
displayName: null,
|
|
1276
|
+
dangerLevel: "low",
|
|
1277
|
+
sideEffects: null,
|
|
1278
|
+
requiredFields: ["path.namespace"],
|
|
1279
|
+
confirmationRequired: false,
|
|
1280
|
+
parameterExamples: {
|
|
1281
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1282
|
+
namespace: "Ns1",
|
|
1283
|
+
},
|
|
1284
|
+
validationRules: {},
|
|
1285
|
+
operationMetadata: {
|
|
1286
|
+
common_errors: [
|
|
1287
|
+
{
|
|
1288
|
+
code: 401,
|
|
1289
|
+
message: "Authentication required",
|
|
1290
|
+
solution: "Provide valid API credentials",
|
|
1291
|
+
},
|
|
1292
|
+
{
|
|
1293
|
+
code: 403,
|
|
1294
|
+
message: "Permission denied",
|
|
1295
|
+
solution: "Check access permissions for this operation",
|
|
1296
|
+
},
|
|
1297
|
+
{
|
|
1298
|
+
code: 404,
|
|
1299
|
+
message: "Resource not found",
|
|
1300
|
+
solution: "Verify resource name, namespace, and path",
|
|
1301
|
+
},
|
|
1302
|
+
{
|
|
1303
|
+
code: 409,
|
|
1304
|
+
message: "Resource already exists",
|
|
1305
|
+
solution: "Use different name or update existing resource",
|
|
1306
|
+
},
|
|
1307
|
+
{
|
|
1308
|
+
code: 429,
|
|
1309
|
+
message: "Rate limit exceeded",
|
|
1310
|
+
solution: "Wait before retrying the operation",
|
|
1311
|
+
},
|
|
1312
|
+
{
|
|
1313
|
+
code: 500,
|
|
1314
|
+
message: "Server error",
|
|
1315
|
+
solution: "Retry operation or contact support",
|
|
1316
|
+
},
|
|
1317
|
+
],
|
|
1318
|
+
conditions: {
|
|
1319
|
+
postconditions: [],
|
|
1320
|
+
prerequisites: ["Active namespace"],
|
|
1321
|
+
},
|
|
1322
|
+
confirmation_required: false,
|
|
1323
|
+
danger_level: "low",
|
|
1324
|
+
field_docs: {},
|
|
1325
|
+
optional_fields: [],
|
|
1326
|
+
performance_impact: {
|
|
1327
|
+
latency: "moderate",
|
|
1328
|
+
resource_usage: "moderate",
|
|
1329
|
+
},
|
|
1330
|
+
purpose: "List all cdn-loadbalancers",
|
|
1331
|
+
required_fields: ["path.namespace"],
|
|
1332
|
+
side_effects: {},
|
|
1333
|
+
},
|
|
1334
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_loadbalancers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
538
1335
|
},
|
|
539
1336
|
{
|
|
540
1337
|
toolName: "f5xc-api-cdn-cdn-loadbalancer-update",
|
|
@@ -554,6 +1351,8 @@ export const cdnTools = [
|
|
|
554
1351
|
schema: {
|
|
555
1352
|
type: "string",
|
|
556
1353
|
},
|
|
1354
|
+
"x-displayname": "Name",
|
|
1355
|
+
"x-ves-example": "Example-corp-web.",
|
|
557
1356
|
},
|
|
558
1357
|
{
|
|
559
1358
|
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 ""',
|
|
@@ -563,6 +1362,8 @@ export const cdnTools = [
|
|
|
563
1362
|
schema: {
|
|
564
1363
|
type: "string",
|
|
565
1364
|
},
|
|
1365
|
+
"x-displayname": "Namespace",
|
|
1366
|
+
"x-ves-example": "Staging",
|
|
566
1367
|
},
|
|
567
1368
|
],
|
|
568
1369
|
queryParameters: [],
|
|
@@ -576,6 +1377,70 @@ export const cdnTools = [
|
|
|
576
1377
|
operationId: "ves.io.schema.views.cdn_loadbalancer.API.Replace",
|
|
577
1378
|
tags: ["Other"],
|
|
578
1379
|
sourceFile: "domains/cdn.json",
|
|
1380
|
+
displayName: null,
|
|
1381
|
+
dangerLevel: "medium",
|
|
1382
|
+
sideEffects: {
|
|
1383
|
+
modifies: ["cdn-loadbalancer"],
|
|
1384
|
+
},
|
|
1385
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1386
|
+
confirmationRequired: false,
|
|
1387
|
+
parameterExamples: {
|
|
1388
|
+
"metadata.name": "Example-corp-web.",
|
|
1389
|
+
"metadata.namespace": "Staging",
|
|
1390
|
+
},
|
|
1391
|
+
validationRules: {},
|
|
1392
|
+
operationMetadata: {
|
|
1393
|
+
common_errors: [
|
|
1394
|
+
{
|
|
1395
|
+
code: 401,
|
|
1396
|
+
message: "Authentication required",
|
|
1397
|
+
solution: "Provide valid API credentials",
|
|
1398
|
+
},
|
|
1399
|
+
{
|
|
1400
|
+
code: 403,
|
|
1401
|
+
message: "Permission denied",
|
|
1402
|
+
solution: "Check access permissions for this operation",
|
|
1403
|
+
},
|
|
1404
|
+
{
|
|
1405
|
+
code: 404,
|
|
1406
|
+
message: "Resource not found",
|
|
1407
|
+
solution: "Verify resource name, namespace, and path",
|
|
1408
|
+
},
|
|
1409
|
+
{
|
|
1410
|
+
code: 409,
|
|
1411
|
+
message: "Resource already exists",
|
|
1412
|
+
solution: "Use different name or update existing resource",
|
|
1413
|
+
},
|
|
1414
|
+
{
|
|
1415
|
+
code: 429,
|
|
1416
|
+
message: "Rate limit exceeded",
|
|
1417
|
+
solution: "Wait before retrying the operation",
|
|
1418
|
+
},
|
|
1419
|
+
{
|
|
1420
|
+
code: 500,
|
|
1421
|
+
message: "Server error",
|
|
1422
|
+
solution: "Retry operation or contact support",
|
|
1423
|
+
},
|
|
1424
|
+
],
|
|
1425
|
+
conditions: {
|
|
1426
|
+
postconditions: ["Resource updated with new values"],
|
|
1427
|
+
prerequisites: ["Active namespace"],
|
|
1428
|
+
},
|
|
1429
|
+
confirmation_required: false,
|
|
1430
|
+
danger_level: "medium",
|
|
1431
|
+
field_docs: {},
|
|
1432
|
+
optional_fields: [],
|
|
1433
|
+
performance_impact: {
|
|
1434
|
+
latency: "low",
|
|
1435
|
+
resource_usage: "low",
|
|
1436
|
+
},
|
|
1437
|
+
purpose: "Replace existing cdn-loadbalancer",
|
|
1438
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1439
|
+
side_effects: {
|
|
1440
|
+
modifies: ["cdn-loadbalancer"],
|
|
1441
|
+
},
|
|
1442
|
+
},
|
|
1443
|
+
curlExample: 'curl -X POST "$F5XC_API_URL/api/config/namespaces/default/cdn_loadbalancers" \\\n -H "Authorization: APIToken $F5XC_API_TOKEN" \\\n -H "Content-Type: application/json" \\\n -d @example.json',
|
|
579
1444
|
},
|
|
580
1445
|
{
|
|
581
1446
|
toolName: "f5xc-api-cdn-dos-automitigation-rule-delete",
|
|
@@ -595,6 +1460,8 @@ export const cdnTools = [
|
|
|
595
1460
|
schema: {
|
|
596
1461
|
type: "string",
|
|
597
1462
|
},
|
|
1463
|
+
"x-displayname": "DoS Mitigation Rule Name.",
|
|
1464
|
+
"x-ves-example": "Dos-auto-mitigation-VES-I/O-HTTP-loadbalancer-ce22.",
|
|
598
1465
|
},
|
|
599
1466
|
{
|
|
600
1467
|
description: "Name\nName of the Load Balancer.",
|
|
@@ -604,6 +1471,8 @@ export const cdnTools = [
|
|
|
604
1471
|
schema: {
|
|
605
1472
|
type: "string",
|
|
606
1473
|
},
|
|
1474
|
+
"x-displayname": "Name",
|
|
1475
|
+
"x-ves-example": "Blogging-app.",
|
|
607
1476
|
},
|
|
608
1477
|
{
|
|
609
1478
|
description: "Namespace\nNamespace of the Load Balancer.",
|
|
@@ -613,6 +1482,8 @@ export const cdnTools = [
|
|
|
613
1482
|
schema: {
|
|
614
1483
|
type: "string",
|
|
615
1484
|
},
|
|
1485
|
+
"x-displayname": "Namespace",
|
|
1486
|
+
"x-ves-example": "Shared",
|
|
616
1487
|
},
|
|
617
1488
|
],
|
|
618
1489
|
queryParameters: [],
|
|
@@ -624,6 +1495,71 @@ export const cdnTools = [
|
|
|
624
1495
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomCDNWAAPAPI.DeleteCDNDoSAutoMitigationRule",
|
|
625
1496
|
tags: ["Other"],
|
|
626
1497
|
sourceFile: "domains/cdn.json",
|
|
1498
|
+
displayName: null,
|
|
1499
|
+
dangerLevel: "high",
|
|
1500
|
+
sideEffects: {
|
|
1501
|
+
deletes: ["dos-automitigation-rule", "contained_resources"],
|
|
1502
|
+
},
|
|
1503
|
+
requiredFields: ["path.dos_automitigation_rule_name", "path.name", "path.namespace"],
|
|
1504
|
+
confirmationRequired: true,
|
|
1505
|
+
parameterExamples: {
|
|
1506
|
+
dos_automitigation_rule_name: "Dos-auto-mitigation-VES-I/O-HTTP-loadbalancer-ce22.",
|
|
1507
|
+
name: "Blogging-app.",
|
|
1508
|
+
namespace: "Shared",
|
|
1509
|
+
},
|
|
1510
|
+
validationRules: {},
|
|
1511
|
+
operationMetadata: {
|
|
1512
|
+
common_errors: [
|
|
1513
|
+
{
|
|
1514
|
+
code: 401,
|
|
1515
|
+
message: "Authentication required",
|
|
1516
|
+
solution: "Provide valid API credentials",
|
|
1517
|
+
},
|
|
1518
|
+
{
|
|
1519
|
+
code: 403,
|
|
1520
|
+
message: "Permission denied",
|
|
1521
|
+
solution: "Check access permissions for this operation",
|
|
1522
|
+
},
|
|
1523
|
+
{
|
|
1524
|
+
code: 404,
|
|
1525
|
+
message: "Resource not found",
|
|
1526
|
+
solution: "Verify resource name, namespace, and path",
|
|
1527
|
+
},
|
|
1528
|
+
{
|
|
1529
|
+
code: 409,
|
|
1530
|
+
message: "Resource already exists",
|
|
1531
|
+
solution: "Use different name or update existing resource",
|
|
1532
|
+
},
|
|
1533
|
+
{
|
|
1534
|
+
code: 429,
|
|
1535
|
+
message: "Rate limit exceeded",
|
|
1536
|
+
solution: "Wait before retrying the operation",
|
|
1537
|
+
},
|
|
1538
|
+
{
|
|
1539
|
+
code: 500,
|
|
1540
|
+
message: "Server error",
|
|
1541
|
+
solution: "Retry operation or contact support",
|
|
1542
|
+
},
|
|
1543
|
+
],
|
|
1544
|
+
conditions: {
|
|
1545
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1546
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1547
|
+
},
|
|
1548
|
+
confirmation_required: true,
|
|
1549
|
+
danger_level: "high",
|
|
1550
|
+
field_docs: {},
|
|
1551
|
+
optional_fields: [],
|
|
1552
|
+
performance_impact: {
|
|
1553
|
+
latency: "high",
|
|
1554
|
+
resource_usage: "moderate",
|
|
1555
|
+
},
|
|
1556
|
+
purpose: "Delete dos-automitigation-rule",
|
|
1557
|
+
required_fields: ["path.dos_automitigation_rule_name", "path.name", "path.namespace"],
|
|
1558
|
+
side_effects: {
|
|
1559
|
+
deletes: ["dos-automitigation-rule", "contained_resources"],
|
|
1560
|
+
},
|
|
1561
|
+
},
|
|
1562
|
+
curlExample: null,
|
|
627
1563
|
},
|
|
628
1564
|
{
|
|
629
1565
|
toolName: "f5xc-api-cdn-dos-automitigation-rule-get",
|
|
@@ -643,6 +1579,8 @@ export const cdnTools = [
|
|
|
643
1579
|
schema: {
|
|
644
1580
|
type: "string",
|
|
645
1581
|
},
|
|
1582
|
+
"x-displayname": "Name",
|
|
1583
|
+
"x-ves-example": "Blogging-app.",
|
|
646
1584
|
},
|
|
647
1585
|
{
|
|
648
1586
|
description: "Namespace\nNamespace of the Load Balancer.",
|
|
@@ -652,6 +1590,8 @@ export const cdnTools = [
|
|
|
652
1590
|
schema: {
|
|
653
1591
|
type: "string",
|
|
654
1592
|
},
|
|
1593
|
+
"x-displayname": "Namespace",
|
|
1594
|
+
"x-ves-example": "Shared",
|
|
655
1595
|
},
|
|
656
1596
|
],
|
|
657
1597
|
queryParameters: [],
|
|
@@ -663,6 +1603,66 @@ export const cdnTools = [
|
|
|
663
1603
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomCDNWAAPAPI.GetCDNDoSAutoMitigationRules",
|
|
664
1604
|
tags: ["Other"],
|
|
665
1605
|
sourceFile: "domains/cdn.json",
|
|
1606
|
+
displayName: null,
|
|
1607
|
+
dangerLevel: "low",
|
|
1608
|
+
sideEffects: null,
|
|
1609
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1610
|
+
confirmationRequired: false,
|
|
1611
|
+
parameterExamples: {
|
|
1612
|
+
name: "Blogging-app.",
|
|
1613
|
+
namespace: "Shared",
|
|
1614
|
+
},
|
|
1615
|
+
validationRules: {},
|
|
1616
|
+
operationMetadata: {
|
|
1617
|
+
common_errors: [
|
|
1618
|
+
{
|
|
1619
|
+
code: 401,
|
|
1620
|
+
message: "Authentication required",
|
|
1621
|
+
solution: "Provide valid API credentials",
|
|
1622
|
+
},
|
|
1623
|
+
{
|
|
1624
|
+
code: 403,
|
|
1625
|
+
message: "Permission denied",
|
|
1626
|
+
solution: "Check access permissions for this operation",
|
|
1627
|
+
},
|
|
1628
|
+
{
|
|
1629
|
+
code: 404,
|
|
1630
|
+
message: "Resource not found",
|
|
1631
|
+
solution: "Verify resource name, namespace, and path",
|
|
1632
|
+
},
|
|
1633
|
+
{
|
|
1634
|
+
code: 409,
|
|
1635
|
+
message: "Resource already exists",
|
|
1636
|
+
solution: "Use different name or update existing resource",
|
|
1637
|
+
},
|
|
1638
|
+
{
|
|
1639
|
+
code: 429,
|
|
1640
|
+
message: "Rate limit exceeded",
|
|
1641
|
+
solution: "Wait before retrying the operation",
|
|
1642
|
+
},
|
|
1643
|
+
{
|
|
1644
|
+
code: 500,
|
|
1645
|
+
message: "Server error",
|
|
1646
|
+
solution: "Retry operation or contact support",
|
|
1647
|
+
},
|
|
1648
|
+
],
|
|
1649
|
+
conditions: {
|
|
1650
|
+
postconditions: [],
|
|
1651
|
+
prerequisites: ["Active namespace", "Policy parameters defined"],
|
|
1652
|
+
},
|
|
1653
|
+
confirmation_required: false,
|
|
1654
|
+
danger_level: "low",
|
|
1655
|
+
field_docs: {},
|
|
1656
|
+
optional_fields: [],
|
|
1657
|
+
performance_impact: {
|
|
1658
|
+
latency: "moderate",
|
|
1659
|
+
resource_usage: "moderate",
|
|
1660
|
+
},
|
|
1661
|
+
purpose: "Retrieve specific dos-automitigation-rule",
|
|
1662
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1663
|
+
side_effects: {},
|
|
1664
|
+
},
|
|
1665
|
+
curlExample: null,
|
|
666
1666
|
},
|
|
667
1667
|
{
|
|
668
1668
|
toolName: "f5xc-api-cdn-get-security-config-create",
|
|
@@ -682,6 +1682,8 @@ export const cdnTools = [
|
|
|
682
1682
|
schema: {
|
|
683
1683
|
type: "string",
|
|
684
1684
|
},
|
|
1685
|
+
"x-displayname": "Namespace",
|
|
1686
|
+
"x-ves-example": "Shared",
|
|
685
1687
|
},
|
|
686
1688
|
],
|
|
687
1689
|
queryParameters: [],
|
|
@@ -695,6 +1697,72 @@ export const cdnTools = [
|
|
|
695
1697
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomCDNWAAPAPI.GetCDNSecurityConfig",
|
|
696
1698
|
tags: ["Other"],
|
|
697
1699
|
sourceFile: "domains/cdn.json",
|
|
1700
|
+
displayName: null,
|
|
1701
|
+
dangerLevel: "medium",
|
|
1702
|
+
sideEffects: {
|
|
1703
|
+
creates: ["get-security-config"],
|
|
1704
|
+
},
|
|
1705
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1706
|
+
confirmationRequired: false,
|
|
1707
|
+
parameterExamples: {
|
|
1708
|
+
namespace: "Shared",
|
|
1709
|
+
},
|
|
1710
|
+
validationRules: {},
|
|
1711
|
+
operationMetadata: {
|
|
1712
|
+
common_errors: [
|
|
1713
|
+
{
|
|
1714
|
+
code: 401,
|
|
1715
|
+
message: "Authentication required",
|
|
1716
|
+
solution: "Provide valid API credentials",
|
|
1717
|
+
},
|
|
1718
|
+
{
|
|
1719
|
+
code: 403,
|
|
1720
|
+
message: "Permission denied",
|
|
1721
|
+
solution: "Check access permissions for this operation",
|
|
1722
|
+
},
|
|
1723
|
+
{
|
|
1724
|
+
code: 404,
|
|
1725
|
+
message: "Resource not found",
|
|
1726
|
+
solution: "Verify resource name, namespace, and path",
|
|
1727
|
+
},
|
|
1728
|
+
{
|
|
1729
|
+
code: 409,
|
|
1730
|
+
message: "Resource already exists",
|
|
1731
|
+
solution: "Use different name or update existing resource",
|
|
1732
|
+
},
|
|
1733
|
+
{
|
|
1734
|
+
code: 429,
|
|
1735
|
+
message: "Rate limit exceeded",
|
|
1736
|
+
solution: "Wait before retrying the operation",
|
|
1737
|
+
},
|
|
1738
|
+
{
|
|
1739
|
+
code: 500,
|
|
1740
|
+
message: "Server error",
|
|
1741
|
+
solution: "Retry operation or contact support",
|
|
1742
|
+
},
|
|
1743
|
+
],
|
|
1744
|
+
conditions: {
|
|
1745
|
+
postconditions: [
|
|
1746
|
+
"Get-security-config resource created",
|
|
1747
|
+
"Resource assigned unique identifier",
|
|
1748
|
+
],
|
|
1749
|
+
prerequisites: ["Active namespace"],
|
|
1750
|
+
},
|
|
1751
|
+
confirmation_required: false,
|
|
1752
|
+
danger_level: "medium",
|
|
1753
|
+
field_docs: {},
|
|
1754
|
+
optional_fields: [],
|
|
1755
|
+
performance_impact: {
|
|
1756
|
+
latency: "low",
|
|
1757
|
+
resource_usage: "low",
|
|
1758
|
+
},
|
|
1759
|
+
purpose: "Create new get-security-config",
|
|
1760
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1761
|
+
side_effects: {
|
|
1762
|
+
creates: ["get-security-config"],
|
|
1763
|
+
},
|
|
1764
|
+
},
|
|
1765
|
+
curlExample: null,
|
|
698
1766
|
},
|
|
699
1767
|
{
|
|
700
1768
|
toolName: "f5xc-api-cdn-get-service-operation-statu-create",
|
|
@@ -714,6 +1782,8 @@ export const cdnTools = [
|
|
|
714
1782
|
schema: {
|
|
715
1783
|
type: "string",
|
|
716
1784
|
},
|
|
1785
|
+
"x-displayname": "Namespace",
|
|
1786
|
+
"x-ves-example": "Default",
|
|
717
1787
|
},
|
|
718
1788
|
],
|
|
719
1789
|
queryParameters: [],
|
|
@@ -727,6 +1797,72 @@ export const cdnTools = [
|
|
|
727
1797
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.GetServiceOperation",
|
|
728
1798
|
tags: ["CDN"],
|
|
729
1799
|
sourceFile: "domains/cdn.json",
|
|
1800
|
+
displayName: null,
|
|
1801
|
+
dangerLevel: "medium",
|
|
1802
|
+
sideEffects: {
|
|
1803
|
+
creates: ["get-service-operation-statu"],
|
|
1804
|
+
},
|
|
1805
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1806
|
+
confirmationRequired: false,
|
|
1807
|
+
parameterExamples: {
|
|
1808
|
+
namespace: "Default",
|
|
1809
|
+
},
|
|
1810
|
+
validationRules: {},
|
|
1811
|
+
operationMetadata: {
|
|
1812
|
+
common_errors: [
|
|
1813
|
+
{
|
|
1814
|
+
code: 401,
|
|
1815
|
+
message: "Authentication required",
|
|
1816
|
+
solution: "Provide valid API credentials",
|
|
1817
|
+
},
|
|
1818
|
+
{
|
|
1819
|
+
code: 403,
|
|
1820
|
+
message: "Permission denied",
|
|
1821
|
+
solution: "Check access permissions for this operation",
|
|
1822
|
+
},
|
|
1823
|
+
{
|
|
1824
|
+
code: 404,
|
|
1825
|
+
message: "Resource not found",
|
|
1826
|
+
solution: "Verify resource name, namespace, and path",
|
|
1827
|
+
},
|
|
1828
|
+
{
|
|
1829
|
+
code: 409,
|
|
1830
|
+
message: "Resource already exists",
|
|
1831
|
+
solution: "Use different name or update existing resource",
|
|
1832
|
+
},
|
|
1833
|
+
{
|
|
1834
|
+
code: 429,
|
|
1835
|
+
message: "Rate limit exceeded",
|
|
1836
|
+
solution: "Wait before retrying the operation",
|
|
1837
|
+
},
|
|
1838
|
+
{
|
|
1839
|
+
code: 500,
|
|
1840
|
+
message: "Server error",
|
|
1841
|
+
solution: "Retry operation or contact support",
|
|
1842
|
+
},
|
|
1843
|
+
],
|
|
1844
|
+
conditions: {
|
|
1845
|
+
postconditions: [
|
|
1846
|
+
"Get-service-operation-statu resource created",
|
|
1847
|
+
"Resource assigned unique identifier",
|
|
1848
|
+
],
|
|
1849
|
+
prerequisites: ["Active namespace"],
|
|
1850
|
+
},
|
|
1851
|
+
confirmation_required: false,
|
|
1852
|
+
danger_level: "medium",
|
|
1853
|
+
field_docs: {},
|
|
1854
|
+
optional_fields: [],
|
|
1855
|
+
performance_impact: {
|
|
1856
|
+
latency: "low",
|
|
1857
|
+
resource_usage: "low",
|
|
1858
|
+
},
|
|
1859
|
+
purpose: "Create new get-service-operation-statu",
|
|
1860
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1861
|
+
side_effects: {
|
|
1862
|
+
creates: ["get-service-operation-statu"],
|
|
1863
|
+
},
|
|
1864
|
+
},
|
|
1865
|
+
curlExample: null,
|
|
730
1866
|
},
|
|
731
1867
|
{
|
|
732
1868
|
toolName: "f5xc-api-cdn-list-service-operations-statu-create",
|
|
@@ -746,6 +1882,8 @@ export const cdnTools = [
|
|
|
746
1882
|
schema: {
|
|
747
1883
|
type: "string",
|
|
748
1884
|
},
|
|
1885
|
+
"x-displayname": "Namespace",
|
|
1886
|
+
"x-ves-example": "Ns1",
|
|
749
1887
|
},
|
|
750
1888
|
],
|
|
751
1889
|
queryParameters: [],
|
|
@@ -759,6 +1897,72 @@ export const cdnTools = [
|
|
|
759
1897
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.ListServiceOperations",
|
|
760
1898
|
tags: ["CDN"],
|
|
761
1899
|
sourceFile: "domains/cdn.json",
|
|
1900
|
+
displayName: null,
|
|
1901
|
+
dangerLevel: "medium",
|
|
1902
|
+
sideEffects: {
|
|
1903
|
+
creates: ["list-service-operations-statu"],
|
|
1904
|
+
},
|
|
1905
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1906
|
+
confirmationRequired: false,
|
|
1907
|
+
parameterExamples: {
|
|
1908
|
+
namespace: "Ns1",
|
|
1909
|
+
},
|
|
1910
|
+
validationRules: {},
|
|
1911
|
+
operationMetadata: {
|
|
1912
|
+
common_errors: [
|
|
1913
|
+
{
|
|
1914
|
+
code: 401,
|
|
1915
|
+
message: "Authentication required",
|
|
1916
|
+
solution: "Provide valid API credentials",
|
|
1917
|
+
},
|
|
1918
|
+
{
|
|
1919
|
+
code: 403,
|
|
1920
|
+
message: "Permission denied",
|
|
1921
|
+
solution: "Check access permissions for this operation",
|
|
1922
|
+
},
|
|
1923
|
+
{
|
|
1924
|
+
code: 404,
|
|
1925
|
+
message: "Resource not found",
|
|
1926
|
+
solution: "Verify resource name, namespace, and path",
|
|
1927
|
+
},
|
|
1928
|
+
{
|
|
1929
|
+
code: 409,
|
|
1930
|
+
message: "Resource already exists",
|
|
1931
|
+
solution: "Use different name or update existing resource",
|
|
1932
|
+
},
|
|
1933
|
+
{
|
|
1934
|
+
code: 429,
|
|
1935
|
+
message: "Rate limit exceeded",
|
|
1936
|
+
solution: "Wait before retrying the operation",
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
code: 500,
|
|
1940
|
+
message: "Server error",
|
|
1941
|
+
solution: "Retry operation or contact support",
|
|
1942
|
+
},
|
|
1943
|
+
],
|
|
1944
|
+
conditions: {
|
|
1945
|
+
postconditions: [
|
|
1946
|
+
"List-service-operations-statu resource created",
|
|
1947
|
+
"Resource assigned unique identifier",
|
|
1948
|
+
],
|
|
1949
|
+
prerequisites: ["Active namespace"],
|
|
1950
|
+
},
|
|
1951
|
+
confirmation_required: false,
|
|
1952
|
+
danger_level: "medium",
|
|
1953
|
+
field_docs: {},
|
|
1954
|
+
optional_fields: [],
|
|
1955
|
+
performance_impact: {
|
|
1956
|
+
latency: "low",
|
|
1957
|
+
resource_usage: "low",
|
|
1958
|
+
},
|
|
1959
|
+
purpose: "Create new list-service-operations-statu",
|
|
1960
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
1961
|
+
side_effects: {
|
|
1962
|
+
creates: ["list-service-operations-statu"],
|
|
1963
|
+
},
|
|
1964
|
+
},
|
|
1965
|
+
curlExample: null,
|
|
762
1966
|
},
|
|
763
1967
|
{
|
|
764
1968
|
toolName: "f5xc-api-cdn-metric-create",
|
|
@@ -778,6 +1982,8 @@ export const cdnTools = [
|
|
|
778
1982
|
schema: {
|
|
779
1983
|
type: "string",
|
|
780
1984
|
},
|
|
1985
|
+
"x-displayname": "Namespace",
|
|
1986
|
+
"x-ves-example": "Default",
|
|
781
1987
|
},
|
|
782
1988
|
],
|
|
783
1989
|
queryParameters: [],
|
|
@@ -791,6 +1997,69 @@ export const cdnTools = [
|
|
|
791
1997
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.CDNMetrics",
|
|
792
1998
|
tags: ["CDN"],
|
|
793
1999
|
sourceFile: "domains/cdn.json",
|
|
2000
|
+
displayName: null,
|
|
2001
|
+
dangerLevel: "medium",
|
|
2002
|
+
sideEffects: {
|
|
2003
|
+
creates: ["metric"],
|
|
2004
|
+
},
|
|
2005
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2006
|
+
confirmationRequired: false,
|
|
2007
|
+
parameterExamples: {
|
|
2008
|
+
namespace: "Default",
|
|
2009
|
+
},
|
|
2010
|
+
validationRules: {},
|
|
2011
|
+
operationMetadata: {
|
|
2012
|
+
common_errors: [
|
|
2013
|
+
{
|
|
2014
|
+
code: 401,
|
|
2015
|
+
message: "Authentication required",
|
|
2016
|
+
solution: "Provide valid API credentials",
|
|
2017
|
+
},
|
|
2018
|
+
{
|
|
2019
|
+
code: 403,
|
|
2020
|
+
message: "Permission denied",
|
|
2021
|
+
solution: "Check access permissions for this operation",
|
|
2022
|
+
},
|
|
2023
|
+
{
|
|
2024
|
+
code: 404,
|
|
2025
|
+
message: "Resource not found",
|
|
2026
|
+
solution: "Verify resource name, namespace, and path",
|
|
2027
|
+
},
|
|
2028
|
+
{
|
|
2029
|
+
code: 409,
|
|
2030
|
+
message: "Resource already exists",
|
|
2031
|
+
solution: "Use different name or update existing resource",
|
|
2032
|
+
},
|
|
2033
|
+
{
|
|
2034
|
+
code: 429,
|
|
2035
|
+
message: "Rate limit exceeded",
|
|
2036
|
+
solution: "Wait before retrying the operation",
|
|
2037
|
+
},
|
|
2038
|
+
{
|
|
2039
|
+
code: 500,
|
|
2040
|
+
message: "Server error",
|
|
2041
|
+
solution: "Retry operation or contact support",
|
|
2042
|
+
},
|
|
2043
|
+
],
|
|
2044
|
+
conditions: {
|
|
2045
|
+
postconditions: ["Metric resource created", "Resource assigned unique identifier"],
|
|
2046
|
+
prerequisites: ["Active namespace"],
|
|
2047
|
+
},
|
|
2048
|
+
confirmation_required: false,
|
|
2049
|
+
danger_level: "medium",
|
|
2050
|
+
field_docs: {},
|
|
2051
|
+
optional_fields: [],
|
|
2052
|
+
performance_impact: {
|
|
2053
|
+
latency: "low",
|
|
2054
|
+
resource_usage: "low",
|
|
2055
|
+
},
|
|
2056
|
+
purpose: "Create new metric",
|
|
2057
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2058
|
+
side_effects: {
|
|
2059
|
+
creates: ["metric"],
|
|
2060
|
+
},
|
|
2061
|
+
},
|
|
2062
|
+
curlExample: null,
|
|
794
2063
|
},
|
|
795
2064
|
{
|
|
796
2065
|
toolName: "f5xc-api-cdn-subscribe-create",
|
|
@@ -813,6 +2082,174 @@ export const cdnTools = [
|
|
|
813
2082
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.Subscribe",
|
|
814
2083
|
tags: ["Other"],
|
|
815
2084
|
sourceFile: "domains/cdn.json",
|
|
2085
|
+
displayName: null,
|
|
2086
|
+
dangerLevel: "medium",
|
|
2087
|
+
sideEffects: {
|
|
2088
|
+
creates: ["subscribe"],
|
|
2089
|
+
},
|
|
2090
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2091
|
+
confirmationRequired: false,
|
|
2092
|
+
parameterExamples: {},
|
|
2093
|
+
validationRules: {},
|
|
2094
|
+
operationMetadata: {
|
|
2095
|
+
common_errors: [
|
|
2096
|
+
{
|
|
2097
|
+
code: 401,
|
|
2098
|
+
message: "Authentication required",
|
|
2099
|
+
solution: "Provide valid API credentials",
|
|
2100
|
+
},
|
|
2101
|
+
{
|
|
2102
|
+
code: 403,
|
|
2103
|
+
message: "Permission denied",
|
|
2104
|
+
solution: "Check access permissions for this operation",
|
|
2105
|
+
},
|
|
2106
|
+
{
|
|
2107
|
+
code: 404,
|
|
2108
|
+
message: "Resource not found",
|
|
2109
|
+
solution: "Verify resource name, namespace, and path",
|
|
2110
|
+
},
|
|
2111
|
+
{
|
|
2112
|
+
code: 409,
|
|
2113
|
+
message: "Resource already exists",
|
|
2114
|
+
solution: "Use different name or update existing resource",
|
|
2115
|
+
},
|
|
2116
|
+
{
|
|
2117
|
+
code: 429,
|
|
2118
|
+
message: "Rate limit exceeded",
|
|
2119
|
+
solution: "Wait before retrying the operation",
|
|
2120
|
+
},
|
|
2121
|
+
{
|
|
2122
|
+
code: 500,
|
|
2123
|
+
message: "Server error",
|
|
2124
|
+
solution: "Retry operation or contact support",
|
|
2125
|
+
},
|
|
2126
|
+
],
|
|
2127
|
+
conditions: {
|
|
2128
|
+
postconditions: ["Subscribe resource created", "Resource assigned unique identifier"],
|
|
2129
|
+
prerequisites: ["Active namespace"],
|
|
2130
|
+
},
|
|
2131
|
+
confirmation_required: false,
|
|
2132
|
+
danger_level: "medium",
|
|
2133
|
+
field_docs: {},
|
|
2134
|
+
optional_fields: [],
|
|
2135
|
+
performance_impact: {
|
|
2136
|
+
latency: "low",
|
|
2137
|
+
resource_usage: "low",
|
|
2138
|
+
},
|
|
2139
|
+
purpose: "Create new subscribe",
|
|
2140
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2141
|
+
side_effects: {
|
|
2142
|
+
creates: ["subscribe"],
|
|
2143
|
+
},
|
|
2144
|
+
},
|
|
2145
|
+
curlExample: null,
|
|
2146
|
+
},
|
|
2147
|
+
{
|
|
2148
|
+
toolName: "f5xc-api-cdn-suggestion-create",
|
|
2149
|
+
method: "POST",
|
|
2150
|
+
path: "/api/config/namespaces/{namespace}/cdn_loadbalancers/{name}/block_client/suggestion",
|
|
2151
|
+
operation: "create",
|
|
2152
|
+
domain: "cdn",
|
|
2153
|
+
resource: "suggestion",
|
|
2154
|
+
summary: "Suggest block client rule.",
|
|
2155
|
+
description: "Suggest blocking SimpleClientSrcRule for a given IP/ASN.",
|
|
2156
|
+
pathParameters: [
|
|
2157
|
+
{
|
|
2158
|
+
description: "Name\nHTTP load balancer for which this WAF exclusion will be applied.",
|
|
2159
|
+
in: "path",
|
|
2160
|
+
name: "name",
|
|
2161
|
+
required: true,
|
|
2162
|
+
schema: {
|
|
2163
|
+
type: "string",
|
|
2164
|
+
},
|
|
2165
|
+
"x-displayname": "HTTP Load Balancer Name.",
|
|
2166
|
+
"x-ves-example": "VES-I/O-frontend.",
|
|
2167
|
+
},
|
|
2168
|
+
{
|
|
2169
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
2170
|
+
in: "path",
|
|
2171
|
+
name: "namespace",
|
|
2172
|
+
required: true,
|
|
2173
|
+
schema: {
|
|
2174
|
+
type: "string",
|
|
2175
|
+
},
|
|
2176
|
+
"x-displayname": "Namespace",
|
|
2177
|
+
"x-ves-example": "Shared",
|
|
2178
|
+
},
|
|
2179
|
+
],
|
|
2180
|
+
queryParameters: [],
|
|
2181
|
+
requestBodySchema: null,
|
|
2182
|
+
responseSchema: {
|
|
2183
|
+
$ref: "#/components/schemas/app_securityGetSuggestedBlockClientRuleRsp",
|
|
2184
|
+
},
|
|
2185
|
+
requiredParams: ["name", "namespace"],
|
|
2186
|
+
operationId: "ves.io.schema.app_security.AppSecurityClientRuleAPI.GetSuggestedBlockClientRuleForCDN",
|
|
2187
|
+
tags: ["Other"],
|
|
2188
|
+
sourceFile: "domains/cdn.json",
|
|
2189
|
+
displayName: null,
|
|
2190
|
+
dangerLevel: "medium",
|
|
2191
|
+
sideEffects: {
|
|
2192
|
+
creates: ["suggestion"],
|
|
2193
|
+
},
|
|
2194
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
2195
|
+
confirmationRequired: false,
|
|
2196
|
+
parameterExamples: {
|
|
2197
|
+
name: "VES-I/O-frontend.",
|
|
2198
|
+
namespace: "Shared",
|
|
2199
|
+
},
|
|
2200
|
+
validationRules: {},
|
|
2201
|
+
operationMetadata: {
|
|
2202
|
+
common_errors: [
|
|
2203
|
+
{
|
|
2204
|
+
code: 401,
|
|
2205
|
+
message: "Authentication required",
|
|
2206
|
+
solution: "Provide valid API credentials",
|
|
2207
|
+
},
|
|
2208
|
+
{
|
|
2209
|
+
code: 403,
|
|
2210
|
+
message: "Permission denied",
|
|
2211
|
+
solution: "Check access permissions for this operation",
|
|
2212
|
+
},
|
|
2213
|
+
{
|
|
2214
|
+
code: 404,
|
|
2215
|
+
message: "Resource not found",
|
|
2216
|
+
solution: "Verify resource name, namespace, and path",
|
|
2217
|
+
},
|
|
2218
|
+
{
|
|
2219
|
+
code: 409,
|
|
2220
|
+
message: "Resource already exists",
|
|
2221
|
+
solution: "Use different name or update existing resource",
|
|
2222
|
+
},
|
|
2223
|
+
{
|
|
2224
|
+
code: 429,
|
|
2225
|
+
message: "Rate limit exceeded",
|
|
2226
|
+
solution: "Wait before retrying the operation",
|
|
2227
|
+
},
|
|
2228
|
+
{
|
|
2229
|
+
code: 500,
|
|
2230
|
+
message: "Server error",
|
|
2231
|
+
solution: "Retry operation or contact support",
|
|
2232
|
+
},
|
|
2233
|
+
],
|
|
2234
|
+
conditions: {
|
|
2235
|
+
postconditions: ["Suggestion resource created", "Resource assigned unique identifier"],
|
|
2236
|
+
prerequisites: ["Active namespace"],
|
|
2237
|
+
},
|
|
2238
|
+
confirmation_required: false,
|
|
2239
|
+
danger_level: "medium",
|
|
2240
|
+
field_docs: {},
|
|
2241
|
+
optional_fields: [],
|
|
2242
|
+
performance_impact: {
|
|
2243
|
+
latency: "low",
|
|
2244
|
+
resource_usage: "low",
|
|
2245
|
+
},
|
|
2246
|
+
purpose: "Create new suggestion",
|
|
2247
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
|
|
2248
|
+
side_effects: {
|
|
2249
|
+
creates: ["suggestion"],
|
|
2250
|
+
},
|
|
2251
|
+
},
|
|
2252
|
+
curlExample: null,
|
|
816
2253
|
},
|
|
817
2254
|
{
|
|
818
2255
|
toolName: "f5xc-api-cdn-unsubscribe-create",
|
|
@@ -835,6 +2272,67 @@ export const cdnTools = [
|
|
|
835
2272
|
operationId: "ves.io.schema.views.cdn_loadbalancer.CustomAPI.Unsubscribe",
|
|
836
2273
|
tags: ["Other"],
|
|
837
2274
|
sourceFile: "domains/cdn.json",
|
|
2275
|
+
displayName: null,
|
|
2276
|
+
dangerLevel: "medium",
|
|
2277
|
+
sideEffects: {
|
|
2278
|
+
creates: ["unsubscribe"],
|
|
2279
|
+
},
|
|
2280
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
2281
|
+
confirmationRequired: false,
|
|
2282
|
+
parameterExamples: {},
|
|
2283
|
+
validationRules: {},
|
|
2284
|
+
operationMetadata: {
|
|
2285
|
+
common_errors: [
|
|
2286
|
+
{
|
|
2287
|
+
code: 401,
|
|
2288
|
+
message: "Authentication required",
|
|
2289
|
+
solution: "Provide valid API credentials",
|
|
2290
|
+
},
|
|
2291
|
+
{
|
|
2292
|
+
code: 403,
|
|
2293
|
+
message: "Permission denied",
|
|
2294
|
+
solution: "Check access permissions for this operation",
|
|
2295
|
+
},
|
|
2296
|
+
{
|
|
2297
|
+
code: 404,
|
|
2298
|
+
message: "Resource not found",
|
|
2299
|
+
solution: "Verify resource name, namespace, and path",
|
|
2300
|
+
},
|
|
2301
|
+
{
|
|
2302
|
+
code: 409,
|
|
2303
|
+
message: "Resource already exists",
|
|
2304
|
+
solution: "Use different name or update existing resource",
|
|
2305
|
+
},
|
|
2306
|
+
{
|
|
2307
|
+
code: 429,
|
|
2308
|
+
message: "Rate limit exceeded",
|
|
2309
|
+
solution: "Wait before retrying the operation",
|
|
2310
|
+
},
|
|
2311
|
+
{
|
|
2312
|
+
code: 500,
|
|
2313
|
+
message: "Server error",
|
|
2314
|
+
solution: "Retry operation or contact support",
|
|
2315
|
+
},
|
|
2316
|
+
],
|
|
2317
|
+
conditions: {
|
|
2318
|
+
postconditions: ["Unsubscribe resource created", "Resource assigned unique identifier"],
|
|
2319
|
+
prerequisites: ["Active namespace"],
|
|
2320
|
+
},
|
|
2321
|
+
confirmation_required: false,
|
|
2322
|
+
danger_level: "medium",
|
|
2323
|
+
field_docs: {},
|
|
2324
|
+
optional_fields: [],
|
|
2325
|
+
performance_impact: {
|
|
2326
|
+
latency: "low",
|
|
2327
|
+
resource_usage: "low",
|
|
2328
|
+
},
|
|
2329
|
+
purpose: "Create new unsubscribe",
|
|
2330
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
2331
|
+
side_effects: {
|
|
2332
|
+
creates: ["unsubscribe"],
|
|
2333
|
+
},
|
|
2334
|
+
},
|
|
2335
|
+
curlExample: null,
|
|
838
2336
|
},
|
|
839
2337
|
];
|
|
840
2338
|
export default cdnTools;
|