@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.
- package/dist/generator/openapi-parser.d.ts +418 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -1
- package/dist/generator/openapi-parser.js +132 -0
- package/dist/generator/openapi-parser.js.map +1 -1
- package/dist/generator/tool-generator.d.ts +29 -1
- package/dist/generator/tool-generator.d.ts.map +1 -1
- package/dist/generator/tool-generator.js +150 -7
- package/dist/generator/tool-generator.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/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 +285 -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 +6668 -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 +1005 -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 +2045 -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 +2702 -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 +3998 -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 +2584 -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 +1904 -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 +3963 -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 +2579 -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 +4124 -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 +2054 -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 +1708 -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 +1770 -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 +8511 -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 +6460 -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 +1215 -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 +3233 -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 +4580 -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 +12616 -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 +8884 -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 +1820 -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 +1055 -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 +4243 -4618
- 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 +1937 -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 +653 -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 +4532 -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 +21784 -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 +13252 -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 +8837 -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 +6215 -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 +2773 -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 +20456 -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 +112 -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 +1572 -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 +11540 -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 +98 -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 +4440 -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/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
|
@@ -0,0 +1,4580 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for marketplace domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const marketplaceTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-marketplace-activation-statu-list",
|
|
8
|
+
method: "GET",
|
|
9
|
+
path: "/api/web/namespaces/system/addon_services/{addon_service}/activation-status",
|
|
10
|
+
operation: "list",
|
|
11
|
+
domain: "marketplace",
|
|
12
|
+
resource: "activation-statu",
|
|
13
|
+
summary: "Addon Service Activation Status.",
|
|
14
|
+
description: "GET current subscription status for an addon service. Response can indicate whether the service was successfully subscribed or in pending state.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
description: "Addon_service\nName of the addon_service.",
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "addon_service",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
"x-displayname": "Addon Service.",
|
|
25
|
+
"x-ves-example": "Addon-service-1.",
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
queryParameters: [],
|
|
29
|
+
requestBodySchema: null,
|
|
30
|
+
responseSchema: {
|
|
31
|
+
$ref: "#/components/schemas/addon_serviceGetActivationStatusResp",
|
|
32
|
+
},
|
|
33
|
+
requiredParams: ["addon_service"],
|
|
34
|
+
operationId: "ves.io.schema.pbac.addon_service.CustomAPI.GetActivationStatus",
|
|
35
|
+
tags: ["Other"],
|
|
36
|
+
sourceFile: "domains/marketplace.json",
|
|
37
|
+
displayName: null,
|
|
38
|
+
dangerLevel: "low",
|
|
39
|
+
sideEffects: null,
|
|
40
|
+
requiredFields: ["path.addon_service"],
|
|
41
|
+
cliExamples: [
|
|
42
|
+
{
|
|
43
|
+
command: "f5xcctl web activation-statu list --namespace {namespace}",
|
|
44
|
+
description: "List all activation-status",
|
|
45
|
+
use_case: "list_all",
|
|
46
|
+
},
|
|
47
|
+
],
|
|
48
|
+
confirmationRequired: false,
|
|
49
|
+
parameterExamples: {
|
|
50
|
+
addon_service: "Addon-service-1.",
|
|
51
|
+
},
|
|
52
|
+
validationRules: {},
|
|
53
|
+
operationMetadata: {
|
|
54
|
+
common_errors: [
|
|
55
|
+
{
|
|
56
|
+
code: 401,
|
|
57
|
+
message: "Authentication required",
|
|
58
|
+
solution: "Provide valid API credentials",
|
|
59
|
+
},
|
|
60
|
+
{
|
|
61
|
+
code: 403,
|
|
62
|
+
message: "Permission denied",
|
|
63
|
+
solution: "Check access permissions for this operation",
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
code: 404,
|
|
67
|
+
message: "Resource not found",
|
|
68
|
+
solution: "Verify resource name, namespace, and path",
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
code: 409,
|
|
72
|
+
message: "Resource already exists",
|
|
73
|
+
solution: "Use different name or update existing resource",
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
code: 429,
|
|
77
|
+
message: "Rate limit exceeded",
|
|
78
|
+
solution: "Wait before retrying the operation",
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
code: 500,
|
|
82
|
+
message: "Server error",
|
|
83
|
+
solution: "Retry operation or contact support",
|
|
84
|
+
},
|
|
85
|
+
],
|
|
86
|
+
conditions: {
|
|
87
|
+
postconditions: [],
|
|
88
|
+
prerequisites: ["Active namespace"],
|
|
89
|
+
},
|
|
90
|
+
confirmation_required: false,
|
|
91
|
+
danger_level: "low",
|
|
92
|
+
examples: [
|
|
93
|
+
{
|
|
94
|
+
command: "f5xcctl web activation-statu list --namespace {namespace}",
|
|
95
|
+
description: "List all activation-status",
|
|
96
|
+
use_case: "list_all",
|
|
97
|
+
},
|
|
98
|
+
],
|
|
99
|
+
field_docs: {},
|
|
100
|
+
optional_fields: [],
|
|
101
|
+
performance_impact: {
|
|
102
|
+
latency: "moderate",
|
|
103
|
+
resource_usage: "moderate",
|
|
104
|
+
},
|
|
105
|
+
purpose: "List all activation-status",
|
|
106
|
+
required_fields: ["path.addon_service"],
|
|
107
|
+
side_effects: {},
|
|
108
|
+
},
|
|
109
|
+
},
|
|
110
|
+
{
|
|
111
|
+
toolName: "f5xc-api-marketplace-addon-service-get",
|
|
112
|
+
method: "GET",
|
|
113
|
+
path: "/api/web/custom/namespaces/shared/addon_services/{name}",
|
|
114
|
+
operation: "get",
|
|
115
|
+
domain: "marketplace",
|
|
116
|
+
resource: "addon-service",
|
|
117
|
+
summary: "GET Addon Service Details.",
|
|
118
|
+
description: "Retrieves addon service information for the given addon service name.",
|
|
119
|
+
pathParameters: [
|
|
120
|
+
{
|
|
121
|
+
description: "Name\nName of the addon service.",
|
|
122
|
+
in: "path",
|
|
123
|
+
name: "name",
|
|
124
|
+
required: true,
|
|
125
|
+
schema: {
|
|
126
|
+
type: "string",
|
|
127
|
+
},
|
|
128
|
+
"x-displayname": "Name",
|
|
129
|
+
"x-ves-example": "Addon-service-1.",
|
|
130
|
+
},
|
|
131
|
+
],
|
|
132
|
+
queryParameters: [],
|
|
133
|
+
requestBodySchema: null,
|
|
134
|
+
responseSchema: {
|
|
135
|
+
$ref: "#/components/schemas/addon_serviceGetAddonServiceDetailsResp",
|
|
136
|
+
},
|
|
137
|
+
requiredParams: ["name"],
|
|
138
|
+
operationId: "ves.io.schema.pbac.addon_service.CustomAPI.GetAddonServiceDetails",
|
|
139
|
+
tags: ["Other"],
|
|
140
|
+
sourceFile: "domains/marketplace.json",
|
|
141
|
+
displayName: null,
|
|
142
|
+
dangerLevel: "low",
|
|
143
|
+
sideEffects: null,
|
|
144
|
+
requiredFields: ["path.name"],
|
|
145
|
+
cliExamples: [
|
|
146
|
+
{
|
|
147
|
+
command: "f5xcctl web addon-service get {name} --namespace {namespace}",
|
|
148
|
+
description: "Get specific addon-service",
|
|
149
|
+
use_case: "get_specific",
|
|
150
|
+
},
|
|
151
|
+
],
|
|
152
|
+
confirmationRequired: false,
|
|
153
|
+
parameterExamples: {
|
|
154
|
+
name: "Addon-service-1.",
|
|
155
|
+
},
|
|
156
|
+
validationRules: {},
|
|
157
|
+
operationMetadata: {
|
|
158
|
+
common_errors: [
|
|
159
|
+
{
|
|
160
|
+
code: 401,
|
|
161
|
+
message: "Authentication required",
|
|
162
|
+
solution: "Provide valid API credentials",
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
code: 403,
|
|
166
|
+
message: "Permission denied",
|
|
167
|
+
solution: "Check access permissions for this operation",
|
|
168
|
+
},
|
|
169
|
+
{
|
|
170
|
+
code: 404,
|
|
171
|
+
message: "Resource not found",
|
|
172
|
+
solution: "Verify resource name, namespace, and path",
|
|
173
|
+
},
|
|
174
|
+
{
|
|
175
|
+
code: 409,
|
|
176
|
+
message: "Resource already exists",
|
|
177
|
+
solution: "Use different name or update existing resource",
|
|
178
|
+
},
|
|
179
|
+
{
|
|
180
|
+
code: 429,
|
|
181
|
+
message: "Rate limit exceeded",
|
|
182
|
+
solution: "Wait before retrying the operation",
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
code: 500,
|
|
186
|
+
message: "Server error",
|
|
187
|
+
solution: "Retry operation or contact support",
|
|
188
|
+
},
|
|
189
|
+
],
|
|
190
|
+
conditions: {
|
|
191
|
+
postconditions: [],
|
|
192
|
+
prerequisites: ["Active namespace"],
|
|
193
|
+
},
|
|
194
|
+
confirmation_required: false,
|
|
195
|
+
danger_level: "low",
|
|
196
|
+
examples: [
|
|
197
|
+
{
|
|
198
|
+
command: "f5xcctl web addon-service get {name} --namespace {namespace}",
|
|
199
|
+
description: "Get specific addon-service",
|
|
200
|
+
use_case: "get_specific",
|
|
201
|
+
},
|
|
202
|
+
],
|
|
203
|
+
field_docs: {},
|
|
204
|
+
optional_fields: [],
|
|
205
|
+
performance_impact: {
|
|
206
|
+
latency: "low",
|
|
207
|
+
resource_usage: "low",
|
|
208
|
+
},
|
|
209
|
+
purpose: "Retrieve specific addon-service",
|
|
210
|
+
required_fields: ["path.name"],
|
|
211
|
+
side_effects: {},
|
|
212
|
+
},
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
toolName: "f5xc-api-marketplace-addon-service-list",
|
|
216
|
+
method: "GET",
|
|
217
|
+
path: "/api/web/namespaces/{namespace}/addon_services",
|
|
218
|
+
operation: "list",
|
|
219
|
+
domain: "marketplace",
|
|
220
|
+
resource: "addon-service",
|
|
221
|
+
summary: "List Addon Service.",
|
|
222
|
+
description: "List the set of addon_service in a namespace.",
|
|
223
|
+
pathParameters: [
|
|
224
|
+
{
|
|
225
|
+
description: "Namespace\nNamespace to scope the listing of addon_service.",
|
|
226
|
+
in: "path",
|
|
227
|
+
name: "namespace",
|
|
228
|
+
required: true,
|
|
229
|
+
schema: {
|
|
230
|
+
type: "string",
|
|
231
|
+
},
|
|
232
|
+
"x-displayname": "Namespace",
|
|
233
|
+
"x-ves-example": "Ns1",
|
|
234
|
+
},
|
|
235
|
+
],
|
|
236
|
+
queryParameters: [
|
|
237
|
+
{
|
|
238
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
239
|
+
in: "query",
|
|
240
|
+
name: "label_filter",
|
|
241
|
+
required: false,
|
|
242
|
+
schema: {
|
|
243
|
+
type: "string",
|
|
244
|
+
},
|
|
245
|
+
"x-displayname": "Label Filter.",
|
|
246
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
247
|
+
},
|
|
248
|
+
{
|
|
249
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
250
|
+
in: "query",
|
|
251
|
+
name: "report_fields",
|
|
252
|
+
required: false,
|
|
253
|
+
schema: {
|
|
254
|
+
items: {
|
|
255
|
+
type: "string",
|
|
256
|
+
},
|
|
257
|
+
type: "array",
|
|
258
|
+
},
|
|
259
|
+
"x-displayname": "Report Fields.",
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
263
|
+
in: "query",
|
|
264
|
+
name: "report_status_fields",
|
|
265
|
+
required: false,
|
|
266
|
+
schema: {
|
|
267
|
+
items: {
|
|
268
|
+
type: "string",
|
|
269
|
+
},
|
|
270
|
+
type: "array",
|
|
271
|
+
},
|
|
272
|
+
"x-displayname": "Report Status Fields.",
|
|
273
|
+
},
|
|
274
|
+
],
|
|
275
|
+
requestBodySchema: null,
|
|
276
|
+
responseSchema: {
|
|
277
|
+
$ref: "#/components/schemas/addon_serviceListResponse",
|
|
278
|
+
},
|
|
279
|
+
requiredParams: ["namespace"],
|
|
280
|
+
operationId: "ves.io.schema.pbac.addon_service.API.List",
|
|
281
|
+
tags: ["Other"],
|
|
282
|
+
sourceFile: "domains/marketplace.json",
|
|
283
|
+
displayName: null,
|
|
284
|
+
dangerLevel: "low",
|
|
285
|
+
sideEffects: null,
|
|
286
|
+
requiredFields: ["path.namespace"],
|
|
287
|
+
cliExamples: [
|
|
288
|
+
{
|
|
289
|
+
command: "f5xcctl web addon-service list --namespace {namespace}",
|
|
290
|
+
description: "List all addon-services",
|
|
291
|
+
use_case: "list_all",
|
|
292
|
+
},
|
|
293
|
+
],
|
|
294
|
+
confirmationRequired: false,
|
|
295
|
+
parameterExamples: {
|
|
296
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
297
|
+
namespace: "Ns1",
|
|
298
|
+
},
|
|
299
|
+
validationRules: {},
|
|
300
|
+
operationMetadata: {
|
|
301
|
+
common_errors: [
|
|
302
|
+
{
|
|
303
|
+
code: 401,
|
|
304
|
+
message: "Authentication required",
|
|
305
|
+
solution: "Provide valid API credentials",
|
|
306
|
+
},
|
|
307
|
+
{
|
|
308
|
+
code: 403,
|
|
309
|
+
message: "Permission denied",
|
|
310
|
+
solution: "Check access permissions for this operation",
|
|
311
|
+
},
|
|
312
|
+
{
|
|
313
|
+
code: 404,
|
|
314
|
+
message: "Resource not found",
|
|
315
|
+
solution: "Verify resource name, namespace, and path",
|
|
316
|
+
},
|
|
317
|
+
{
|
|
318
|
+
code: 409,
|
|
319
|
+
message: "Resource already exists",
|
|
320
|
+
solution: "Use different name or update existing resource",
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
code: 429,
|
|
324
|
+
message: "Rate limit exceeded",
|
|
325
|
+
solution: "Wait before retrying the operation",
|
|
326
|
+
},
|
|
327
|
+
{
|
|
328
|
+
code: 500,
|
|
329
|
+
message: "Server error",
|
|
330
|
+
solution: "Retry operation or contact support",
|
|
331
|
+
},
|
|
332
|
+
],
|
|
333
|
+
conditions: {
|
|
334
|
+
postconditions: [],
|
|
335
|
+
prerequisites: ["Active namespace"],
|
|
336
|
+
},
|
|
337
|
+
confirmation_required: false,
|
|
338
|
+
danger_level: "low",
|
|
339
|
+
examples: [
|
|
340
|
+
{
|
|
341
|
+
command: "f5xcctl web addon-service list --namespace {namespace}",
|
|
342
|
+
description: "List all addon-services",
|
|
343
|
+
use_case: "list_all",
|
|
344
|
+
},
|
|
345
|
+
],
|
|
346
|
+
field_docs: {},
|
|
347
|
+
optional_fields: [],
|
|
348
|
+
performance_impact: {
|
|
349
|
+
latency: "moderate",
|
|
350
|
+
resource_usage: "moderate",
|
|
351
|
+
},
|
|
352
|
+
purpose: "List all addon-services",
|
|
353
|
+
required_fields: ["path.namespace"],
|
|
354
|
+
side_effects: {},
|
|
355
|
+
},
|
|
356
|
+
},
|
|
357
|
+
{
|
|
358
|
+
toolName: "f5xc-api-marketplace-addon-subscription-create",
|
|
359
|
+
method: "POST",
|
|
360
|
+
path: "/api/web/namespaces/{metadata.namespace}/addon_subscriptions",
|
|
361
|
+
operation: "create",
|
|
362
|
+
domain: "marketplace",
|
|
363
|
+
resource: "addon-subscription",
|
|
364
|
+
summary: "Create Addon Subscription.",
|
|
365
|
+
description: "Create a new Addon Subscription with Addon Subscription State.",
|
|
366
|
+
pathParameters: [
|
|
367
|
+
{
|
|
368
|
+
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 ""',
|
|
369
|
+
in: "path",
|
|
370
|
+
name: "metadata.namespace",
|
|
371
|
+
required: true,
|
|
372
|
+
schema: {
|
|
373
|
+
type: "string",
|
|
374
|
+
},
|
|
375
|
+
"x-displayname": "Namespace",
|
|
376
|
+
"x-ves-example": "Staging",
|
|
377
|
+
},
|
|
378
|
+
],
|
|
379
|
+
queryParameters: [],
|
|
380
|
+
requestBodySchema: {
|
|
381
|
+
$ref: "#/components/schemas/addon_subscriptionCreateRequest",
|
|
382
|
+
},
|
|
383
|
+
responseSchema: {
|
|
384
|
+
$ref: "#/components/schemas/addon_subscriptionCreateResponse",
|
|
385
|
+
},
|
|
386
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
387
|
+
operationId: "ves.io.schema.pbac.addon_subscription.API.Create",
|
|
388
|
+
tags: ["Other"],
|
|
389
|
+
sourceFile: "domains/marketplace.json",
|
|
390
|
+
displayName: null,
|
|
391
|
+
dangerLevel: "medium",
|
|
392
|
+
sideEffects: {
|
|
393
|
+
creates: ["addon-subscription"],
|
|
394
|
+
},
|
|
395
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
396
|
+
cliExamples: [
|
|
397
|
+
{
|
|
398
|
+
command: "f5xcctl web addon-subscription create {name} --namespace {namespace}",
|
|
399
|
+
description: "Create addon-subscription",
|
|
400
|
+
use_case: "basic_create",
|
|
401
|
+
},
|
|
402
|
+
{
|
|
403
|
+
command: "f5xcctl web addon-subscription create -f {file}.yaml",
|
|
404
|
+
description: "Create from YAML file",
|
|
405
|
+
use_case: "file_based",
|
|
406
|
+
},
|
|
407
|
+
],
|
|
408
|
+
confirmationRequired: false,
|
|
409
|
+
parameterExamples: {
|
|
410
|
+
"metadata.namespace": "Staging",
|
|
411
|
+
},
|
|
412
|
+
validationRules: {},
|
|
413
|
+
operationMetadata: {
|
|
414
|
+
common_errors: [
|
|
415
|
+
{
|
|
416
|
+
code: 401,
|
|
417
|
+
message: "Authentication required",
|
|
418
|
+
solution: "Provide valid API credentials",
|
|
419
|
+
},
|
|
420
|
+
{
|
|
421
|
+
code: 403,
|
|
422
|
+
message: "Permission denied",
|
|
423
|
+
solution: "Check access permissions for this operation",
|
|
424
|
+
},
|
|
425
|
+
{
|
|
426
|
+
code: 404,
|
|
427
|
+
message: "Resource not found",
|
|
428
|
+
solution: "Verify resource name, namespace, and path",
|
|
429
|
+
},
|
|
430
|
+
{
|
|
431
|
+
code: 409,
|
|
432
|
+
message: "Resource already exists",
|
|
433
|
+
solution: "Use different name or update existing resource",
|
|
434
|
+
},
|
|
435
|
+
{
|
|
436
|
+
code: 429,
|
|
437
|
+
message: "Rate limit exceeded",
|
|
438
|
+
solution: "Wait before retrying the operation",
|
|
439
|
+
},
|
|
440
|
+
{
|
|
441
|
+
code: 500,
|
|
442
|
+
message: "Server error",
|
|
443
|
+
solution: "Retry operation or contact support",
|
|
444
|
+
},
|
|
445
|
+
],
|
|
446
|
+
conditions: {
|
|
447
|
+
postconditions: [
|
|
448
|
+
"Addon-subscription resource created",
|
|
449
|
+
"Resource assigned unique identifier",
|
|
450
|
+
],
|
|
451
|
+
prerequisites: ["Active namespace"],
|
|
452
|
+
},
|
|
453
|
+
confirmation_required: false,
|
|
454
|
+
danger_level: "medium",
|
|
455
|
+
examples: [
|
|
456
|
+
{
|
|
457
|
+
command: "f5xcctl web addon-subscription create {name} --namespace {namespace}",
|
|
458
|
+
description: "Create addon-subscription",
|
|
459
|
+
use_case: "basic_create",
|
|
460
|
+
},
|
|
461
|
+
{
|
|
462
|
+
command: "f5xcctl web addon-subscription create -f {file}.yaml",
|
|
463
|
+
description: "Create from YAML file",
|
|
464
|
+
use_case: "file_based",
|
|
465
|
+
},
|
|
466
|
+
],
|
|
467
|
+
field_docs: {},
|
|
468
|
+
optional_fields: [],
|
|
469
|
+
performance_impact: {
|
|
470
|
+
latency: "low",
|
|
471
|
+
resource_usage: "low",
|
|
472
|
+
},
|
|
473
|
+
purpose: "Create new addon-subscription",
|
|
474
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
475
|
+
side_effects: {
|
|
476
|
+
creates: ["addon-subscription"],
|
|
477
|
+
},
|
|
478
|
+
},
|
|
479
|
+
},
|
|
480
|
+
{
|
|
481
|
+
toolName: "f5xc-api-marketplace-addon-subscription-delete",
|
|
482
|
+
method: "DELETE",
|
|
483
|
+
path: "/api/web/namespaces/{namespace}/addon_subscriptions/{name}",
|
|
484
|
+
operation: "delete",
|
|
485
|
+
domain: "marketplace",
|
|
486
|
+
resource: "addon-subscription",
|
|
487
|
+
summary: "DELETE Addon Subscrption.",
|
|
488
|
+
description: "DELETE the specified addon_subscription.",
|
|
489
|
+
pathParameters: [
|
|
490
|
+
{
|
|
491
|
+
description: "Name\nName of the configuration object.",
|
|
492
|
+
in: "path",
|
|
493
|
+
name: "name",
|
|
494
|
+
required: true,
|
|
495
|
+
schema: {
|
|
496
|
+
type: "string",
|
|
497
|
+
},
|
|
498
|
+
"x-displayname": "Name",
|
|
499
|
+
"x-ves-example": "Name",
|
|
500
|
+
},
|
|
501
|
+
{
|
|
502
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
503
|
+
in: "path",
|
|
504
|
+
name: "namespace",
|
|
505
|
+
required: true,
|
|
506
|
+
schema: {
|
|
507
|
+
type: "string",
|
|
508
|
+
},
|
|
509
|
+
"x-displayname": "Namespace",
|
|
510
|
+
"x-ves-example": "Ns1",
|
|
511
|
+
},
|
|
512
|
+
],
|
|
513
|
+
queryParameters: [],
|
|
514
|
+
requestBodySchema: {
|
|
515
|
+
$ref: "#/components/schemas/addon_subscriptionDeleteRequest",
|
|
516
|
+
},
|
|
517
|
+
responseSchema: {},
|
|
518
|
+
requiredParams: ["body", "name", "namespace"],
|
|
519
|
+
operationId: "ves.io.schema.pbac.addon_subscription.API.Delete",
|
|
520
|
+
tags: ["Other"],
|
|
521
|
+
sourceFile: "domains/marketplace.json",
|
|
522
|
+
displayName: null,
|
|
523
|
+
dangerLevel: "high",
|
|
524
|
+
sideEffects: {
|
|
525
|
+
deletes: ["addon-subscription", "contained_resources"],
|
|
526
|
+
},
|
|
527
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
528
|
+
cliExamples: [
|
|
529
|
+
{
|
|
530
|
+
command: "f5xcctl web addon-subscription delete {name} --namespace {namespace}",
|
|
531
|
+
description: "Delete addon-subscription",
|
|
532
|
+
use_case: "delete",
|
|
533
|
+
},
|
|
534
|
+
],
|
|
535
|
+
confirmationRequired: true,
|
|
536
|
+
parameterExamples: {
|
|
537
|
+
name: "Name",
|
|
538
|
+
namespace: "Ns1",
|
|
539
|
+
},
|
|
540
|
+
validationRules: {},
|
|
541
|
+
operationMetadata: {
|
|
542
|
+
common_errors: [
|
|
543
|
+
{
|
|
544
|
+
code: 401,
|
|
545
|
+
message: "Authentication required",
|
|
546
|
+
solution: "Provide valid API credentials",
|
|
547
|
+
},
|
|
548
|
+
{
|
|
549
|
+
code: 403,
|
|
550
|
+
message: "Permission denied",
|
|
551
|
+
solution: "Check access permissions for this operation",
|
|
552
|
+
},
|
|
553
|
+
{
|
|
554
|
+
code: 404,
|
|
555
|
+
message: "Resource not found",
|
|
556
|
+
solution: "Verify resource name, namespace, and path",
|
|
557
|
+
},
|
|
558
|
+
{
|
|
559
|
+
code: 409,
|
|
560
|
+
message: "Resource already exists",
|
|
561
|
+
solution: "Use different name or update existing resource",
|
|
562
|
+
},
|
|
563
|
+
{
|
|
564
|
+
code: 429,
|
|
565
|
+
message: "Rate limit exceeded",
|
|
566
|
+
solution: "Wait before retrying the operation",
|
|
567
|
+
},
|
|
568
|
+
{
|
|
569
|
+
code: 500,
|
|
570
|
+
message: "Server error",
|
|
571
|
+
solution: "Retry operation or contact support",
|
|
572
|
+
},
|
|
573
|
+
],
|
|
574
|
+
conditions: {
|
|
575
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
576
|
+
prerequisites: ["Active namespace"],
|
|
577
|
+
},
|
|
578
|
+
confirmation_required: true,
|
|
579
|
+
danger_level: "high",
|
|
580
|
+
examples: [
|
|
581
|
+
{
|
|
582
|
+
command: "f5xcctl web addon-subscription delete {name} --namespace {namespace}",
|
|
583
|
+
description: "Delete addon-subscription",
|
|
584
|
+
use_case: "delete",
|
|
585
|
+
},
|
|
586
|
+
],
|
|
587
|
+
field_docs: {},
|
|
588
|
+
optional_fields: [],
|
|
589
|
+
performance_impact: {
|
|
590
|
+
latency: "high",
|
|
591
|
+
resource_usage: "moderate",
|
|
592
|
+
},
|
|
593
|
+
purpose: "Delete addon-subscription",
|
|
594
|
+
required_fields: ["path.name", "path.namespace"],
|
|
595
|
+
side_effects: {
|
|
596
|
+
deletes: ["addon-subscription", "contained_resources"],
|
|
597
|
+
},
|
|
598
|
+
},
|
|
599
|
+
},
|
|
600
|
+
{
|
|
601
|
+
toolName: "f5xc-api-marketplace-addon-subscription-get",
|
|
602
|
+
method: "GET",
|
|
603
|
+
path: "/api/web/namespaces/{namespace}/addon_subscriptions/{name}",
|
|
604
|
+
operation: "get",
|
|
605
|
+
domain: "marketplace",
|
|
606
|
+
resource: "addon-subscription",
|
|
607
|
+
summary: "GET Addon Subsciption.",
|
|
608
|
+
description: "GET Addon Subsciption reads a given object from storage backend for metadata.namespace.",
|
|
609
|
+
pathParameters: [
|
|
610
|
+
{
|
|
611
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
612
|
+
in: "path",
|
|
613
|
+
name: "name",
|
|
614
|
+
required: true,
|
|
615
|
+
schema: {
|
|
616
|
+
type: "string",
|
|
617
|
+
},
|
|
618
|
+
"x-displayname": "Name",
|
|
619
|
+
"x-ves-example": "Name",
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
623
|
+
in: "path",
|
|
624
|
+
name: "namespace",
|
|
625
|
+
required: true,
|
|
626
|
+
schema: {
|
|
627
|
+
type: "string",
|
|
628
|
+
},
|
|
629
|
+
"x-displayname": "Namespace",
|
|
630
|
+
"x-ves-example": "Ns1",
|
|
631
|
+
},
|
|
632
|
+
],
|
|
633
|
+
queryParameters: [
|
|
634
|
+
{
|
|
635
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in CreateRequest format\nResponse should be in ReplaceRequest format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
636
|
+
in: "query",
|
|
637
|
+
name: "response_format",
|
|
638
|
+
required: false,
|
|
639
|
+
schema: {
|
|
640
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
641
|
+
enum: [
|
|
642
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
643
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
644
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
645
|
+
"GET_RSP_FORMAT_READ",
|
|
646
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
647
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
648
|
+
],
|
|
649
|
+
type: "string",
|
|
650
|
+
},
|
|
651
|
+
"x-displayname": "Broken Referred Objects.",
|
|
652
|
+
},
|
|
653
|
+
],
|
|
654
|
+
requestBodySchema: null,
|
|
655
|
+
responseSchema: {
|
|
656
|
+
$ref: "#/components/schemas/addon_subscriptionGetResponse",
|
|
657
|
+
},
|
|
658
|
+
requiredParams: ["name", "namespace"],
|
|
659
|
+
operationId: "ves.io.schema.pbac.addon_subscription.API.Get",
|
|
660
|
+
tags: ["Other"],
|
|
661
|
+
sourceFile: "domains/marketplace.json",
|
|
662
|
+
displayName: null,
|
|
663
|
+
dangerLevel: "low",
|
|
664
|
+
sideEffects: null,
|
|
665
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
666
|
+
cliExamples: [
|
|
667
|
+
{
|
|
668
|
+
command: "f5xcctl web addon-subscription get {name} --namespace {namespace}",
|
|
669
|
+
description: "Get specific addon-subscription",
|
|
670
|
+
use_case: "get_specific",
|
|
671
|
+
},
|
|
672
|
+
],
|
|
673
|
+
confirmationRequired: false,
|
|
674
|
+
parameterExamples: {
|
|
675
|
+
name: "Name",
|
|
676
|
+
namespace: "Ns1",
|
|
677
|
+
},
|
|
678
|
+
validationRules: {},
|
|
679
|
+
operationMetadata: {
|
|
680
|
+
common_errors: [
|
|
681
|
+
{
|
|
682
|
+
code: 401,
|
|
683
|
+
message: "Authentication required",
|
|
684
|
+
solution: "Provide valid API credentials",
|
|
685
|
+
},
|
|
686
|
+
{
|
|
687
|
+
code: 403,
|
|
688
|
+
message: "Permission denied",
|
|
689
|
+
solution: "Check access permissions for this operation",
|
|
690
|
+
},
|
|
691
|
+
{
|
|
692
|
+
code: 404,
|
|
693
|
+
message: "Resource not found",
|
|
694
|
+
solution: "Verify resource name, namespace, and path",
|
|
695
|
+
},
|
|
696
|
+
{
|
|
697
|
+
code: 409,
|
|
698
|
+
message: "Resource already exists",
|
|
699
|
+
solution: "Use different name or update existing resource",
|
|
700
|
+
},
|
|
701
|
+
{
|
|
702
|
+
code: 429,
|
|
703
|
+
message: "Rate limit exceeded",
|
|
704
|
+
solution: "Wait before retrying the operation",
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
code: 500,
|
|
708
|
+
message: "Server error",
|
|
709
|
+
solution: "Retry operation or contact support",
|
|
710
|
+
},
|
|
711
|
+
],
|
|
712
|
+
conditions: {
|
|
713
|
+
postconditions: [],
|
|
714
|
+
prerequisites: ["Active namespace"],
|
|
715
|
+
},
|
|
716
|
+
confirmation_required: false,
|
|
717
|
+
danger_level: "low",
|
|
718
|
+
examples: [
|
|
719
|
+
{
|
|
720
|
+
command: "f5xcctl web addon-subscription get {name} --namespace {namespace}",
|
|
721
|
+
description: "Get specific addon-subscription",
|
|
722
|
+
use_case: "get_specific",
|
|
723
|
+
},
|
|
724
|
+
],
|
|
725
|
+
field_docs: {},
|
|
726
|
+
optional_fields: [],
|
|
727
|
+
performance_impact: {
|
|
728
|
+
latency: "low",
|
|
729
|
+
resource_usage: "low",
|
|
730
|
+
},
|
|
731
|
+
purpose: "Retrieve specific addon-subscription",
|
|
732
|
+
required_fields: ["path.name", "path.namespace"],
|
|
733
|
+
side_effects: {},
|
|
734
|
+
},
|
|
735
|
+
},
|
|
736
|
+
{
|
|
737
|
+
toolName: "f5xc-api-marketplace-addon-subscription-list",
|
|
738
|
+
method: "GET",
|
|
739
|
+
path: "/api/web/namespaces/{namespace}/addon_subscriptions",
|
|
740
|
+
operation: "list",
|
|
741
|
+
domain: "marketplace",
|
|
742
|
+
resource: "addon-subscription",
|
|
743
|
+
summary: "List Addon Subscrption.",
|
|
744
|
+
description: "List the set of addon_subscription in a namespace.",
|
|
745
|
+
pathParameters: [
|
|
746
|
+
{
|
|
747
|
+
description: "Namespace\nNamespace to scope the listing of addon_subscription.",
|
|
748
|
+
in: "path",
|
|
749
|
+
name: "namespace",
|
|
750
|
+
required: true,
|
|
751
|
+
schema: {
|
|
752
|
+
type: "string",
|
|
753
|
+
},
|
|
754
|
+
"x-displayname": "Namespace",
|
|
755
|
+
"x-ves-example": "Ns1",
|
|
756
|
+
},
|
|
757
|
+
],
|
|
758
|
+
queryParameters: [
|
|
759
|
+
{
|
|
760
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
761
|
+
in: "query",
|
|
762
|
+
name: "label_filter",
|
|
763
|
+
required: false,
|
|
764
|
+
schema: {
|
|
765
|
+
type: "string",
|
|
766
|
+
},
|
|
767
|
+
"x-displayname": "Label Filter.",
|
|
768
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
769
|
+
},
|
|
770
|
+
{
|
|
771
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
772
|
+
in: "query",
|
|
773
|
+
name: "report_fields",
|
|
774
|
+
required: false,
|
|
775
|
+
schema: {
|
|
776
|
+
items: {
|
|
777
|
+
type: "string",
|
|
778
|
+
},
|
|
779
|
+
type: "array",
|
|
780
|
+
},
|
|
781
|
+
"x-displayname": "Report Fields.",
|
|
782
|
+
},
|
|
783
|
+
{
|
|
784
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
785
|
+
in: "query",
|
|
786
|
+
name: "report_status_fields",
|
|
787
|
+
required: false,
|
|
788
|
+
schema: {
|
|
789
|
+
items: {
|
|
790
|
+
type: "string",
|
|
791
|
+
},
|
|
792
|
+
type: "array",
|
|
793
|
+
},
|
|
794
|
+
"x-displayname": "Report Status Fields.",
|
|
795
|
+
},
|
|
796
|
+
],
|
|
797
|
+
requestBodySchema: null,
|
|
798
|
+
responseSchema: {
|
|
799
|
+
$ref: "#/components/schemas/addon_subscriptionListResponse",
|
|
800
|
+
},
|
|
801
|
+
requiredParams: ["namespace"],
|
|
802
|
+
operationId: "ves.io.schema.pbac.addon_subscription.API.List",
|
|
803
|
+
tags: ["Other"],
|
|
804
|
+
sourceFile: "domains/marketplace.json",
|
|
805
|
+
displayName: null,
|
|
806
|
+
dangerLevel: "low",
|
|
807
|
+
sideEffects: null,
|
|
808
|
+
requiredFields: ["path.namespace"],
|
|
809
|
+
cliExamples: [
|
|
810
|
+
{
|
|
811
|
+
command: "f5xcctl web addon-subscription list --namespace {namespace}",
|
|
812
|
+
description: "List all addon-subscriptions",
|
|
813
|
+
use_case: "list_all",
|
|
814
|
+
},
|
|
815
|
+
],
|
|
816
|
+
confirmationRequired: false,
|
|
817
|
+
parameterExamples: {
|
|
818
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
819
|
+
namespace: "Ns1",
|
|
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: [],
|
|
857
|
+
prerequisites: ["Active namespace"],
|
|
858
|
+
},
|
|
859
|
+
confirmation_required: false,
|
|
860
|
+
danger_level: "low",
|
|
861
|
+
examples: [
|
|
862
|
+
{
|
|
863
|
+
command: "f5xcctl web addon-subscription list --namespace {namespace}",
|
|
864
|
+
description: "List all addon-subscriptions",
|
|
865
|
+
use_case: "list_all",
|
|
866
|
+
},
|
|
867
|
+
],
|
|
868
|
+
field_docs: {},
|
|
869
|
+
optional_fields: [],
|
|
870
|
+
performance_impact: {
|
|
871
|
+
latency: "moderate",
|
|
872
|
+
resource_usage: "moderate",
|
|
873
|
+
},
|
|
874
|
+
purpose: "List all addon-subscriptions",
|
|
875
|
+
required_fields: ["path.namespace"],
|
|
876
|
+
side_effects: {},
|
|
877
|
+
},
|
|
878
|
+
},
|
|
879
|
+
{
|
|
880
|
+
toolName: "f5xc-api-marketplace-addon-subscription-update",
|
|
881
|
+
method: "PUT",
|
|
882
|
+
path: "/api/web/namespaces/{metadata.namespace}/addon_subscriptions/{metadata.name}",
|
|
883
|
+
operation: "update",
|
|
884
|
+
domain: "marketplace",
|
|
885
|
+
resource: "addon-subscription",
|
|
886
|
+
summary: "Replace Addon Subscription.",
|
|
887
|
+
description: "Replace a given Addon Subscription with with Addon Subscription State.",
|
|
888
|
+
pathParameters: [
|
|
889
|
+
{
|
|
890
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
891
|
+
in: "path",
|
|
892
|
+
name: "metadata.name",
|
|
893
|
+
required: true,
|
|
894
|
+
schema: {
|
|
895
|
+
type: "string",
|
|
896
|
+
},
|
|
897
|
+
"x-displayname": "Name",
|
|
898
|
+
"x-ves-example": "Example-corp-web.",
|
|
899
|
+
},
|
|
900
|
+
{
|
|
901
|
+
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 ""',
|
|
902
|
+
in: "path",
|
|
903
|
+
name: "metadata.namespace",
|
|
904
|
+
required: true,
|
|
905
|
+
schema: {
|
|
906
|
+
type: "string",
|
|
907
|
+
},
|
|
908
|
+
"x-displayname": "Namespace",
|
|
909
|
+
"x-ves-example": "Staging",
|
|
910
|
+
},
|
|
911
|
+
],
|
|
912
|
+
queryParameters: [],
|
|
913
|
+
requestBodySchema: {
|
|
914
|
+
$ref: "#/components/schemas/addon_subscriptionReplaceRequest",
|
|
915
|
+
},
|
|
916
|
+
responseSchema: {
|
|
917
|
+
$ref: "#/components/schemas/addon_subscriptionReplaceResponse",
|
|
918
|
+
},
|
|
919
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
920
|
+
operationId: "ves.io.schema.pbac.addon_subscription.API.Replace",
|
|
921
|
+
tags: ["Other"],
|
|
922
|
+
sourceFile: "domains/marketplace.json",
|
|
923
|
+
displayName: null,
|
|
924
|
+
dangerLevel: "medium",
|
|
925
|
+
sideEffects: {
|
|
926
|
+
modifies: ["addon-subscription"],
|
|
927
|
+
},
|
|
928
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
929
|
+
cliExamples: [
|
|
930
|
+
{
|
|
931
|
+
command: "f5xcctl web addon-subscription update {name} --namespace {namespace} -f {file}.yaml",
|
|
932
|
+
description: "Update addon-subscription",
|
|
933
|
+
use_case: "update",
|
|
934
|
+
},
|
|
935
|
+
],
|
|
936
|
+
confirmationRequired: false,
|
|
937
|
+
parameterExamples: {
|
|
938
|
+
"metadata.name": "Example-corp-web.",
|
|
939
|
+
"metadata.namespace": "Staging",
|
|
940
|
+
},
|
|
941
|
+
validationRules: {},
|
|
942
|
+
operationMetadata: {
|
|
943
|
+
common_errors: [
|
|
944
|
+
{
|
|
945
|
+
code: 401,
|
|
946
|
+
message: "Authentication required",
|
|
947
|
+
solution: "Provide valid API credentials",
|
|
948
|
+
},
|
|
949
|
+
{
|
|
950
|
+
code: 403,
|
|
951
|
+
message: "Permission denied",
|
|
952
|
+
solution: "Check access permissions for this operation",
|
|
953
|
+
},
|
|
954
|
+
{
|
|
955
|
+
code: 404,
|
|
956
|
+
message: "Resource not found",
|
|
957
|
+
solution: "Verify resource name, namespace, and path",
|
|
958
|
+
},
|
|
959
|
+
{
|
|
960
|
+
code: 409,
|
|
961
|
+
message: "Resource already exists",
|
|
962
|
+
solution: "Use different name or update existing resource",
|
|
963
|
+
},
|
|
964
|
+
{
|
|
965
|
+
code: 429,
|
|
966
|
+
message: "Rate limit exceeded",
|
|
967
|
+
solution: "Wait before retrying the operation",
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
code: 500,
|
|
971
|
+
message: "Server error",
|
|
972
|
+
solution: "Retry operation or contact support",
|
|
973
|
+
},
|
|
974
|
+
],
|
|
975
|
+
conditions: {
|
|
976
|
+
postconditions: ["Resource updated with new values"],
|
|
977
|
+
prerequisites: ["Active namespace"],
|
|
978
|
+
},
|
|
979
|
+
confirmation_required: false,
|
|
980
|
+
danger_level: "medium",
|
|
981
|
+
examples: [
|
|
982
|
+
{
|
|
983
|
+
command: "f5xcctl web addon-subscription update {name} --namespace {namespace} -f {file}.yaml",
|
|
984
|
+
description: "Update addon-subscription",
|
|
985
|
+
use_case: "update",
|
|
986
|
+
},
|
|
987
|
+
],
|
|
988
|
+
field_docs: {},
|
|
989
|
+
optional_fields: [],
|
|
990
|
+
performance_impact: {
|
|
991
|
+
latency: "low",
|
|
992
|
+
resource_usage: "low",
|
|
993
|
+
},
|
|
994
|
+
purpose: "Replace existing addon-subscription",
|
|
995
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
996
|
+
side_effects: {
|
|
997
|
+
modifies: ["addon-subscription"],
|
|
998
|
+
},
|
|
999
|
+
},
|
|
1000
|
+
},
|
|
1001
|
+
{
|
|
1002
|
+
toolName: "f5xc-api-marketplace-all-activation-statu-list",
|
|
1003
|
+
method: "GET",
|
|
1004
|
+
path: "/api/web/namespaces/system/addon_services/{addon_service}/all-activation-status",
|
|
1005
|
+
operation: "list",
|
|
1006
|
+
domain: "marketplace",
|
|
1007
|
+
resource: "all-activation-statu",
|
|
1008
|
+
summary: "All Addon Service Activation Status.",
|
|
1009
|
+
description: "GET current subscription status for all addon services in a feature tier. Response can indicate whether the service was successfully subscribed or in pending state.",
|
|
1010
|
+
pathParameters: [
|
|
1011
|
+
{
|
|
1012
|
+
description: "Addon_service\nName of the addon_service feature tier.",
|
|
1013
|
+
in: "path",
|
|
1014
|
+
name: "addon_service",
|
|
1015
|
+
required: true,
|
|
1016
|
+
schema: {
|
|
1017
|
+
type: "string",
|
|
1018
|
+
},
|
|
1019
|
+
"x-displayname": "Addon Service.",
|
|
1020
|
+
"x-ves-example": "Addon-service-1.",
|
|
1021
|
+
},
|
|
1022
|
+
],
|
|
1023
|
+
queryParameters: [],
|
|
1024
|
+
requestBodySchema: null,
|
|
1025
|
+
responseSchema: {
|
|
1026
|
+
$ref: "#/components/schemas/addon_serviceGetAllServiceTiersActivationStatusResp",
|
|
1027
|
+
},
|
|
1028
|
+
requiredParams: ["addon_service"],
|
|
1029
|
+
operationId: "ves.io.schema.pbac.addon_service.CustomAPI.GetAllServiceTiersActivationStatus",
|
|
1030
|
+
tags: ["Other"],
|
|
1031
|
+
sourceFile: "domains/marketplace.json",
|
|
1032
|
+
displayName: null,
|
|
1033
|
+
dangerLevel: "low",
|
|
1034
|
+
sideEffects: null,
|
|
1035
|
+
requiredFields: ["path.addon_service"],
|
|
1036
|
+
cliExamples: [
|
|
1037
|
+
{
|
|
1038
|
+
command: "f5xcctl web all-activation-statu list --namespace {namespace}",
|
|
1039
|
+
description: "List all all-activation-status",
|
|
1040
|
+
use_case: "list_all",
|
|
1041
|
+
},
|
|
1042
|
+
],
|
|
1043
|
+
confirmationRequired: false,
|
|
1044
|
+
parameterExamples: {
|
|
1045
|
+
addon_service: "Addon-service-1.",
|
|
1046
|
+
},
|
|
1047
|
+
validationRules: {},
|
|
1048
|
+
operationMetadata: {
|
|
1049
|
+
common_errors: [
|
|
1050
|
+
{
|
|
1051
|
+
code: 401,
|
|
1052
|
+
message: "Authentication required",
|
|
1053
|
+
solution: "Provide valid API credentials",
|
|
1054
|
+
},
|
|
1055
|
+
{
|
|
1056
|
+
code: 403,
|
|
1057
|
+
message: "Permission denied",
|
|
1058
|
+
solution: "Check access permissions for this operation",
|
|
1059
|
+
},
|
|
1060
|
+
{
|
|
1061
|
+
code: 404,
|
|
1062
|
+
message: "Resource not found",
|
|
1063
|
+
solution: "Verify resource name, namespace, and path",
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
code: 409,
|
|
1067
|
+
message: "Resource already exists",
|
|
1068
|
+
solution: "Use different name or update existing resource",
|
|
1069
|
+
},
|
|
1070
|
+
{
|
|
1071
|
+
code: 429,
|
|
1072
|
+
message: "Rate limit exceeded",
|
|
1073
|
+
solution: "Wait before retrying the operation",
|
|
1074
|
+
},
|
|
1075
|
+
{
|
|
1076
|
+
code: 500,
|
|
1077
|
+
message: "Server error",
|
|
1078
|
+
solution: "Retry operation or contact support",
|
|
1079
|
+
},
|
|
1080
|
+
],
|
|
1081
|
+
conditions: {
|
|
1082
|
+
postconditions: [],
|
|
1083
|
+
prerequisites: ["Active namespace"],
|
|
1084
|
+
},
|
|
1085
|
+
confirmation_required: false,
|
|
1086
|
+
danger_level: "low",
|
|
1087
|
+
examples: [
|
|
1088
|
+
{
|
|
1089
|
+
command: "f5xcctl web all-activation-statu list --namespace {namespace}",
|
|
1090
|
+
description: "List all all-activation-status",
|
|
1091
|
+
use_case: "list_all",
|
|
1092
|
+
},
|
|
1093
|
+
],
|
|
1094
|
+
field_docs: {},
|
|
1095
|
+
optional_fields: [],
|
|
1096
|
+
performance_impact: {
|
|
1097
|
+
latency: "moderate",
|
|
1098
|
+
resource_usage: "moderate",
|
|
1099
|
+
},
|
|
1100
|
+
purpose: "List all all-activation-status",
|
|
1101
|
+
required_fields: ["path.addon_service"],
|
|
1102
|
+
side_effects: {},
|
|
1103
|
+
},
|
|
1104
|
+
},
|
|
1105
|
+
{
|
|
1106
|
+
toolName: "f5xc-api-marketplace-cminstance-create",
|
|
1107
|
+
method: "POST",
|
|
1108
|
+
path: "/api/config/namespaces/{metadata.namespace}/cminstances",
|
|
1109
|
+
operation: "create",
|
|
1110
|
+
domain: "marketplace",
|
|
1111
|
+
resource: "cminstance",
|
|
1112
|
+
summary: "Create Central Manager Insatnce.",
|
|
1113
|
+
description: "Create App type will create the configuration in namespace metadata.namespace.",
|
|
1114
|
+
pathParameters: [
|
|
1115
|
+
{
|
|
1116
|
+
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 ""',
|
|
1117
|
+
in: "path",
|
|
1118
|
+
name: "metadata.namespace",
|
|
1119
|
+
required: true,
|
|
1120
|
+
schema: {
|
|
1121
|
+
type: "string",
|
|
1122
|
+
},
|
|
1123
|
+
"x-displayname": "Namespace",
|
|
1124
|
+
"x-ves-example": "Staging",
|
|
1125
|
+
},
|
|
1126
|
+
],
|
|
1127
|
+
queryParameters: [],
|
|
1128
|
+
requestBodySchema: {
|
|
1129
|
+
$ref: "#/components/schemas/cminstanceCreateRequest",
|
|
1130
|
+
},
|
|
1131
|
+
responseSchema: {
|
|
1132
|
+
$ref: "#/components/schemas/cminstanceCreateResponse",
|
|
1133
|
+
},
|
|
1134
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1135
|
+
operationId: "ves.io.schema.cminstance.API.Create",
|
|
1136
|
+
tags: ["Other"],
|
|
1137
|
+
sourceFile: "domains/marketplace.json",
|
|
1138
|
+
displayName: null,
|
|
1139
|
+
dangerLevel: "medium",
|
|
1140
|
+
sideEffects: {
|
|
1141
|
+
creates: ["cminstance"],
|
|
1142
|
+
},
|
|
1143
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1144
|
+
cliExamples: [
|
|
1145
|
+
{
|
|
1146
|
+
command: "f5xcctl config cminstance create {name} --namespace {namespace}",
|
|
1147
|
+
description: "Create cminstance",
|
|
1148
|
+
use_case: "basic_create",
|
|
1149
|
+
},
|
|
1150
|
+
{
|
|
1151
|
+
command: "f5xcctl config cminstance create -f {file}.yaml",
|
|
1152
|
+
description: "Create from YAML file",
|
|
1153
|
+
use_case: "file_based",
|
|
1154
|
+
},
|
|
1155
|
+
],
|
|
1156
|
+
confirmationRequired: false,
|
|
1157
|
+
parameterExamples: {
|
|
1158
|
+
"metadata.namespace": "Staging",
|
|
1159
|
+
},
|
|
1160
|
+
validationRules: {},
|
|
1161
|
+
operationMetadata: {
|
|
1162
|
+
common_errors: [
|
|
1163
|
+
{
|
|
1164
|
+
code: 401,
|
|
1165
|
+
message: "Authentication required",
|
|
1166
|
+
solution: "Provide valid API credentials",
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
code: 403,
|
|
1170
|
+
message: "Permission denied",
|
|
1171
|
+
solution: "Check access permissions for this operation",
|
|
1172
|
+
},
|
|
1173
|
+
{
|
|
1174
|
+
code: 404,
|
|
1175
|
+
message: "Resource not found",
|
|
1176
|
+
solution: "Verify resource name, namespace, and path",
|
|
1177
|
+
},
|
|
1178
|
+
{
|
|
1179
|
+
code: 409,
|
|
1180
|
+
message: "Resource already exists",
|
|
1181
|
+
solution: "Use different name or update existing resource",
|
|
1182
|
+
},
|
|
1183
|
+
{
|
|
1184
|
+
code: 429,
|
|
1185
|
+
message: "Rate limit exceeded",
|
|
1186
|
+
solution: "Wait before retrying the operation",
|
|
1187
|
+
},
|
|
1188
|
+
{
|
|
1189
|
+
code: 500,
|
|
1190
|
+
message: "Server error",
|
|
1191
|
+
solution: "Retry operation or contact support",
|
|
1192
|
+
},
|
|
1193
|
+
],
|
|
1194
|
+
conditions: {
|
|
1195
|
+
postconditions: ["Cminstance resource created", "Resource assigned unique identifier"],
|
|
1196
|
+
prerequisites: ["Active namespace"],
|
|
1197
|
+
},
|
|
1198
|
+
confirmation_required: false,
|
|
1199
|
+
danger_level: "medium",
|
|
1200
|
+
examples: [
|
|
1201
|
+
{
|
|
1202
|
+
command: "f5xcctl config cminstance create {name} --namespace {namespace}",
|
|
1203
|
+
description: "Create cminstance",
|
|
1204
|
+
use_case: "basic_create",
|
|
1205
|
+
},
|
|
1206
|
+
{
|
|
1207
|
+
command: "f5xcctl config cminstance create -f {file}.yaml",
|
|
1208
|
+
description: "Create from YAML file",
|
|
1209
|
+
use_case: "file_based",
|
|
1210
|
+
},
|
|
1211
|
+
],
|
|
1212
|
+
field_docs: {},
|
|
1213
|
+
optional_fields: [],
|
|
1214
|
+
performance_impact: {
|
|
1215
|
+
latency: "low",
|
|
1216
|
+
resource_usage: "low",
|
|
1217
|
+
},
|
|
1218
|
+
purpose: "Create new cminstance",
|
|
1219
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1220
|
+
side_effects: {
|
|
1221
|
+
creates: ["cminstance"],
|
|
1222
|
+
},
|
|
1223
|
+
},
|
|
1224
|
+
},
|
|
1225
|
+
{
|
|
1226
|
+
toolName: "f5xc-api-marketplace-cminstance-delete",
|
|
1227
|
+
method: "DELETE",
|
|
1228
|
+
path: "/api/config/namespaces/{namespace}/cminstances/{name}",
|
|
1229
|
+
operation: "delete",
|
|
1230
|
+
domain: "marketplace",
|
|
1231
|
+
resource: "cminstance",
|
|
1232
|
+
summary: "DELETE Central Manager Instance.",
|
|
1233
|
+
description: "DELETE the specified cminstance.",
|
|
1234
|
+
pathParameters: [
|
|
1235
|
+
{
|
|
1236
|
+
description: "Name\nName of the configuration object.",
|
|
1237
|
+
in: "path",
|
|
1238
|
+
name: "name",
|
|
1239
|
+
required: true,
|
|
1240
|
+
schema: {
|
|
1241
|
+
type: "string",
|
|
1242
|
+
},
|
|
1243
|
+
"x-displayname": "Name",
|
|
1244
|
+
"x-ves-example": "Name",
|
|
1245
|
+
},
|
|
1246
|
+
{
|
|
1247
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1248
|
+
in: "path",
|
|
1249
|
+
name: "namespace",
|
|
1250
|
+
required: true,
|
|
1251
|
+
schema: {
|
|
1252
|
+
type: "string",
|
|
1253
|
+
},
|
|
1254
|
+
"x-displayname": "Namespace",
|
|
1255
|
+
"x-ves-example": "Ns1",
|
|
1256
|
+
},
|
|
1257
|
+
],
|
|
1258
|
+
queryParameters: [],
|
|
1259
|
+
requestBodySchema: {
|
|
1260
|
+
$ref: "#/components/schemas/cminstanceDeleteRequest",
|
|
1261
|
+
},
|
|
1262
|
+
responseSchema: {},
|
|
1263
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1264
|
+
operationId: "ves.io.schema.cminstance.API.Delete",
|
|
1265
|
+
tags: ["Other"],
|
|
1266
|
+
sourceFile: "domains/marketplace.json",
|
|
1267
|
+
displayName: null,
|
|
1268
|
+
dangerLevel: "high",
|
|
1269
|
+
sideEffects: {
|
|
1270
|
+
deletes: ["cminstance", "contained_resources"],
|
|
1271
|
+
},
|
|
1272
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1273
|
+
cliExamples: [
|
|
1274
|
+
{
|
|
1275
|
+
command: "f5xcctl config cminstance delete {name} --namespace {namespace}",
|
|
1276
|
+
description: "Delete cminstance",
|
|
1277
|
+
use_case: "delete",
|
|
1278
|
+
},
|
|
1279
|
+
],
|
|
1280
|
+
confirmationRequired: true,
|
|
1281
|
+
parameterExamples: {
|
|
1282
|
+
name: "Name",
|
|
1283
|
+
namespace: "Ns1",
|
|
1284
|
+
},
|
|
1285
|
+
validationRules: {},
|
|
1286
|
+
operationMetadata: {
|
|
1287
|
+
common_errors: [
|
|
1288
|
+
{
|
|
1289
|
+
code: 401,
|
|
1290
|
+
message: "Authentication required",
|
|
1291
|
+
solution: "Provide valid API credentials",
|
|
1292
|
+
},
|
|
1293
|
+
{
|
|
1294
|
+
code: 403,
|
|
1295
|
+
message: "Permission denied",
|
|
1296
|
+
solution: "Check access permissions for this operation",
|
|
1297
|
+
},
|
|
1298
|
+
{
|
|
1299
|
+
code: 404,
|
|
1300
|
+
message: "Resource not found",
|
|
1301
|
+
solution: "Verify resource name, namespace, and path",
|
|
1302
|
+
},
|
|
1303
|
+
{
|
|
1304
|
+
code: 409,
|
|
1305
|
+
message: "Resource already exists",
|
|
1306
|
+
solution: "Use different name or update existing resource",
|
|
1307
|
+
},
|
|
1308
|
+
{
|
|
1309
|
+
code: 429,
|
|
1310
|
+
message: "Rate limit exceeded",
|
|
1311
|
+
solution: "Wait before retrying the operation",
|
|
1312
|
+
},
|
|
1313
|
+
{
|
|
1314
|
+
code: 500,
|
|
1315
|
+
message: "Server error",
|
|
1316
|
+
solution: "Retry operation or contact support",
|
|
1317
|
+
},
|
|
1318
|
+
],
|
|
1319
|
+
conditions: {
|
|
1320
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1321
|
+
prerequisites: ["Active namespace"],
|
|
1322
|
+
},
|
|
1323
|
+
confirmation_required: true,
|
|
1324
|
+
danger_level: "high",
|
|
1325
|
+
examples: [
|
|
1326
|
+
{
|
|
1327
|
+
command: "f5xcctl config cminstance delete {name} --namespace {namespace}",
|
|
1328
|
+
description: "Delete cminstance",
|
|
1329
|
+
use_case: "delete",
|
|
1330
|
+
},
|
|
1331
|
+
],
|
|
1332
|
+
field_docs: {},
|
|
1333
|
+
optional_fields: [],
|
|
1334
|
+
performance_impact: {
|
|
1335
|
+
latency: "high",
|
|
1336
|
+
resource_usage: "moderate",
|
|
1337
|
+
},
|
|
1338
|
+
purpose: "Delete cminstance",
|
|
1339
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1340
|
+
side_effects: {
|
|
1341
|
+
deletes: ["cminstance", "contained_resources"],
|
|
1342
|
+
},
|
|
1343
|
+
},
|
|
1344
|
+
},
|
|
1345
|
+
{
|
|
1346
|
+
toolName: "f5xc-api-marketplace-cminstance-get",
|
|
1347
|
+
method: "GET",
|
|
1348
|
+
path: "/api/config/namespaces/{namespace}/cminstances/{name}",
|
|
1349
|
+
operation: "get",
|
|
1350
|
+
domain: "marketplace",
|
|
1351
|
+
resource: "cminstance",
|
|
1352
|
+
summary: "GET Central Manager Instance.",
|
|
1353
|
+
description: "GET CMInstance will read the configuration from namespace metadata.namespace.",
|
|
1354
|
+
pathParameters: [
|
|
1355
|
+
{
|
|
1356
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1357
|
+
in: "path",
|
|
1358
|
+
name: "name",
|
|
1359
|
+
required: true,
|
|
1360
|
+
schema: {
|
|
1361
|
+
type: "string",
|
|
1362
|
+
},
|
|
1363
|
+
"x-displayname": "Name",
|
|
1364
|
+
"x-ves-example": "Name",
|
|
1365
|
+
},
|
|
1366
|
+
{
|
|
1367
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1368
|
+
in: "path",
|
|
1369
|
+
name: "namespace",
|
|
1370
|
+
required: true,
|
|
1371
|
+
schema: {
|
|
1372
|
+
type: "string",
|
|
1373
|
+
},
|
|
1374
|
+
"x-displayname": "Namespace",
|
|
1375
|
+
"x-ves-example": "Ns1",
|
|
1376
|
+
},
|
|
1377
|
+
],
|
|
1378
|
+
queryParameters: [
|
|
1379
|
+
{
|
|
1380
|
+
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.",
|
|
1381
|
+
in: "query",
|
|
1382
|
+
name: "response_format",
|
|
1383
|
+
required: false,
|
|
1384
|
+
schema: {
|
|
1385
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1386
|
+
enum: [
|
|
1387
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1388
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1389
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1390
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1391
|
+
"GET_RSP_FORMAT_READ",
|
|
1392
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1393
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1394
|
+
],
|
|
1395
|
+
type: "string",
|
|
1396
|
+
},
|
|
1397
|
+
"x-displayname": "Broken Referred Objects.",
|
|
1398
|
+
},
|
|
1399
|
+
],
|
|
1400
|
+
requestBodySchema: null,
|
|
1401
|
+
responseSchema: {
|
|
1402
|
+
$ref: "#/components/schemas/cminstanceGetResponse",
|
|
1403
|
+
},
|
|
1404
|
+
requiredParams: ["name", "namespace"],
|
|
1405
|
+
operationId: "ves.io.schema.cminstance.API.Get",
|
|
1406
|
+
tags: ["Other"],
|
|
1407
|
+
sourceFile: "domains/marketplace.json",
|
|
1408
|
+
displayName: null,
|
|
1409
|
+
dangerLevel: "low",
|
|
1410
|
+
sideEffects: null,
|
|
1411
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1412
|
+
cliExamples: [
|
|
1413
|
+
{
|
|
1414
|
+
command: "f5xcctl config cminstance get {name} --namespace {namespace}",
|
|
1415
|
+
description: "Get specific cminstance",
|
|
1416
|
+
use_case: "get_specific",
|
|
1417
|
+
},
|
|
1418
|
+
],
|
|
1419
|
+
confirmationRequired: false,
|
|
1420
|
+
parameterExamples: {
|
|
1421
|
+
name: "Name",
|
|
1422
|
+
namespace: "Ns1",
|
|
1423
|
+
},
|
|
1424
|
+
validationRules: {},
|
|
1425
|
+
operationMetadata: {
|
|
1426
|
+
common_errors: [
|
|
1427
|
+
{
|
|
1428
|
+
code: 401,
|
|
1429
|
+
message: "Authentication required",
|
|
1430
|
+
solution: "Provide valid API credentials",
|
|
1431
|
+
},
|
|
1432
|
+
{
|
|
1433
|
+
code: 403,
|
|
1434
|
+
message: "Permission denied",
|
|
1435
|
+
solution: "Check access permissions for this operation",
|
|
1436
|
+
},
|
|
1437
|
+
{
|
|
1438
|
+
code: 404,
|
|
1439
|
+
message: "Resource not found",
|
|
1440
|
+
solution: "Verify resource name, namespace, and path",
|
|
1441
|
+
},
|
|
1442
|
+
{
|
|
1443
|
+
code: 409,
|
|
1444
|
+
message: "Resource already exists",
|
|
1445
|
+
solution: "Use different name or update existing resource",
|
|
1446
|
+
},
|
|
1447
|
+
{
|
|
1448
|
+
code: 429,
|
|
1449
|
+
message: "Rate limit exceeded",
|
|
1450
|
+
solution: "Wait before retrying the operation",
|
|
1451
|
+
},
|
|
1452
|
+
{
|
|
1453
|
+
code: 500,
|
|
1454
|
+
message: "Server error",
|
|
1455
|
+
solution: "Retry operation or contact support",
|
|
1456
|
+
},
|
|
1457
|
+
],
|
|
1458
|
+
conditions: {
|
|
1459
|
+
postconditions: [],
|
|
1460
|
+
prerequisites: ["Active namespace"],
|
|
1461
|
+
},
|
|
1462
|
+
confirmation_required: false,
|
|
1463
|
+
danger_level: "low",
|
|
1464
|
+
examples: [
|
|
1465
|
+
{
|
|
1466
|
+
command: "f5xcctl config cminstance get {name} --namespace {namespace}",
|
|
1467
|
+
description: "Get specific cminstance",
|
|
1468
|
+
use_case: "get_specific",
|
|
1469
|
+
},
|
|
1470
|
+
],
|
|
1471
|
+
field_docs: {},
|
|
1472
|
+
optional_fields: [],
|
|
1473
|
+
performance_impact: {
|
|
1474
|
+
latency: "low",
|
|
1475
|
+
resource_usage: "low",
|
|
1476
|
+
},
|
|
1477
|
+
purpose: "Retrieve specific cminstance",
|
|
1478
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1479
|
+
side_effects: {},
|
|
1480
|
+
},
|
|
1481
|
+
},
|
|
1482
|
+
{
|
|
1483
|
+
toolName: "f5xc-api-marketplace-cminstance-list",
|
|
1484
|
+
method: "GET",
|
|
1485
|
+
path: "/api/config/namespaces/{namespace}/cminstances",
|
|
1486
|
+
operation: "list",
|
|
1487
|
+
domain: "marketplace",
|
|
1488
|
+
resource: "cminstance",
|
|
1489
|
+
summary: "List Central Manager Instance.",
|
|
1490
|
+
description: "List the set of cminstance in a namespace.",
|
|
1491
|
+
pathParameters: [
|
|
1492
|
+
{
|
|
1493
|
+
description: "Namespace\nNamespace to scope the listing of cminstance.",
|
|
1494
|
+
in: "path",
|
|
1495
|
+
name: "namespace",
|
|
1496
|
+
required: true,
|
|
1497
|
+
schema: {
|
|
1498
|
+
type: "string",
|
|
1499
|
+
},
|
|
1500
|
+
"x-displayname": "Namespace",
|
|
1501
|
+
"x-ves-example": "Ns1",
|
|
1502
|
+
},
|
|
1503
|
+
],
|
|
1504
|
+
queryParameters: [
|
|
1505
|
+
{
|
|
1506
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1507
|
+
in: "query",
|
|
1508
|
+
name: "label_filter",
|
|
1509
|
+
required: false,
|
|
1510
|
+
schema: {
|
|
1511
|
+
type: "string",
|
|
1512
|
+
},
|
|
1513
|
+
"x-displayname": "Label Filter.",
|
|
1514
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
1515
|
+
},
|
|
1516
|
+
{
|
|
1517
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1518
|
+
in: "query",
|
|
1519
|
+
name: "report_fields",
|
|
1520
|
+
required: false,
|
|
1521
|
+
schema: {
|
|
1522
|
+
items: {
|
|
1523
|
+
type: "string",
|
|
1524
|
+
},
|
|
1525
|
+
type: "array",
|
|
1526
|
+
},
|
|
1527
|
+
"x-displayname": "Report Fields.",
|
|
1528
|
+
},
|
|
1529
|
+
{
|
|
1530
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1531
|
+
in: "query",
|
|
1532
|
+
name: "report_status_fields",
|
|
1533
|
+
required: false,
|
|
1534
|
+
schema: {
|
|
1535
|
+
items: {
|
|
1536
|
+
type: "string",
|
|
1537
|
+
},
|
|
1538
|
+
type: "array",
|
|
1539
|
+
},
|
|
1540
|
+
"x-displayname": "Report Status Fields.",
|
|
1541
|
+
},
|
|
1542
|
+
],
|
|
1543
|
+
requestBodySchema: null,
|
|
1544
|
+
responseSchema: {
|
|
1545
|
+
$ref: "#/components/schemas/cminstanceListResponse",
|
|
1546
|
+
},
|
|
1547
|
+
requiredParams: ["namespace"],
|
|
1548
|
+
operationId: "ves.io.schema.cminstance.API.List",
|
|
1549
|
+
tags: ["Other"],
|
|
1550
|
+
sourceFile: "domains/marketplace.json",
|
|
1551
|
+
displayName: null,
|
|
1552
|
+
dangerLevel: "low",
|
|
1553
|
+
sideEffects: null,
|
|
1554
|
+
requiredFields: ["path.namespace"],
|
|
1555
|
+
cliExamples: [
|
|
1556
|
+
{
|
|
1557
|
+
command: "f5xcctl config cminstance list --namespace {namespace}",
|
|
1558
|
+
description: "List all cminstances",
|
|
1559
|
+
use_case: "list_all",
|
|
1560
|
+
},
|
|
1561
|
+
],
|
|
1562
|
+
confirmationRequired: false,
|
|
1563
|
+
parameterExamples: {
|
|
1564
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
1565
|
+
namespace: "Ns1",
|
|
1566
|
+
},
|
|
1567
|
+
validationRules: {},
|
|
1568
|
+
operationMetadata: {
|
|
1569
|
+
common_errors: [
|
|
1570
|
+
{
|
|
1571
|
+
code: 401,
|
|
1572
|
+
message: "Authentication required",
|
|
1573
|
+
solution: "Provide valid API credentials",
|
|
1574
|
+
},
|
|
1575
|
+
{
|
|
1576
|
+
code: 403,
|
|
1577
|
+
message: "Permission denied",
|
|
1578
|
+
solution: "Check access permissions for this operation",
|
|
1579
|
+
},
|
|
1580
|
+
{
|
|
1581
|
+
code: 404,
|
|
1582
|
+
message: "Resource not found",
|
|
1583
|
+
solution: "Verify resource name, namespace, and path",
|
|
1584
|
+
},
|
|
1585
|
+
{
|
|
1586
|
+
code: 409,
|
|
1587
|
+
message: "Resource already exists",
|
|
1588
|
+
solution: "Use different name or update existing resource",
|
|
1589
|
+
},
|
|
1590
|
+
{
|
|
1591
|
+
code: 429,
|
|
1592
|
+
message: "Rate limit exceeded",
|
|
1593
|
+
solution: "Wait before retrying the operation",
|
|
1594
|
+
},
|
|
1595
|
+
{
|
|
1596
|
+
code: 500,
|
|
1597
|
+
message: "Server error",
|
|
1598
|
+
solution: "Retry operation or contact support",
|
|
1599
|
+
},
|
|
1600
|
+
],
|
|
1601
|
+
conditions: {
|
|
1602
|
+
postconditions: [],
|
|
1603
|
+
prerequisites: ["Active namespace"],
|
|
1604
|
+
},
|
|
1605
|
+
confirmation_required: false,
|
|
1606
|
+
danger_level: "low",
|
|
1607
|
+
examples: [
|
|
1608
|
+
{
|
|
1609
|
+
command: "f5xcctl config cminstance list --namespace {namespace}",
|
|
1610
|
+
description: "List all cminstances",
|
|
1611
|
+
use_case: "list_all",
|
|
1612
|
+
},
|
|
1613
|
+
],
|
|
1614
|
+
field_docs: {},
|
|
1615
|
+
optional_fields: [],
|
|
1616
|
+
performance_impact: {
|
|
1617
|
+
latency: "moderate",
|
|
1618
|
+
resource_usage: "moderate",
|
|
1619
|
+
},
|
|
1620
|
+
purpose: "List all cminstances",
|
|
1621
|
+
required_fields: ["path.namespace"],
|
|
1622
|
+
side_effects: {},
|
|
1623
|
+
},
|
|
1624
|
+
},
|
|
1625
|
+
{
|
|
1626
|
+
toolName: "f5xc-api-marketplace-cminstance-update",
|
|
1627
|
+
method: "PUT",
|
|
1628
|
+
path: "/api/config/namespaces/{metadata.namespace}/cminstances/{metadata.name}",
|
|
1629
|
+
operation: "update",
|
|
1630
|
+
domain: "marketplace",
|
|
1631
|
+
resource: "cminstance",
|
|
1632
|
+
summary: "Replace Central Manager Instance.",
|
|
1633
|
+
description: "Update the configuration by replacing the existing spec with the provided one.\nFor read-then-write operations a resourceVersion mismatch will occur if the object was modified between the read and write.",
|
|
1634
|
+
pathParameters: [
|
|
1635
|
+
{
|
|
1636
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1637
|
+
in: "path",
|
|
1638
|
+
name: "metadata.name",
|
|
1639
|
+
required: true,
|
|
1640
|
+
schema: {
|
|
1641
|
+
type: "string",
|
|
1642
|
+
},
|
|
1643
|
+
"x-displayname": "Name",
|
|
1644
|
+
"x-ves-example": "Example-corp-web.",
|
|
1645
|
+
},
|
|
1646
|
+
{
|
|
1647
|
+
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 ""',
|
|
1648
|
+
in: "path",
|
|
1649
|
+
name: "metadata.namespace",
|
|
1650
|
+
required: true,
|
|
1651
|
+
schema: {
|
|
1652
|
+
type: "string",
|
|
1653
|
+
},
|
|
1654
|
+
"x-displayname": "Namespace",
|
|
1655
|
+
"x-ves-example": "Staging",
|
|
1656
|
+
},
|
|
1657
|
+
],
|
|
1658
|
+
queryParameters: [],
|
|
1659
|
+
requestBodySchema: {
|
|
1660
|
+
$ref: "#/components/schemas/cminstanceReplaceRequest",
|
|
1661
|
+
},
|
|
1662
|
+
responseSchema: {
|
|
1663
|
+
$ref: "#/components/schemas/cminstanceReplaceResponse",
|
|
1664
|
+
},
|
|
1665
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1666
|
+
operationId: "ves.io.schema.cminstance.API.Replace",
|
|
1667
|
+
tags: ["Other"],
|
|
1668
|
+
sourceFile: "domains/marketplace.json",
|
|
1669
|
+
displayName: null,
|
|
1670
|
+
dangerLevel: "medium",
|
|
1671
|
+
sideEffects: {
|
|
1672
|
+
modifies: ["cminstance"],
|
|
1673
|
+
},
|
|
1674
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1675
|
+
cliExamples: [
|
|
1676
|
+
{
|
|
1677
|
+
command: "f5xcctl config cminstance update {name} --namespace {namespace} -f {file}.yaml",
|
|
1678
|
+
description: "Update cminstance",
|
|
1679
|
+
use_case: "update",
|
|
1680
|
+
},
|
|
1681
|
+
],
|
|
1682
|
+
confirmationRequired: false,
|
|
1683
|
+
parameterExamples: {
|
|
1684
|
+
"metadata.name": "Example-corp-web.",
|
|
1685
|
+
"metadata.namespace": "Staging",
|
|
1686
|
+
},
|
|
1687
|
+
validationRules: {},
|
|
1688
|
+
operationMetadata: {
|
|
1689
|
+
common_errors: [
|
|
1690
|
+
{
|
|
1691
|
+
code: 401,
|
|
1692
|
+
message: "Authentication required",
|
|
1693
|
+
solution: "Provide valid API credentials",
|
|
1694
|
+
},
|
|
1695
|
+
{
|
|
1696
|
+
code: 403,
|
|
1697
|
+
message: "Permission denied",
|
|
1698
|
+
solution: "Check access permissions for this operation",
|
|
1699
|
+
},
|
|
1700
|
+
{
|
|
1701
|
+
code: 404,
|
|
1702
|
+
message: "Resource not found",
|
|
1703
|
+
solution: "Verify resource name, namespace, and path",
|
|
1704
|
+
},
|
|
1705
|
+
{
|
|
1706
|
+
code: 409,
|
|
1707
|
+
message: "Resource already exists",
|
|
1708
|
+
solution: "Use different name or update existing resource",
|
|
1709
|
+
},
|
|
1710
|
+
{
|
|
1711
|
+
code: 429,
|
|
1712
|
+
message: "Rate limit exceeded",
|
|
1713
|
+
solution: "Wait before retrying the operation",
|
|
1714
|
+
},
|
|
1715
|
+
{
|
|
1716
|
+
code: 500,
|
|
1717
|
+
message: "Server error",
|
|
1718
|
+
solution: "Retry operation or contact support",
|
|
1719
|
+
},
|
|
1720
|
+
],
|
|
1721
|
+
conditions: {
|
|
1722
|
+
postconditions: ["Resource updated with new values"],
|
|
1723
|
+
prerequisites: ["Active namespace"],
|
|
1724
|
+
},
|
|
1725
|
+
confirmation_required: false,
|
|
1726
|
+
danger_level: "medium",
|
|
1727
|
+
examples: [
|
|
1728
|
+
{
|
|
1729
|
+
command: "f5xcctl config cminstance update {name} --namespace {namespace} -f {file}.yaml",
|
|
1730
|
+
description: "Update cminstance",
|
|
1731
|
+
use_case: "update",
|
|
1732
|
+
},
|
|
1733
|
+
],
|
|
1734
|
+
field_docs: {},
|
|
1735
|
+
optional_fields: [],
|
|
1736
|
+
performance_impact: {
|
|
1737
|
+
latency: "low",
|
|
1738
|
+
resource_usage: "low",
|
|
1739
|
+
},
|
|
1740
|
+
purpose: "Replace existing cminstance",
|
|
1741
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
1742
|
+
side_effects: {
|
|
1743
|
+
modifies: ["cminstance"],
|
|
1744
|
+
},
|
|
1745
|
+
},
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
toolName: "f5xc-api-marketplace-external-connector-create",
|
|
1749
|
+
method: "POST",
|
|
1750
|
+
path: "/api/config/namespaces/{metadata.namespace}/external_connectors",
|
|
1751
|
+
operation: "create",
|
|
1752
|
+
domain: "marketplace",
|
|
1753
|
+
resource: "external-connector",
|
|
1754
|
+
summary: "Create external_connector configuration.",
|
|
1755
|
+
description: "Shape of the external_connector configuration specification.",
|
|
1756
|
+
pathParameters: [
|
|
1757
|
+
{
|
|
1758
|
+
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 ""',
|
|
1759
|
+
in: "path",
|
|
1760
|
+
name: "metadata.namespace",
|
|
1761
|
+
required: true,
|
|
1762
|
+
schema: {
|
|
1763
|
+
type: "string",
|
|
1764
|
+
},
|
|
1765
|
+
"x-displayname": "Namespace",
|
|
1766
|
+
"x-ves-example": "Staging",
|
|
1767
|
+
},
|
|
1768
|
+
],
|
|
1769
|
+
queryParameters: [],
|
|
1770
|
+
requestBodySchema: {
|
|
1771
|
+
$ref: "#/components/schemas/external_connectorCreateRequest",
|
|
1772
|
+
},
|
|
1773
|
+
responseSchema: {
|
|
1774
|
+
$ref: "#/components/schemas/external_connectorCreateResponse",
|
|
1775
|
+
},
|
|
1776
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1777
|
+
operationId: "ves.io.schema.views.external_connector.API.Create",
|
|
1778
|
+
tags: ["Other"],
|
|
1779
|
+
sourceFile: "domains/marketplace.json",
|
|
1780
|
+
displayName: null,
|
|
1781
|
+
dangerLevel: "medium",
|
|
1782
|
+
sideEffects: {
|
|
1783
|
+
creates: ["external-connector"],
|
|
1784
|
+
},
|
|
1785
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1786
|
+
cliExamples: [
|
|
1787
|
+
{
|
|
1788
|
+
command: "f5xcctl config external-connector create {name} --namespace {namespace}",
|
|
1789
|
+
description: "Create external-connector",
|
|
1790
|
+
use_case: "basic_create",
|
|
1791
|
+
},
|
|
1792
|
+
{
|
|
1793
|
+
command: "f5xcctl config external-connector create -f {file}.yaml",
|
|
1794
|
+
description: "Create from YAML file",
|
|
1795
|
+
use_case: "file_based",
|
|
1796
|
+
},
|
|
1797
|
+
],
|
|
1798
|
+
confirmationRequired: false,
|
|
1799
|
+
parameterExamples: {
|
|
1800
|
+
"metadata.namespace": "Staging",
|
|
1801
|
+
},
|
|
1802
|
+
validationRules: {},
|
|
1803
|
+
operationMetadata: {
|
|
1804
|
+
common_errors: [
|
|
1805
|
+
{
|
|
1806
|
+
code: 401,
|
|
1807
|
+
message: "Authentication required",
|
|
1808
|
+
solution: "Provide valid API credentials",
|
|
1809
|
+
},
|
|
1810
|
+
{
|
|
1811
|
+
code: 403,
|
|
1812
|
+
message: "Permission denied",
|
|
1813
|
+
solution: "Check access permissions for this operation",
|
|
1814
|
+
},
|
|
1815
|
+
{
|
|
1816
|
+
code: 404,
|
|
1817
|
+
message: "Resource not found",
|
|
1818
|
+
solution: "Verify resource name, namespace, and path",
|
|
1819
|
+
},
|
|
1820
|
+
{
|
|
1821
|
+
code: 409,
|
|
1822
|
+
message: "Resource already exists",
|
|
1823
|
+
solution: "Use different name or update existing resource",
|
|
1824
|
+
},
|
|
1825
|
+
{
|
|
1826
|
+
code: 429,
|
|
1827
|
+
message: "Rate limit exceeded",
|
|
1828
|
+
solution: "Wait before retrying the operation",
|
|
1829
|
+
},
|
|
1830
|
+
{
|
|
1831
|
+
code: 500,
|
|
1832
|
+
message: "Server error",
|
|
1833
|
+
solution: "Retry operation or contact support",
|
|
1834
|
+
},
|
|
1835
|
+
],
|
|
1836
|
+
conditions: {
|
|
1837
|
+
postconditions: [
|
|
1838
|
+
"External-connector resource created",
|
|
1839
|
+
"Resource assigned unique identifier",
|
|
1840
|
+
],
|
|
1841
|
+
prerequisites: ["Active namespace"],
|
|
1842
|
+
},
|
|
1843
|
+
confirmation_required: false,
|
|
1844
|
+
danger_level: "medium",
|
|
1845
|
+
examples: [
|
|
1846
|
+
{
|
|
1847
|
+
command: "f5xcctl config external-connector create {name} --namespace {namespace}",
|
|
1848
|
+
description: "Create external-connector",
|
|
1849
|
+
use_case: "basic_create",
|
|
1850
|
+
},
|
|
1851
|
+
{
|
|
1852
|
+
command: "f5xcctl config external-connector create -f {file}.yaml",
|
|
1853
|
+
description: "Create from YAML file",
|
|
1854
|
+
use_case: "file_based",
|
|
1855
|
+
},
|
|
1856
|
+
],
|
|
1857
|
+
field_docs: {},
|
|
1858
|
+
optional_fields: [],
|
|
1859
|
+
performance_impact: {
|
|
1860
|
+
latency: "low",
|
|
1861
|
+
resource_usage: "low",
|
|
1862
|
+
},
|
|
1863
|
+
purpose: "Create new external-connector",
|
|
1864
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
|
|
1865
|
+
side_effects: {
|
|
1866
|
+
creates: ["external-connector"],
|
|
1867
|
+
},
|
|
1868
|
+
},
|
|
1869
|
+
},
|
|
1870
|
+
{
|
|
1871
|
+
toolName: "f5xc-api-marketplace-external-connector-delete",
|
|
1872
|
+
method: "DELETE",
|
|
1873
|
+
path: "/api/config/namespaces/{namespace}/external_connectors/{name}",
|
|
1874
|
+
operation: "delete",
|
|
1875
|
+
domain: "marketplace",
|
|
1876
|
+
resource: "external-connector",
|
|
1877
|
+
summary: "DELETE External Connector Configuration.",
|
|
1878
|
+
description: "DELETE the specified external_connector.",
|
|
1879
|
+
pathParameters: [
|
|
1880
|
+
{
|
|
1881
|
+
description: "Name\nName of the configuration object.",
|
|
1882
|
+
in: "path",
|
|
1883
|
+
name: "name",
|
|
1884
|
+
required: true,
|
|
1885
|
+
schema: {
|
|
1886
|
+
type: "string",
|
|
1887
|
+
},
|
|
1888
|
+
"x-displayname": "Name",
|
|
1889
|
+
"x-ves-example": "Name",
|
|
1890
|
+
},
|
|
1891
|
+
{
|
|
1892
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1893
|
+
in: "path",
|
|
1894
|
+
name: "namespace",
|
|
1895
|
+
required: true,
|
|
1896
|
+
schema: {
|
|
1897
|
+
type: "string",
|
|
1898
|
+
},
|
|
1899
|
+
"x-displayname": "Namespace",
|
|
1900
|
+
"x-ves-example": "Ns1",
|
|
1901
|
+
},
|
|
1902
|
+
],
|
|
1903
|
+
queryParameters: [],
|
|
1904
|
+
requestBodySchema: {
|
|
1905
|
+
$ref: "#/components/schemas/external_connectorDeleteRequest",
|
|
1906
|
+
},
|
|
1907
|
+
responseSchema: {},
|
|
1908
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1909
|
+
operationId: "ves.io.schema.views.external_connector.API.Delete",
|
|
1910
|
+
tags: ["Other"],
|
|
1911
|
+
sourceFile: "domains/marketplace.json",
|
|
1912
|
+
displayName: null,
|
|
1913
|
+
dangerLevel: "high",
|
|
1914
|
+
sideEffects: {
|
|
1915
|
+
deletes: ["external-connector", "contained_resources"],
|
|
1916
|
+
},
|
|
1917
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
1918
|
+
cliExamples: [
|
|
1919
|
+
{
|
|
1920
|
+
command: "f5xcctl config external-connector delete {name} --namespace {namespace}",
|
|
1921
|
+
description: "Delete external-connector",
|
|
1922
|
+
use_case: "delete",
|
|
1923
|
+
},
|
|
1924
|
+
],
|
|
1925
|
+
confirmationRequired: true,
|
|
1926
|
+
parameterExamples: {
|
|
1927
|
+
name: "Name",
|
|
1928
|
+
namespace: "Ns1",
|
|
1929
|
+
},
|
|
1930
|
+
validationRules: {},
|
|
1931
|
+
operationMetadata: {
|
|
1932
|
+
common_errors: [
|
|
1933
|
+
{
|
|
1934
|
+
code: 401,
|
|
1935
|
+
message: "Authentication required",
|
|
1936
|
+
solution: "Provide valid API credentials",
|
|
1937
|
+
},
|
|
1938
|
+
{
|
|
1939
|
+
code: 403,
|
|
1940
|
+
message: "Permission denied",
|
|
1941
|
+
solution: "Check access permissions for this operation",
|
|
1942
|
+
},
|
|
1943
|
+
{
|
|
1944
|
+
code: 404,
|
|
1945
|
+
message: "Resource not found",
|
|
1946
|
+
solution: "Verify resource name, namespace, and path",
|
|
1947
|
+
},
|
|
1948
|
+
{
|
|
1949
|
+
code: 409,
|
|
1950
|
+
message: "Resource already exists",
|
|
1951
|
+
solution: "Use different name or update existing resource",
|
|
1952
|
+
},
|
|
1953
|
+
{
|
|
1954
|
+
code: 429,
|
|
1955
|
+
message: "Rate limit exceeded",
|
|
1956
|
+
solution: "Wait before retrying the operation",
|
|
1957
|
+
},
|
|
1958
|
+
{
|
|
1959
|
+
code: 500,
|
|
1960
|
+
message: "Server error",
|
|
1961
|
+
solution: "Retry operation or contact support",
|
|
1962
|
+
},
|
|
1963
|
+
],
|
|
1964
|
+
conditions: {
|
|
1965
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
1966
|
+
prerequisites: ["Active namespace"],
|
|
1967
|
+
},
|
|
1968
|
+
confirmation_required: true,
|
|
1969
|
+
danger_level: "high",
|
|
1970
|
+
examples: [
|
|
1971
|
+
{
|
|
1972
|
+
command: "f5xcctl config external-connector delete {name} --namespace {namespace}",
|
|
1973
|
+
description: "Delete external-connector",
|
|
1974
|
+
use_case: "delete",
|
|
1975
|
+
},
|
|
1976
|
+
],
|
|
1977
|
+
field_docs: {},
|
|
1978
|
+
optional_fields: [],
|
|
1979
|
+
performance_impact: {
|
|
1980
|
+
latency: "high",
|
|
1981
|
+
resource_usage: "moderate",
|
|
1982
|
+
},
|
|
1983
|
+
purpose: "Delete external-connector",
|
|
1984
|
+
required_fields: ["path.name", "path.namespace"],
|
|
1985
|
+
side_effects: {
|
|
1986
|
+
deletes: ["external-connector", "contained_resources"],
|
|
1987
|
+
},
|
|
1988
|
+
},
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
toolName: "f5xc-api-marketplace-external-connector-get",
|
|
1992
|
+
method: "GET",
|
|
1993
|
+
path: "/api/config/namespaces/{namespace}/external_connectors/{name}",
|
|
1994
|
+
operation: "get",
|
|
1995
|
+
domain: "marketplace",
|
|
1996
|
+
resource: "external-connector",
|
|
1997
|
+
summary: "GET external_connector configuration.",
|
|
1998
|
+
description: "Shape of the external_connector configuration specification.",
|
|
1999
|
+
pathParameters: [
|
|
2000
|
+
{
|
|
2001
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2002
|
+
in: "path",
|
|
2003
|
+
name: "name",
|
|
2004
|
+
required: true,
|
|
2005
|
+
schema: {
|
|
2006
|
+
type: "string",
|
|
2007
|
+
},
|
|
2008
|
+
"x-displayname": "Name",
|
|
2009
|
+
"x-ves-example": "Name",
|
|
2010
|
+
},
|
|
2011
|
+
{
|
|
2012
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2013
|
+
in: "path",
|
|
2014
|
+
name: "namespace",
|
|
2015
|
+
required: true,
|
|
2016
|
+
schema: {
|
|
2017
|
+
type: "string",
|
|
2018
|
+
},
|
|
2019
|
+
"x-displayname": "Namespace",
|
|
2020
|
+
"x-ves-example": "Ns1",
|
|
2021
|
+
},
|
|
2022
|
+
],
|
|
2023
|
+
queryParameters: [
|
|
2024
|
+
{
|
|
2025
|
+
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.",
|
|
2026
|
+
in: "query",
|
|
2027
|
+
name: "response_format",
|
|
2028
|
+
required: false,
|
|
2029
|
+
schema: {
|
|
2030
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2031
|
+
enum: [
|
|
2032
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2033
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
2034
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
2035
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2036
|
+
"GET_RSP_FORMAT_READ",
|
|
2037
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2038
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2039
|
+
],
|
|
2040
|
+
type: "string",
|
|
2041
|
+
},
|
|
2042
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2043
|
+
},
|
|
2044
|
+
],
|
|
2045
|
+
requestBodySchema: null,
|
|
2046
|
+
responseSchema: {
|
|
2047
|
+
$ref: "#/components/schemas/external_connectorGetResponse",
|
|
2048
|
+
},
|
|
2049
|
+
requiredParams: ["name", "namespace"],
|
|
2050
|
+
operationId: "ves.io.schema.views.external_connector.API.Get",
|
|
2051
|
+
tags: ["Other"],
|
|
2052
|
+
sourceFile: "domains/marketplace.json",
|
|
2053
|
+
displayName: null,
|
|
2054
|
+
dangerLevel: "low",
|
|
2055
|
+
sideEffects: null,
|
|
2056
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2057
|
+
cliExamples: [
|
|
2058
|
+
{
|
|
2059
|
+
command: "f5xcctl config external-connector get {name} --namespace {namespace}",
|
|
2060
|
+
description: "Get specific external-connector",
|
|
2061
|
+
use_case: "get_specific",
|
|
2062
|
+
},
|
|
2063
|
+
],
|
|
2064
|
+
confirmationRequired: false,
|
|
2065
|
+
parameterExamples: {
|
|
2066
|
+
name: "Name",
|
|
2067
|
+
namespace: "Ns1",
|
|
2068
|
+
},
|
|
2069
|
+
validationRules: {},
|
|
2070
|
+
operationMetadata: {
|
|
2071
|
+
common_errors: [
|
|
2072
|
+
{
|
|
2073
|
+
code: 401,
|
|
2074
|
+
message: "Authentication required",
|
|
2075
|
+
solution: "Provide valid API credentials",
|
|
2076
|
+
},
|
|
2077
|
+
{
|
|
2078
|
+
code: 403,
|
|
2079
|
+
message: "Permission denied",
|
|
2080
|
+
solution: "Check access permissions for this operation",
|
|
2081
|
+
},
|
|
2082
|
+
{
|
|
2083
|
+
code: 404,
|
|
2084
|
+
message: "Resource not found",
|
|
2085
|
+
solution: "Verify resource name, namespace, and path",
|
|
2086
|
+
},
|
|
2087
|
+
{
|
|
2088
|
+
code: 409,
|
|
2089
|
+
message: "Resource already exists",
|
|
2090
|
+
solution: "Use different name or update existing resource",
|
|
2091
|
+
},
|
|
2092
|
+
{
|
|
2093
|
+
code: 429,
|
|
2094
|
+
message: "Rate limit exceeded",
|
|
2095
|
+
solution: "Wait before retrying the operation",
|
|
2096
|
+
},
|
|
2097
|
+
{
|
|
2098
|
+
code: 500,
|
|
2099
|
+
message: "Server error",
|
|
2100
|
+
solution: "Retry operation or contact support",
|
|
2101
|
+
},
|
|
2102
|
+
],
|
|
2103
|
+
conditions: {
|
|
2104
|
+
postconditions: [],
|
|
2105
|
+
prerequisites: ["Active namespace"],
|
|
2106
|
+
},
|
|
2107
|
+
confirmation_required: false,
|
|
2108
|
+
danger_level: "low",
|
|
2109
|
+
examples: [
|
|
2110
|
+
{
|
|
2111
|
+
command: "f5xcctl config external-connector get {name} --namespace {namespace}",
|
|
2112
|
+
description: "Get specific external-connector",
|
|
2113
|
+
use_case: "get_specific",
|
|
2114
|
+
},
|
|
2115
|
+
],
|
|
2116
|
+
field_docs: {},
|
|
2117
|
+
optional_fields: [],
|
|
2118
|
+
performance_impact: {
|
|
2119
|
+
latency: "low",
|
|
2120
|
+
resource_usage: "low",
|
|
2121
|
+
},
|
|
2122
|
+
purpose: "Retrieve specific external-connector",
|
|
2123
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2124
|
+
side_effects: {},
|
|
2125
|
+
},
|
|
2126
|
+
},
|
|
2127
|
+
{
|
|
2128
|
+
toolName: "f5xc-api-marketplace-external-connector-list",
|
|
2129
|
+
method: "GET",
|
|
2130
|
+
path: "/api/config/namespaces/{namespace}/external_connectors",
|
|
2131
|
+
operation: "list",
|
|
2132
|
+
domain: "marketplace",
|
|
2133
|
+
resource: "external-connector",
|
|
2134
|
+
summary: "List External Connector Configuration.",
|
|
2135
|
+
description: "List the set of external_connector in a namespace.",
|
|
2136
|
+
pathParameters: [
|
|
2137
|
+
{
|
|
2138
|
+
description: "Namespace\nNamespace to scope the listing of external_connector.",
|
|
2139
|
+
in: "path",
|
|
2140
|
+
name: "namespace",
|
|
2141
|
+
required: true,
|
|
2142
|
+
schema: {
|
|
2143
|
+
type: "string",
|
|
2144
|
+
},
|
|
2145
|
+
"x-displayname": "Namespace",
|
|
2146
|
+
"x-ves-example": "Ns1",
|
|
2147
|
+
},
|
|
2148
|
+
],
|
|
2149
|
+
queryParameters: [
|
|
2150
|
+
{
|
|
2151
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2152
|
+
in: "query",
|
|
2153
|
+
name: "label_filter",
|
|
2154
|
+
required: false,
|
|
2155
|
+
schema: {
|
|
2156
|
+
type: "string",
|
|
2157
|
+
},
|
|
2158
|
+
"x-displayname": "Label Filter.",
|
|
2159
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2163
|
+
in: "query",
|
|
2164
|
+
name: "report_fields",
|
|
2165
|
+
required: false,
|
|
2166
|
+
schema: {
|
|
2167
|
+
items: {
|
|
2168
|
+
type: "string",
|
|
2169
|
+
},
|
|
2170
|
+
type: "array",
|
|
2171
|
+
},
|
|
2172
|
+
"x-displayname": "Report Fields.",
|
|
2173
|
+
},
|
|
2174
|
+
{
|
|
2175
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2176
|
+
in: "query",
|
|
2177
|
+
name: "report_status_fields",
|
|
2178
|
+
required: false,
|
|
2179
|
+
schema: {
|
|
2180
|
+
items: {
|
|
2181
|
+
type: "string",
|
|
2182
|
+
},
|
|
2183
|
+
type: "array",
|
|
2184
|
+
},
|
|
2185
|
+
"x-displayname": "Report Status Fields.",
|
|
2186
|
+
},
|
|
2187
|
+
],
|
|
2188
|
+
requestBodySchema: null,
|
|
2189
|
+
responseSchema: {
|
|
2190
|
+
$ref: "#/components/schemas/external_connectorListResponse",
|
|
2191
|
+
},
|
|
2192
|
+
requiredParams: ["namespace"],
|
|
2193
|
+
operationId: "ves.io.schema.views.external_connector.API.List",
|
|
2194
|
+
tags: ["Other"],
|
|
2195
|
+
sourceFile: "domains/marketplace.json",
|
|
2196
|
+
displayName: null,
|
|
2197
|
+
dangerLevel: "low",
|
|
2198
|
+
sideEffects: null,
|
|
2199
|
+
requiredFields: ["path.namespace"],
|
|
2200
|
+
cliExamples: [
|
|
2201
|
+
{
|
|
2202
|
+
command: "f5xcctl config external-connector list --namespace {namespace}",
|
|
2203
|
+
description: "List all external-connectors",
|
|
2204
|
+
use_case: "list_all",
|
|
2205
|
+
},
|
|
2206
|
+
],
|
|
2207
|
+
confirmationRequired: false,
|
|
2208
|
+
parameterExamples: {
|
|
2209
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
2210
|
+
namespace: "Ns1",
|
|
2211
|
+
},
|
|
2212
|
+
validationRules: {},
|
|
2213
|
+
operationMetadata: {
|
|
2214
|
+
common_errors: [
|
|
2215
|
+
{
|
|
2216
|
+
code: 401,
|
|
2217
|
+
message: "Authentication required",
|
|
2218
|
+
solution: "Provide valid API credentials",
|
|
2219
|
+
},
|
|
2220
|
+
{
|
|
2221
|
+
code: 403,
|
|
2222
|
+
message: "Permission denied",
|
|
2223
|
+
solution: "Check access permissions for this operation",
|
|
2224
|
+
},
|
|
2225
|
+
{
|
|
2226
|
+
code: 404,
|
|
2227
|
+
message: "Resource not found",
|
|
2228
|
+
solution: "Verify resource name, namespace, and path",
|
|
2229
|
+
},
|
|
2230
|
+
{
|
|
2231
|
+
code: 409,
|
|
2232
|
+
message: "Resource already exists",
|
|
2233
|
+
solution: "Use different name or update existing resource",
|
|
2234
|
+
},
|
|
2235
|
+
{
|
|
2236
|
+
code: 429,
|
|
2237
|
+
message: "Rate limit exceeded",
|
|
2238
|
+
solution: "Wait before retrying the operation",
|
|
2239
|
+
},
|
|
2240
|
+
{
|
|
2241
|
+
code: 500,
|
|
2242
|
+
message: "Server error",
|
|
2243
|
+
solution: "Retry operation or contact support",
|
|
2244
|
+
},
|
|
2245
|
+
],
|
|
2246
|
+
conditions: {
|
|
2247
|
+
postconditions: [],
|
|
2248
|
+
prerequisites: ["Active namespace"],
|
|
2249
|
+
},
|
|
2250
|
+
confirmation_required: false,
|
|
2251
|
+
danger_level: "low",
|
|
2252
|
+
examples: [
|
|
2253
|
+
{
|
|
2254
|
+
command: "f5xcctl config external-connector list --namespace {namespace}",
|
|
2255
|
+
description: "List all external-connectors",
|
|
2256
|
+
use_case: "list_all",
|
|
2257
|
+
},
|
|
2258
|
+
],
|
|
2259
|
+
field_docs: {},
|
|
2260
|
+
optional_fields: [],
|
|
2261
|
+
performance_impact: {
|
|
2262
|
+
latency: "moderate",
|
|
2263
|
+
resource_usage: "moderate",
|
|
2264
|
+
},
|
|
2265
|
+
purpose: "List all external-connectors",
|
|
2266
|
+
required_fields: ["path.namespace"],
|
|
2267
|
+
side_effects: {},
|
|
2268
|
+
},
|
|
2269
|
+
},
|
|
2270
|
+
{
|
|
2271
|
+
toolName: "f5xc-api-marketplace-external-connector-update",
|
|
2272
|
+
method: "PUT",
|
|
2273
|
+
path: "/api/config/namespaces/{metadata.namespace}/external_connectors/{metadata.name}",
|
|
2274
|
+
operation: "update",
|
|
2275
|
+
domain: "marketplace",
|
|
2276
|
+
resource: "external-connector",
|
|
2277
|
+
summary: "Replace external_connector configuration.",
|
|
2278
|
+
description: "Shape of the external_connector configuration specification.",
|
|
2279
|
+
pathParameters: [
|
|
2280
|
+
{
|
|
2281
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
2282
|
+
in: "path",
|
|
2283
|
+
name: "metadata.name",
|
|
2284
|
+
required: true,
|
|
2285
|
+
schema: {
|
|
2286
|
+
type: "string",
|
|
2287
|
+
},
|
|
2288
|
+
"x-displayname": "Name",
|
|
2289
|
+
"x-ves-example": "Example-corp-web.",
|
|
2290
|
+
},
|
|
2291
|
+
{
|
|
2292
|
+
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 ""',
|
|
2293
|
+
in: "path",
|
|
2294
|
+
name: "metadata.namespace",
|
|
2295
|
+
required: true,
|
|
2296
|
+
schema: {
|
|
2297
|
+
type: "string",
|
|
2298
|
+
},
|
|
2299
|
+
"x-displayname": "Namespace",
|
|
2300
|
+
"x-ves-example": "Staging",
|
|
2301
|
+
},
|
|
2302
|
+
],
|
|
2303
|
+
queryParameters: [],
|
|
2304
|
+
requestBodySchema: {
|
|
2305
|
+
$ref: "#/components/schemas/external_connectorReplaceRequest",
|
|
2306
|
+
},
|
|
2307
|
+
responseSchema: {
|
|
2308
|
+
$ref: "#/components/schemas/external_connectorReplaceResponse",
|
|
2309
|
+
},
|
|
2310
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
2311
|
+
operationId: "ves.io.schema.views.external_connector.API.Replace",
|
|
2312
|
+
tags: ["Other"],
|
|
2313
|
+
sourceFile: "domains/marketplace.json",
|
|
2314
|
+
displayName: null,
|
|
2315
|
+
dangerLevel: "medium",
|
|
2316
|
+
sideEffects: {
|
|
2317
|
+
modifies: ["external-connector"],
|
|
2318
|
+
},
|
|
2319
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2320
|
+
cliExamples: [
|
|
2321
|
+
{
|
|
2322
|
+
command: "f5xcctl config external-connector update {name} --namespace {namespace} -f {file}.yaml",
|
|
2323
|
+
description: "Update external-connector",
|
|
2324
|
+
use_case: "update",
|
|
2325
|
+
},
|
|
2326
|
+
],
|
|
2327
|
+
confirmationRequired: false,
|
|
2328
|
+
parameterExamples: {
|
|
2329
|
+
"metadata.name": "Example-corp-web.",
|
|
2330
|
+
"metadata.namespace": "Staging",
|
|
2331
|
+
},
|
|
2332
|
+
validationRules: {},
|
|
2333
|
+
operationMetadata: {
|
|
2334
|
+
common_errors: [
|
|
2335
|
+
{
|
|
2336
|
+
code: 401,
|
|
2337
|
+
message: "Authentication required",
|
|
2338
|
+
solution: "Provide valid API credentials",
|
|
2339
|
+
},
|
|
2340
|
+
{
|
|
2341
|
+
code: 403,
|
|
2342
|
+
message: "Permission denied",
|
|
2343
|
+
solution: "Check access permissions for this operation",
|
|
2344
|
+
},
|
|
2345
|
+
{
|
|
2346
|
+
code: 404,
|
|
2347
|
+
message: "Resource not found",
|
|
2348
|
+
solution: "Verify resource name, namespace, and path",
|
|
2349
|
+
},
|
|
2350
|
+
{
|
|
2351
|
+
code: 409,
|
|
2352
|
+
message: "Resource already exists",
|
|
2353
|
+
solution: "Use different name or update existing resource",
|
|
2354
|
+
},
|
|
2355
|
+
{
|
|
2356
|
+
code: 429,
|
|
2357
|
+
message: "Rate limit exceeded",
|
|
2358
|
+
solution: "Wait before retrying the operation",
|
|
2359
|
+
},
|
|
2360
|
+
{
|
|
2361
|
+
code: 500,
|
|
2362
|
+
message: "Server error",
|
|
2363
|
+
solution: "Retry operation or contact support",
|
|
2364
|
+
},
|
|
2365
|
+
],
|
|
2366
|
+
conditions: {
|
|
2367
|
+
postconditions: ["Resource updated with new values"],
|
|
2368
|
+
prerequisites: ["Active namespace"],
|
|
2369
|
+
},
|
|
2370
|
+
confirmation_required: false,
|
|
2371
|
+
danger_level: "medium",
|
|
2372
|
+
examples: [
|
|
2373
|
+
{
|
|
2374
|
+
command: "f5xcctl config external-connector update {name} --namespace {namespace} -f {file}.yaml",
|
|
2375
|
+
description: "Update external-connector",
|
|
2376
|
+
use_case: "update",
|
|
2377
|
+
},
|
|
2378
|
+
],
|
|
2379
|
+
field_docs: {},
|
|
2380
|
+
optional_fields: [],
|
|
2381
|
+
performance_impact: {
|
|
2382
|
+
latency: "low",
|
|
2383
|
+
resource_usage: "low",
|
|
2384
|
+
},
|
|
2385
|
+
purpose: "Replace existing external-connector",
|
|
2386
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
2387
|
+
side_effects: {
|
|
2388
|
+
modifies: ["external-connector"],
|
|
2389
|
+
},
|
|
2390
|
+
},
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
toolName: "f5xc-api-marketplace-force-delete-create",
|
|
2394
|
+
method: "POST",
|
|
2395
|
+
path: "/api/terraform/namespaces/{namespace}/terraform/{view_kind}/{view_name}/force-delete",
|
|
2396
|
+
operation: "create",
|
|
2397
|
+
domain: "marketplace",
|
|
2398
|
+
resource: "force-delete",
|
|
2399
|
+
summary: "Force DELETE view.",
|
|
2400
|
+
description: "Force DELETE view object. This can result in staled objects in cloud provider.",
|
|
2401
|
+
pathParameters: [
|
|
2402
|
+
{
|
|
2403
|
+
description: "Namespace\nNamespace for the label to be retrieved.",
|
|
2404
|
+
in: "path",
|
|
2405
|
+
name: "namespace",
|
|
2406
|
+
required: true,
|
|
2407
|
+
schema: {
|
|
2408
|
+
type: "string",
|
|
2409
|
+
},
|
|
2410
|
+
"x-displayname": "Namespace",
|
|
2411
|
+
"x-ves-example": "Value",
|
|
2412
|
+
},
|
|
2413
|
+
{
|
|
2414
|
+
description: "Kind of View\nKind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
|
|
2415
|
+
in: "path",
|
|
2416
|
+
name: "view_kind",
|
|
2417
|
+
required: true,
|
|
2418
|
+
schema: {
|
|
2419
|
+
type: "string",
|
|
2420
|
+
},
|
|
2421
|
+
"x-displayname": "Kind of View.",
|
|
2422
|
+
"x-ves-example": "Value",
|
|
2423
|
+
},
|
|
2424
|
+
{
|
|
2425
|
+
description: "Name of view\nName of the view for which terraform parameters are requested.",
|
|
2426
|
+
in: "path",
|
|
2427
|
+
name: "view_name",
|
|
2428
|
+
required: true,
|
|
2429
|
+
schema: {
|
|
2430
|
+
type: "string",
|
|
2431
|
+
},
|
|
2432
|
+
"x-displayname": "Name of view.",
|
|
2433
|
+
"x-ves-example": "Value",
|
|
2434
|
+
},
|
|
2435
|
+
],
|
|
2436
|
+
queryParameters: [],
|
|
2437
|
+
requestBodySchema: {
|
|
2438
|
+
$ref: "#/components/schemas/terraform_parametersForceDeleteRequest",
|
|
2439
|
+
},
|
|
2440
|
+
responseSchema: {
|
|
2441
|
+
$ref: "#/components/schemas/terraform_parametersForceDeleteResponse",
|
|
2442
|
+
},
|
|
2443
|
+
requiredParams: ["body", "namespace", "view_kind", "view_name"],
|
|
2444
|
+
operationId: "ves.io.schema.views.terraform_parameters.CustomActionAPI.ForceDelete",
|
|
2445
|
+
tags: ["Other"],
|
|
2446
|
+
sourceFile: "domains/marketplace.json",
|
|
2447
|
+
displayName: null,
|
|
2448
|
+
dangerLevel: "medium",
|
|
2449
|
+
sideEffects: {
|
|
2450
|
+
creates: ["force-delete"],
|
|
2451
|
+
},
|
|
2452
|
+
requiredFields: [
|
|
2453
|
+
"metadata.name",
|
|
2454
|
+
"metadata.namespace",
|
|
2455
|
+
"path.namespace",
|
|
2456
|
+
"path.view_kind",
|
|
2457
|
+
"path.view_name",
|
|
2458
|
+
],
|
|
2459
|
+
cliExamples: [
|
|
2460
|
+
{
|
|
2461
|
+
command: "f5xcctl terraform force-delete create {name} --namespace {namespace}",
|
|
2462
|
+
description: "Create force-delete",
|
|
2463
|
+
use_case: "basic_create",
|
|
2464
|
+
},
|
|
2465
|
+
{
|
|
2466
|
+
command: "f5xcctl terraform force-delete create -f {file}.yaml",
|
|
2467
|
+
description: "Create from YAML file",
|
|
2468
|
+
use_case: "file_based",
|
|
2469
|
+
},
|
|
2470
|
+
],
|
|
2471
|
+
confirmationRequired: false,
|
|
2472
|
+
parameterExamples: {
|
|
2473
|
+
namespace: "Value",
|
|
2474
|
+
view_kind: "Value",
|
|
2475
|
+
view_name: "Value",
|
|
2476
|
+
},
|
|
2477
|
+
validationRules: {},
|
|
2478
|
+
operationMetadata: {
|
|
2479
|
+
common_errors: [
|
|
2480
|
+
{
|
|
2481
|
+
code: 401,
|
|
2482
|
+
message: "Authentication required",
|
|
2483
|
+
solution: "Provide valid API credentials",
|
|
2484
|
+
},
|
|
2485
|
+
{
|
|
2486
|
+
code: 403,
|
|
2487
|
+
message: "Permission denied",
|
|
2488
|
+
solution: "Check access permissions for this operation",
|
|
2489
|
+
},
|
|
2490
|
+
{
|
|
2491
|
+
code: 404,
|
|
2492
|
+
message: "Resource not found",
|
|
2493
|
+
solution: "Verify resource name, namespace, and path",
|
|
2494
|
+
},
|
|
2495
|
+
{
|
|
2496
|
+
code: 409,
|
|
2497
|
+
message: "Resource already exists",
|
|
2498
|
+
solution: "Use different name or update existing resource",
|
|
2499
|
+
},
|
|
2500
|
+
{
|
|
2501
|
+
code: 429,
|
|
2502
|
+
message: "Rate limit exceeded",
|
|
2503
|
+
solution: "Wait before retrying the operation",
|
|
2504
|
+
},
|
|
2505
|
+
{
|
|
2506
|
+
code: 500,
|
|
2507
|
+
message: "Server error",
|
|
2508
|
+
solution: "Retry operation or contact support",
|
|
2509
|
+
},
|
|
2510
|
+
],
|
|
2511
|
+
conditions: {
|
|
2512
|
+
postconditions: ["Force-delete resource created", "Resource assigned unique identifier"],
|
|
2513
|
+
prerequisites: ["Active namespace"],
|
|
2514
|
+
},
|
|
2515
|
+
confirmation_required: false,
|
|
2516
|
+
danger_level: "medium",
|
|
2517
|
+
examples: [
|
|
2518
|
+
{
|
|
2519
|
+
command: "f5xcctl terraform force-delete create {name} --namespace {namespace}",
|
|
2520
|
+
description: "Create force-delete",
|
|
2521
|
+
use_case: "basic_create",
|
|
2522
|
+
},
|
|
2523
|
+
{
|
|
2524
|
+
command: "f5xcctl terraform force-delete create -f {file}.yaml",
|
|
2525
|
+
description: "Create from YAML file",
|
|
2526
|
+
use_case: "file_based",
|
|
2527
|
+
},
|
|
2528
|
+
],
|
|
2529
|
+
field_docs: {},
|
|
2530
|
+
optional_fields: [],
|
|
2531
|
+
performance_impact: {
|
|
2532
|
+
latency: "low",
|
|
2533
|
+
resource_usage: "low",
|
|
2534
|
+
},
|
|
2535
|
+
purpose: "Create new force-delete",
|
|
2536
|
+
required_fields: [
|
|
2537
|
+
"metadata.name",
|
|
2538
|
+
"metadata.namespace",
|
|
2539
|
+
"path.namespace",
|
|
2540
|
+
"path.view_kind",
|
|
2541
|
+
"path.view_name",
|
|
2542
|
+
],
|
|
2543
|
+
side_effects: {
|
|
2544
|
+
creates: ["force-delete"],
|
|
2545
|
+
},
|
|
2546
|
+
},
|
|
2547
|
+
},
|
|
2548
|
+
{
|
|
2549
|
+
toolName: "f5xc-api-marketplace-generate-token-get",
|
|
2550
|
+
method: "GET",
|
|
2551
|
+
path: "/api/config/namespaces/{namespace}/third_party_applications/{name}/generate_token",
|
|
2552
|
+
operation: "get",
|
|
2553
|
+
domain: "marketplace",
|
|
2554
|
+
resource: "generate-token",
|
|
2555
|
+
summary: "Generate Token.",
|
|
2556
|
+
description: "Generate token that will be used by the third party application.",
|
|
2557
|
+
pathParameters: [
|
|
2558
|
+
{
|
|
2559
|
+
description: "Service Name\nx-required\nIdentifies the discovered service name.",
|
|
2560
|
+
in: "path",
|
|
2561
|
+
name: "name",
|
|
2562
|
+
required: true,
|
|
2563
|
+
schema: {
|
|
2564
|
+
type: "string",
|
|
2565
|
+
},
|
|
2566
|
+
"x-displayname": "Service Name.",
|
|
2567
|
+
"x-ves-example": "Vs1",
|
|
2568
|
+
},
|
|
2569
|
+
{
|
|
2570
|
+
description: "Namespace\nx-required\nNamespace of the discovered service for current request.",
|
|
2571
|
+
in: "path",
|
|
2572
|
+
name: "namespace",
|
|
2573
|
+
required: true,
|
|
2574
|
+
schema: {
|
|
2575
|
+
type: "string",
|
|
2576
|
+
},
|
|
2577
|
+
"x-displayname": "Namespace",
|
|
2578
|
+
"x-ves-example": "Shared",
|
|
2579
|
+
},
|
|
2580
|
+
],
|
|
2581
|
+
queryParameters: [],
|
|
2582
|
+
requestBodySchema: null,
|
|
2583
|
+
responseSchema: {
|
|
2584
|
+
$ref: "#/components/schemas/third_party_applicationGenerateTokenResponse",
|
|
2585
|
+
},
|
|
2586
|
+
requiredParams: ["name", "namespace"],
|
|
2587
|
+
operationId: "ves.io.schema.views.third_party_application.CustomAPI.GenerateToken",
|
|
2588
|
+
tags: ["Other"],
|
|
2589
|
+
sourceFile: "domains/marketplace.json",
|
|
2590
|
+
displayName: null,
|
|
2591
|
+
dangerLevel: "low",
|
|
2592
|
+
sideEffects: null,
|
|
2593
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2594
|
+
cliExamples: [
|
|
2595
|
+
{
|
|
2596
|
+
command: "f5xcctl config generate-token get {name} --namespace {namespace}",
|
|
2597
|
+
description: "Get specific generate-token",
|
|
2598
|
+
use_case: "get_specific",
|
|
2599
|
+
},
|
|
2600
|
+
],
|
|
2601
|
+
confirmationRequired: false,
|
|
2602
|
+
parameterExamples: {
|
|
2603
|
+
name: "Vs1",
|
|
2604
|
+
namespace: "Shared",
|
|
2605
|
+
},
|
|
2606
|
+
validationRules: {},
|
|
2607
|
+
operationMetadata: {
|
|
2608
|
+
common_errors: [
|
|
2609
|
+
{
|
|
2610
|
+
code: 401,
|
|
2611
|
+
message: "Authentication required",
|
|
2612
|
+
solution: "Provide valid API credentials",
|
|
2613
|
+
},
|
|
2614
|
+
{
|
|
2615
|
+
code: 403,
|
|
2616
|
+
message: "Permission denied",
|
|
2617
|
+
solution: "Check access permissions for this operation",
|
|
2618
|
+
},
|
|
2619
|
+
{
|
|
2620
|
+
code: 404,
|
|
2621
|
+
message: "Resource not found",
|
|
2622
|
+
solution: "Verify resource name, namespace, and path",
|
|
2623
|
+
},
|
|
2624
|
+
{
|
|
2625
|
+
code: 409,
|
|
2626
|
+
message: "Resource already exists",
|
|
2627
|
+
solution: "Use different name or update existing resource",
|
|
2628
|
+
},
|
|
2629
|
+
{
|
|
2630
|
+
code: 429,
|
|
2631
|
+
message: "Rate limit exceeded",
|
|
2632
|
+
solution: "Wait before retrying the operation",
|
|
2633
|
+
},
|
|
2634
|
+
{
|
|
2635
|
+
code: 500,
|
|
2636
|
+
message: "Server error",
|
|
2637
|
+
solution: "Retry operation or contact support",
|
|
2638
|
+
},
|
|
2639
|
+
],
|
|
2640
|
+
conditions: {
|
|
2641
|
+
postconditions: [],
|
|
2642
|
+
prerequisites: ["Active namespace"],
|
|
2643
|
+
},
|
|
2644
|
+
confirmation_required: false,
|
|
2645
|
+
danger_level: "low",
|
|
2646
|
+
examples: [
|
|
2647
|
+
{
|
|
2648
|
+
command: "f5xcctl config generate-token get {name} --namespace {namespace}",
|
|
2649
|
+
description: "Get specific generate-token",
|
|
2650
|
+
use_case: "get_specific",
|
|
2651
|
+
},
|
|
2652
|
+
],
|
|
2653
|
+
field_docs: {},
|
|
2654
|
+
optional_fields: [],
|
|
2655
|
+
performance_impact: {
|
|
2656
|
+
latency: "moderate",
|
|
2657
|
+
resource_usage: "moderate",
|
|
2658
|
+
},
|
|
2659
|
+
purpose: "Retrieve specific generate-token",
|
|
2660
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2661
|
+
side_effects: {},
|
|
2662
|
+
},
|
|
2663
|
+
},
|
|
2664
|
+
{
|
|
2665
|
+
toolName: "f5xc-api-marketplace-get-security-config-create",
|
|
2666
|
+
method: "POST",
|
|
2667
|
+
path: "/api/config/namespaces/{namespace}/third_party_application/get_security_config",
|
|
2668
|
+
operation: "create",
|
|
2669
|
+
domain: "marketplace",
|
|
2670
|
+
resource: "get-security-config",
|
|
2671
|
+
summary: "GET Security Config for Third Party Application.",
|
|
2672
|
+
description: "Fetch the corresponding Security Config for the given Third Party Application.",
|
|
2673
|
+
pathParameters: [
|
|
2674
|
+
{
|
|
2675
|
+
description: "Namespace\nx-required\nNamespace of the Third Party Application for current request.",
|
|
2676
|
+
in: "path",
|
|
2677
|
+
name: "namespace",
|
|
2678
|
+
required: true,
|
|
2679
|
+
schema: {
|
|
2680
|
+
type: "string",
|
|
2681
|
+
},
|
|
2682
|
+
"x-displayname": "Namespace",
|
|
2683
|
+
"x-ves-example": "Shared",
|
|
2684
|
+
},
|
|
2685
|
+
],
|
|
2686
|
+
queryParameters: [],
|
|
2687
|
+
requestBodySchema: {
|
|
2688
|
+
$ref: "#/components/schemas/third_party_applicationGetSecurityConfigReq",
|
|
2689
|
+
},
|
|
2690
|
+
responseSchema: {
|
|
2691
|
+
$ref: "#/components/schemas/common_securityGetSecurityConfigRsp",
|
|
2692
|
+
},
|
|
2693
|
+
requiredParams: ["body", "namespace"],
|
|
2694
|
+
operationId: "ves.io.schema.views.third_party_application.CustomAPI.GetSecurityConfig",
|
|
2695
|
+
tags: ["Other"],
|
|
2696
|
+
sourceFile: "domains/marketplace.json",
|
|
2697
|
+
displayName: null,
|
|
2698
|
+
dangerLevel: "medium",
|
|
2699
|
+
sideEffects: {
|
|
2700
|
+
creates: ["get-security-config"],
|
|
2701
|
+
},
|
|
2702
|
+
requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2703
|
+
cliExamples: [
|
|
2704
|
+
{
|
|
2705
|
+
command: "f5xcctl config get-security-config create -f {file}.yaml",
|
|
2706
|
+
description: "Create from YAML file",
|
|
2707
|
+
use_case: "file_based",
|
|
2708
|
+
},
|
|
2709
|
+
{
|
|
2710
|
+
command: "f5xcctl config get-security-config create {name} --namespace {namespace}",
|
|
2711
|
+
description: "Create get-security-config",
|
|
2712
|
+
use_case: "basic_create",
|
|
2713
|
+
},
|
|
2714
|
+
],
|
|
2715
|
+
confirmationRequired: false,
|
|
2716
|
+
parameterExamples: {
|
|
2717
|
+
namespace: "Shared",
|
|
2718
|
+
},
|
|
2719
|
+
validationRules: {},
|
|
2720
|
+
operationMetadata: {
|
|
2721
|
+
common_errors: [
|
|
2722
|
+
{
|
|
2723
|
+
code: 401,
|
|
2724
|
+
message: "Authentication required",
|
|
2725
|
+
solution: "Provide valid API credentials",
|
|
2726
|
+
},
|
|
2727
|
+
{
|
|
2728
|
+
code: 403,
|
|
2729
|
+
message: "Permission denied",
|
|
2730
|
+
solution: "Check access permissions for this operation",
|
|
2731
|
+
},
|
|
2732
|
+
{
|
|
2733
|
+
code: 404,
|
|
2734
|
+
message: "Resource not found",
|
|
2735
|
+
solution: "Verify resource name, namespace, and path",
|
|
2736
|
+
},
|
|
2737
|
+
{
|
|
2738
|
+
code: 409,
|
|
2739
|
+
message: "Resource already exists",
|
|
2740
|
+
solution: "Use different name or update existing resource",
|
|
2741
|
+
},
|
|
2742
|
+
{
|
|
2743
|
+
code: 429,
|
|
2744
|
+
message: "Rate limit exceeded",
|
|
2745
|
+
solution: "Wait before retrying the operation",
|
|
2746
|
+
},
|
|
2747
|
+
{
|
|
2748
|
+
code: 500,
|
|
2749
|
+
message: "Server error",
|
|
2750
|
+
solution: "Retry operation or contact support",
|
|
2751
|
+
},
|
|
2752
|
+
],
|
|
2753
|
+
conditions: {
|
|
2754
|
+
postconditions: [
|
|
2755
|
+
"Get-security-config resource created",
|
|
2756
|
+
"Resource assigned unique identifier",
|
|
2757
|
+
],
|
|
2758
|
+
prerequisites: ["Active namespace"],
|
|
2759
|
+
},
|
|
2760
|
+
confirmation_required: false,
|
|
2761
|
+
danger_level: "medium",
|
|
2762
|
+
examples: [
|
|
2763
|
+
{
|
|
2764
|
+
command: "f5xcctl config get-security-config create {name} --namespace {namespace}",
|
|
2765
|
+
description: "Create get-security-config",
|
|
2766
|
+
use_case: "basic_create",
|
|
2767
|
+
},
|
|
2768
|
+
{
|
|
2769
|
+
command: "f5xcctl config get-security-config create -f {file}.yaml",
|
|
2770
|
+
description: "Create from YAML file",
|
|
2771
|
+
use_case: "file_based",
|
|
2772
|
+
},
|
|
2773
|
+
],
|
|
2774
|
+
field_docs: {},
|
|
2775
|
+
optional_fields: [],
|
|
2776
|
+
performance_impact: {
|
|
2777
|
+
latency: "low",
|
|
2778
|
+
resource_usage: "low",
|
|
2779
|
+
},
|
|
2780
|
+
purpose: "Create new get-security-config",
|
|
2781
|
+
required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
|
|
2782
|
+
side_effects: {
|
|
2783
|
+
creates: ["get-security-config"],
|
|
2784
|
+
},
|
|
2785
|
+
},
|
|
2786
|
+
},
|
|
2787
|
+
{
|
|
2788
|
+
toolName: "f5xc-api-marketplace-navigation-tile-get",
|
|
2789
|
+
method: "GET",
|
|
2790
|
+
path: "/api/web/namespaces/{namespace}/navigation_tiles/{name}",
|
|
2791
|
+
operation: "get",
|
|
2792
|
+
domain: "marketplace",
|
|
2793
|
+
resource: "navigation-tile",
|
|
2794
|
+
summary: "GET Navigation Tile.",
|
|
2795
|
+
description: "GET navigation_tile reads a given object from storage backend for metadata.namespace.",
|
|
2796
|
+
pathParameters: [
|
|
2797
|
+
{
|
|
2798
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
2799
|
+
in: "path",
|
|
2800
|
+
name: "name",
|
|
2801
|
+
required: true,
|
|
2802
|
+
schema: {
|
|
2803
|
+
type: "string",
|
|
2804
|
+
},
|
|
2805
|
+
"x-displayname": "Name",
|
|
2806
|
+
"x-ves-example": "Name",
|
|
2807
|
+
},
|
|
2808
|
+
{
|
|
2809
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
2810
|
+
in: "path",
|
|
2811
|
+
name: "namespace",
|
|
2812
|
+
required: true,
|
|
2813
|
+
schema: {
|
|
2814
|
+
type: "string",
|
|
2815
|
+
},
|
|
2816
|
+
"x-displayname": "Namespace",
|
|
2817
|
+
"x-ves-example": "Ns1",
|
|
2818
|
+
},
|
|
2819
|
+
],
|
|
2820
|
+
queryParameters: [
|
|
2821
|
+
{
|
|
2822
|
+
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.",
|
|
2823
|
+
in: "query",
|
|
2824
|
+
name: "response_format",
|
|
2825
|
+
required: false,
|
|
2826
|
+
schema: {
|
|
2827
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
2828
|
+
enum: [
|
|
2829
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
2830
|
+
"GET_RSP_FORMAT_STATUS",
|
|
2831
|
+
"GET_RSP_FORMAT_READ",
|
|
2832
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
2833
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
2834
|
+
],
|
|
2835
|
+
type: "string",
|
|
2836
|
+
},
|
|
2837
|
+
"x-displayname": "Broken Referred Objects.",
|
|
2838
|
+
},
|
|
2839
|
+
],
|
|
2840
|
+
requestBodySchema: null,
|
|
2841
|
+
responseSchema: {
|
|
2842
|
+
$ref: "#/components/schemas/navigation_tileGetResponse",
|
|
2843
|
+
},
|
|
2844
|
+
requiredParams: ["name", "namespace"],
|
|
2845
|
+
operationId: "ves.io.schema.pbac.navigation_tile.API.Get",
|
|
2846
|
+
tags: ["Other"],
|
|
2847
|
+
sourceFile: "domains/marketplace.json",
|
|
2848
|
+
displayName: null,
|
|
2849
|
+
dangerLevel: "low",
|
|
2850
|
+
sideEffects: null,
|
|
2851
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
2852
|
+
cliExamples: [
|
|
2853
|
+
{
|
|
2854
|
+
command: "f5xcctl web navigation-tile get {name} --namespace {namespace}",
|
|
2855
|
+
description: "Get specific navigation-tile",
|
|
2856
|
+
use_case: "get_specific",
|
|
2857
|
+
},
|
|
2858
|
+
],
|
|
2859
|
+
confirmationRequired: false,
|
|
2860
|
+
parameterExamples: {
|
|
2861
|
+
name: "Name",
|
|
2862
|
+
namespace: "Ns1",
|
|
2863
|
+
},
|
|
2864
|
+
validationRules: {},
|
|
2865
|
+
operationMetadata: {
|
|
2866
|
+
common_errors: [
|
|
2867
|
+
{
|
|
2868
|
+
code: 401,
|
|
2869
|
+
message: "Authentication required",
|
|
2870
|
+
solution: "Provide valid API credentials",
|
|
2871
|
+
},
|
|
2872
|
+
{
|
|
2873
|
+
code: 403,
|
|
2874
|
+
message: "Permission denied",
|
|
2875
|
+
solution: "Check access permissions for this operation",
|
|
2876
|
+
},
|
|
2877
|
+
{
|
|
2878
|
+
code: 404,
|
|
2879
|
+
message: "Resource not found",
|
|
2880
|
+
solution: "Verify resource name, namespace, and path",
|
|
2881
|
+
},
|
|
2882
|
+
{
|
|
2883
|
+
code: 409,
|
|
2884
|
+
message: "Resource already exists",
|
|
2885
|
+
solution: "Use different name or update existing resource",
|
|
2886
|
+
},
|
|
2887
|
+
{
|
|
2888
|
+
code: 429,
|
|
2889
|
+
message: "Rate limit exceeded",
|
|
2890
|
+
solution: "Wait before retrying the operation",
|
|
2891
|
+
},
|
|
2892
|
+
{
|
|
2893
|
+
code: 500,
|
|
2894
|
+
message: "Server error",
|
|
2895
|
+
solution: "Retry operation or contact support",
|
|
2896
|
+
},
|
|
2897
|
+
],
|
|
2898
|
+
conditions: {
|
|
2899
|
+
postconditions: [],
|
|
2900
|
+
prerequisites: ["Active namespace"],
|
|
2901
|
+
},
|
|
2902
|
+
confirmation_required: false,
|
|
2903
|
+
danger_level: "low",
|
|
2904
|
+
examples: [
|
|
2905
|
+
{
|
|
2906
|
+
command: "f5xcctl web navigation-tile get {name} --namespace {namespace}",
|
|
2907
|
+
description: "Get specific navigation-tile",
|
|
2908
|
+
use_case: "get_specific",
|
|
2909
|
+
},
|
|
2910
|
+
],
|
|
2911
|
+
field_docs: {},
|
|
2912
|
+
optional_fields: [],
|
|
2913
|
+
performance_impact: {
|
|
2914
|
+
latency: "low",
|
|
2915
|
+
resource_usage: "low",
|
|
2916
|
+
},
|
|
2917
|
+
purpose: "Retrieve specific navigation-tile",
|
|
2918
|
+
required_fields: ["path.name", "path.namespace"],
|
|
2919
|
+
side_effects: {},
|
|
2920
|
+
},
|
|
2921
|
+
},
|
|
2922
|
+
{
|
|
2923
|
+
toolName: "f5xc-api-marketplace-navigation-tile-list",
|
|
2924
|
+
method: "GET",
|
|
2925
|
+
path: "/api/web/namespaces/{namespace}/navigation_tiles",
|
|
2926
|
+
operation: "list",
|
|
2927
|
+
domain: "marketplace",
|
|
2928
|
+
resource: "navigation-tile",
|
|
2929
|
+
summary: "List Navigation Tile.",
|
|
2930
|
+
description: "List the set of navigation_tile in a namespace.",
|
|
2931
|
+
pathParameters: [
|
|
2932
|
+
{
|
|
2933
|
+
description: "Namespace\nNamespace to scope the listing of navigation_tile.",
|
|
2934
|
+
in: "path",
|
|
2935
|
+
name: "namespace",
|
|
2936
|
+
required: true,
|
|
2937
|
+
schema: {
|
|
2938
|
+
type: "string",
|
|
2939
|
+
},
|
|
2940
|
+
"x-displayname": "Namespace",
|
|
2941
|
+
"x-ves-example": "Ns1",
|
|
2942
|
+
},
|
|
2943
|
+
],
|
|
2944
|
+
queryParameters: [
|
|
2945
|
+
{
|
|
2946
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
2947
|
+
in: "query",
|
|
2948
|
+
name: "label_filter",
|
|
2949
|
+
required: false,
|
|
2950
|
+
schema: {
|
|
2951
|
+
type: "string",
|
|
2952
|
+
},
|
|
2953
|
+
"x-displayname": "Label Filter.",
|
|
2954
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
2955
|
+
},
|
|
2956
|
+
{
|
|
2957
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
2958
|
+
in: "query",
|
|
2959
|
+
name: "report_fields",
|
|
2960
|
+
required: false,
|
|
2961
|
+
schema: {
|
|
2962
|
+
items: {
|
|
2963
|
+
type: "string",
|
|
2964
|
+
},
|
|
2965
|
+
type: "array",
|
|
2966
|
+
},
|
|
2967
|
+
"x-displayname": "Report Fields.",
|
|
2968
|
+
},
|
|
2969
|
+
{
|
|
2970
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
2971
|
+
in: "query",
|
|
2972
|
+
name: "report_status_fields",
|
|
2973
|
+
required: false,
|
|
2974
|
+
schema: {
|
|
2975
|
+
items: {
|
|
2976
|
+
type: "string",
|
|
2977
|
+
},
|
|
2978
|
+
type: "array",
|
|
2979
|
+
},
|
|
2980
|
+
"x-displayname": "Report Status Fields.",
|
|
2981
|
+
},
|
|
2982
|
+
],
|
|
2983
|
+
requestBodySchema: null,
|
|
2984
|
+
responseSchema: {
|
|
2985
|
+
$ref: "#/components/schemas/navigation_tileListResponse",
|
|
2986
|
+
},
|
|
2987
|
+
requiredParams: ["namespace"],
|
|
2988
|
+
operationId: "ves.io.schema.pbac.navigation_tile.API.List",
|
|
2989
|
+
tags: ["Other"],
|
|
2990
|
+
sourceFile: "domains/marketplace.json",
|
|
2991
|
+
displayName: null,
|
|
2992
|
+
dangerLevel: "low",
|
|
2993
|
+
sideEffects: null,
|
|
2994
|
+
requiredFields: ["path.namespace"],
|
|
2995
|
+
cliExamples: [
|
|
2996
|
+
{
|
|
2997
|
+
command: "f5xcctl web navigation-tile list --namespace {namespace}",
|
|
2998
|
+
description: "List all navigation-tiles",
|
|
2999
|
+
use_case: "list_all",
|
|
3000
|
+
},
|
|
3001
|
+
],
|
|
3002
|
+
confirmationRequired: false,
|
|
3003
|
+
parameterExamples: {
|
|
3004
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
3005
|
+
namespace: "Ns1",
|
|
3006
|
+
},
|
|
3007
|
+
validationRules: {},
|
|
3008
|
+
operationMetadata: {
|
|
3009
|
+
common_errors: [
|
|
3010
|
+
{
|
|
3011
|
+
code: 401,
|
|
3012
|
+
message: "Authentication required",
|
|
3013
|
+
solution: "Provide valid API credentials",
|
|
3014
|
+
},
|
|
3015
|
+
{
|
|
3016
|
+
code: 403,
|
|
3017
|
+
message: "Permission denied",
|
|
3018
|
+
solution: "Check access permissions for this operation",
|
|
3019
|
+
},
|
|
3020
|
+
{
|
|
3021
|
+
code: 404,
|
|
3022
|
+
message: "Resource not found",
|
|
3023
|
+
solution: "Verify resource name, namespace, and path",
|
|
3024
|
+
},
|
|
3025
|
+
{
|
|
3026
|
+
code: 409,
|
|
3027
|
+
message: "Resource already exists",
|
|
3028
|
+
solution: "Use different name or update existing resource",
|
|
3029
|
+
},
|
|
3030
|
+
{
|
|
3031
|
+
code: 429,
|
|
3032
|
+
message: "Rate limit exceeded",
|
|
3033
|
+
solution: "Wait before retrying the operation",
|
|
3034
|
+
},
|
|
3035
|
+
{
|
|
3036
|
+
code: 500,
|
|
3037
|
+
message: "Server error",
|
|
3038
|
+
solution: "Retry operation or contact support",
|
|
3039
|
+
},
|
|
3040
|
+
],
|
|
3041
|
+
conditions: {
|
|
3042
|
+
postconditions: [],
|
|
3043
|
+
prerequisites: ["Active namespace"],
|
|
3044
|
+
},
|
|
3045
|
+
confirmation_required: false,
|
|
3046
|
+
danger_level: "low",
|
|
3047
|
+
examples: [
|
|
3048
|
+
{
|
|
3049
|
+
command: "f5xcctl web navigation-tile list --namespace {namespace}",
|
|
3050
|
+
description: "List all navigation-tiles",
|
|
3051
|
+
use_case: "list_all",
|
|
3052
|
+
},
|
|
3053
|
+
],
|
|
3054
|
+
field_docs: {},
|
|
3055
|
+
optional_fields: [],
|
|
3056
|
+
performance_impact: {
|
|
3057
|
+
latency: "moderate",
|
|
3058
|
+
resource_usage: "moderate",
|
|
3059
|
+
},
|
|
3060
|
+
purpose: "List all navigation-tiles",
|
|
3061
|
+
required_fields: ["path.namespace"],
|
|
3062
|
+
side_effects: {},
|
|
3063
|
+
},
|
|
3064
|
+
},
|
|
3065
|
+
{
|
|
3066
|
+
toolName: "f5xc-api-marketplace-plan-get",
|
|
3067
|
+
method: "GET",
|
|
3068
|
+
path: "/api/web/namespaces/{namespace}/plans/{name}",
|
|
3069
|
+
operation: "get",
|
|
3070
|
+
domain: "marketplace",
|
|
3071
|
+
resource: "plan",
|
|
3072
|
+
summary: "GET Plan",
|
|
3073
|
+
description: "GET plan reads a given object from storage backend for metadata.namespace.",
|
|
3074
|
+
pathParameters: [
|
|
3075
|
+
{
|
|
3076
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
3077
|
+
in: "path",
|
|
3078
|
+
name: "name",
|
|
3079
|
+
required: true,
|
|
3080
|
+
schema: {
|
|
3081
|
+
type: "string",
|
|
3082
|
+
},
|
|
3083
|
+
"x-displayname": "Name",
|
|
3084
|
+
"x-ves-example": "Name",
|
|
3085
|
+
},
|
|
3086
|
+
{
|
|
3087
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
3088
|
+
in: "path",
|
|
3089
|
+
name: "namespace",
|
|
3090
|
+
required: true,
|
|
3091
|
+
schema: {
|
|
3092
|
+
type: "string",
|
|
3093
|
+
},
|
|
3094
|
+
"x-displayname": "Namespace",
|
|
3095
|
+
"x-ves-example": "Ns1",
|
|
3096
|
+
},
|
|
3097
|
+
],
|
|
3098
|
+
queryParameters: [
|
|
3099
|
+
{
|
|
3100
|
+
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.",
|
|
3101
|
+
in: "query",
|
|
3102
|
+
name: "response_format",
|
|
3103
|
+
required: false,
|
|
3104
|
+
schema: {
|
|
3105
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
3106
|
+
enum: [
|
|
3107
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
3108
|
+
"GET_RSP_FORMAT_STATUS",
|
|
3109
|
+
"GET_RSP_FORMAT_READ",
|
|
3110
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
3111
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
3112
|
+
],
|
|
3113
|
+
type: "string",
|
|
3114
|
+
},
|
|
3115
|
+
"x-displayname": "Broken Referred Objects.",
|
|
3116
|
+
},
|
|
3117
|
+
],
|
|
3118
|
+
requestBodySchema: null,
|
|
3119
|
+
responseSchema: {
|
|
3120
|
+
$ref: "#/components/schemas/planGetResponse",
|
|
3121
|
+
},
|
|
3122
|
+
requiredParams: ["name", "namespace"],
|
|
3123
|
+
operationId: "ves.io.schema.pbac.plan.API.Get",
|
|
3124
|
+
tags: ["Other"],
|
|
3125
|
+
sourceFile: "domains/marketplace.json",
|
|
3126
|
+
displayName: null,
|
|
3127
|
+
dangerLevel: "low",
|
|
3128
|
+
sideEffects: null,
|
|
3129
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
3130
|
+
cliExamples: [
|
|
3131
|
+
{
|
|
3132
|
+
command: "f5xcctl web plan get {name} --namespace {namespace}",
|
|
3133
|
+
description: "Get specific plan",
|
|
3134
|
+
use_case: "get_specific",
|
|
3135
|
+
},
|
|
3136
|
+
],
|
|
3137
|
+
confirmationRequired: false,
|
|
3138
|
+
parameterExamples: {
|
|
3139
|
+
name: "Name",
|
|
3140
|
+
namespace: "Ns1",
|
|
3141
|
+
},
|
|
3142
|
+
validationRules: {},
|
|
3143
|
+
operationMetadata: {
|
|
3144
|
+
common_errors: [
|
|
3145
|
+
{
|
|
3146
|
+
code: 401,
|
|
3147
|
+
message: "Authentication required",
|
|
3148
|
+
solution: "Provide valid API credentials",
|
|
3149
|
+
},
|
|
3150
|
+
{
|
|
3151
|
+
code: 403,
|
|
3152
|
+
message: "Permission denied",
|
|
3153
|
+
solution: "Check access permissions for this operation",
|
|
3154
|
+
},
|
|
3155
|
+
{
|
|
3156
|
+
code: 404,
|
|
3157
|
+
message: "Resource not found",
|
|
3158
|
+
solution: "Verify resource name, namespace, and path",
|
|
3159
|
+
},
|
|
3160
|
+
{
|
|
3161
|
+
code: 409,
|
|
3162
|
+
message: "Resource already exists",
|
|
3163
|
+
solution: "Use different name or update existing resource",
|
|
3164
|
+
},
|
|
3165
|
+
{
|
|
3166
|
+
code: 429,
|
|
3167
|
+
message: "Rate limit exceeded",
|
|
3168
|
+
solution: "Wait before retrying the operation",
|
|
3169
|
+
},
|
|
3170
|
+
{
|
|
3171
|
+
code: 500,
|
|
3172
|
+
message: "Server error",
|
|
3173
|
+
solution: "Retry operation or contact support",
|
|
3174
|
+
},
|
|
3175
|
+
],
|
|
3176
|
+
conditions: {
|
|
3177
|
+
postconditions: [],
|
|
3178
|
+
prerequisites: ["Active namespace"],
|
|
3179
|
+
},
|
|
3180
|
+
confirmation_required: false,
|
|
3181
|
+
danger_level: "low",
|
|
3182
|
+
examples: [
|
|
3183
|
+
{
|
|
3184
|
+
command: "f5xcctl web plan get {name} --namespace {namespace}",
|
|
3185
|
+
description: "Get specific plan",
|
|
3186
|
+
use_case: "get_specific",
|
|
3187
|
+
},
|
|
3188
|
+
],
|
|
3189
|
+
field_docs: {},
|
|
3190
|
+
optional_fields: [],
|
|
3191
|
+
performance_impact: {
|
|
3192
|
+
latency: "low",
|
|
3193
|
+
resource_usage: "low",
|
|
3194
|
+
},
|
|
3195
|
+
purpose: "Retrieve specific plan",
|
|
3196
|
+
required_fields: ["path.name", "path.namespace"],
|
|
3197
|
+
side_effects: {},
|
|
3198
|
+
},
|
|
3199
|
+
},
|
|
3200
|
+
{
|
|
3201
|
+
toolName: "f5xc-api-marketplace-plan-list",
|
|
3202
|
+
method: "GET",
|
|
3203
|
+
path: "/api/web/namespaces/{namespace}/plans",
|
|
3204
|
+
operation: "list",
|
|
3205
|
+
domain: "marketplace",
|
|
3206
|
+
resource: "plan",
|
|
3207
|
+
summary: "List Plan",
|
|
3208
|
+
description: "List the set of plan in a namespace.",
|
|
3209
|
+
pathParameters: [
|
|
3210
|
+
{
|
|
3211
|
+
description: "Namespace\nNamespace to scope the listing of plan.",
|
|
3212
|
+
in: "path",
|
|
3213
|
+
name: "namespace",
|
|
3214
|
+
required: true,
|
|
3215
|
+
schema: {
|
|
3216
|
+
type: "string",
|
|
3217
|
+
},
|
|
3218
|
+
"x-displayname": "Namespace",
|
|
3219
|
+
"x-ves-example": "Ns1",
|
|
3220
|
+
},
|
|
3221
|
+
],
|
|
3222
|
+
queryParameters: [
|
|
3223
|
+
{
|
|
3224
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
3225
|
+
in: "query",
|
|
3226
|
+
name: "label_filter",
|
|
3227
|
+
required: false,
|
|
3228
|
+
schema: {
|
|
3229
|
+
type: "string",
|
|
3230
|
+
},
|
|
3231
|
+
"x-displayname": "Label Filter.",
|
|
3232
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
3233
|
+
},
|
|
3234
|
+
{
|
|
3235
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
3236
|
+
in: "query",
|
|
3237
|
+
name: "report_fields",
|
|
3238
|
+
required: false,
|
|
3239
|
+
schema: {
|
|
3240
|
+
items: {
|
|
3241
|
+
type: "string",
|
|
3242
|
+
},
|
|
3243
|
+
type: "array",
|
|
3244
|
+
},
|
|
3245
|
+
"x-displayname": "Report Fields.",
|
|
3246
|
+
},
|
|
3247
|
+
{
|
|
3248
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
3249
|
+
in: "query",
|
|
3250
|
+
name: "report_status_fields",
|
|
3251
|
+
required: false,
|
|
3252
|
+
schema: {
|
|
3253
|
+
items: {
|
|
3254
|
+
type: "string",
|
|
3255
|
+
},
|
|
3256
|
+
type: "array",
|
|
3257
|
+
},
|
|
3258
|
+
"x-displayname": "Report Status Fields.",
|
|
3259
|
+
},
|
|
3260
|
+
],
|
|
3261
|
+
requestBodySchema: null,
|
|
3262
|
+
responseSchema: {
|
|
3263
|
+
$ref: "#/components/schemas/planListResponse",
|
|
3264
|
+
},
|
|
3265
|
+
requiredParams: ["namespace"],
|
|
3266
|
+
operationId: "ves.io.schema.pbac.plan.API.List",
|
|
3267
|
+
tags: ["Other"],
|
|
3268
|
+
sourceFile: "domains/marketplace.json",
|
|
3269
|
+
displayName: null,
|
|
3270
|
+
dangerLevel: "low",
|
|
3271
|
+
sideEffects: null,
|
|
3272
|
+
requiredFields: ["path.namespace"],
|
|
3273
|
+
cliExamples: [
|
|
3274
|
+
{
|
|
3275
|
+
command: "f5xcctl web plan list --namespace {namespace}",
|
|
3276
|
+
description: "List all plans",
|
|
3277
|
+
use_case: "list_all",
|
|
3278
|
+
},
|
|
3279
|
+
],
|
|
3280
|
+
confirmationRequired: false,
|
|
3281
|
+
parameterExamples: {
|
|
3282
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
3283
|
+
namespace: "Ns1",
|
|
3284
|
+
},
|
|
3285
|
+
validationRules: {},
|
|
3286
|
+
operationMetadata: {
|
|
3287
|
+
common_errors: [
|
|
3288
|
+
{
|
|
3289
|
+
code: 401,
|
|
3290
|
+
message: "Authentication required",
|
|
3291
|
+
solution: "Provide valid API credentials",
|
|
3292
|
+
},
|
|
3293
|
+
{
|
|
3294
|
+
code: 403,
|
|
3295
|
+
message: "Permission denied",
|
|
3296
|
+
solution: "Check access permissions for this operation",
|
|
3297
|
+
},
|
|
3298
|
+
{
|
|
3299
|
+
code: 404,
|
|
3300
|
+
message: "Resource not found",
|
|
3301
|
+
solution: "Verify resource name, namespace, and path",
|
|
3302
|
+
},
|
|
3303
|
+
{
|
|
3304
|
+
code: 409,
|
|
3305
|
+
message: "Resource already exists",
|
|
3306
|
+
solution: "Use different name or update existing resource",
|
|
3307
|
+
},
|
|
3308
|
+
{
|
|
3309
|
+
code: 429,
|
|
3310
|
+
message: "Rate limit exceeded",
|
|
3311
|
+
solution: "Wait before retrying the operation",
|
|
3312
|
+
},
|
|
3313
|
+
{
|
|
3314
|
+
code: 500,
|
|
3315
|
+
message: "Server error",
|
|
3316
|
+
solution: "Retry operation or contact support",
|
|
3317
|
+
},
|
|
3318
|
+
],
|
|
3319
|
+
conditions: {
|
|
3320
|
+
postconditions: [],
|
|
3321
|
+
prerequisites: ["Active namespace"],
|
|
3322
|
+
},
|
|
3323
|
+
confirmation_required: false,
|
|
3324
|
+
danger_level: "low",
|
|
3325
|
+
examples: [
|
|
3326
|
+
{
|
|
3327
|
+
command: "f5xcctl web plan list --namespace {namespace}",
|
|
3328
|
+
description: "List all plans",
|
|
3329
|
+
use_case: "list_all",
|
|
3330
|
+
},
|
|
3331
|
+
],
|
|
3332
|
+
field_docs: {},
|
|
3333
|
+
optional_fields: [],
|
|
3334
|
+
performance_impact: {
|
|
3335
|
+
latency: "moderate",
|
|
3336
|
+
resource_usage: "moderate",
|
|
3337
|
+
},
|
|
3338
|
+
purpose: "List all plans",
|
|
3339
|
+
required_fields: ["path.namespace"],
|
|
3340
|
+
side_effects: {},
|
|
3341
|
+
},
|
|
3342
|
+
},
|
|
3343
|
+
{
|
|
3344
|
+
toolName: "f5xc-api-marketplace-register-create",
|
|
3345
|
+
method: "POST",
|
|
3346
|
+
path: "/no_auth/namespaces/system/aws/f5xc-saas/register",
|
|
3347
|
+
operation: "create",
|
|
3348
|
+
domain: "marketplace",
|
|
3349
|
+
resource: "register",
|
|
3350
|
+
summary: "Register New AWS Account.",
|
|
3351
|
+
description: "Use this API to register F5XC AWS marketplace product for F5XC service.",
|
|
3352
|
+
pathParameters: [],
|
|
3353
|
+
queryParameters: [],
|
|
3354
|
+
requestBodySchema: {
|
|
3355
|
+
$ref: "#/components/schemas/aws_accountRegistrationRequest",
|
|
3356
|
+
},
|
|
3357
|
+
responseSchema: {
|
|
3358
|
+
$ref: "#/components/schemas/aws_accountRegistrationResponse",
|
|
3359
|
+
},
|
|
3360
|
+
requiredParams: ["body"],
|
|
3361
|
+
operationId: "ves.io.schema.marketplace.aws_account.OnboardCustomAPI.RegisterNewAWSAccount",
|
|
3362
|
+
tags: ["Other"],
|
|
3363
|
+
sourceFile: "domains/marketplace.json",
|
|
3364
|
+
displayName: null,
|
|
3365
|
+
dangerLevel: "medium",
|
|
3366
|
+
sideEffects: {
|
|
3367
|
+
creates: ["register"],
|
|
3368
|
+
},
|
|
3369
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
3370
|
+
cliExamples: [
|
|
3371
|
+
{
|
|
3372
|
+
command: "f5xcctl default register create -f {file}.yaml",
|
|
3373
|
+
description: "Create from YAML file",
|
|
3374
|
+
use_case: "file_based",
|
|
3375
|
+
},
|
|
3376
|
+
{
|
|
3377
|
+
command: "f5xcctl default register create {name} --namespace {namespace}",
|
|
3378
|
+
description: "Create register",
|
|
3379
|
+
use_case: "basic_create",
|
|
3380
|
+
},
|
|
3381
|
+
],
|
|
3382
|
+
confirmationRequired: false,
|
|
3383
|
+
parameterExamples: {},
|
|
3384
|
+
validationRules: {},
|
|
3385
|
+
operationMetadata: {
|
|
3386
|
+
common_errors: [
|
|
3387
|
+
{
|
|
3388
|
+
code: 401,
|
|
3389
|
+
message: "Authentication required",
|
|
3390
|
+
solution: "Provide valid API credentials",
|
|
3391
|
+
},
|
|
3392
|
+
{
|
|
3393
|
+
code: 403,
|
|
3394
|
+
message: "Permission denied",
|
|
3395
|
+
solution: "Check access permissions for this operation",
|
|
3396
|
+
},
|
|
3397
|
+
{
|
|
3398
|
+
code: 404,
|
|
3399
|
+
message: "Resource not found",
|
|
3400
|
+
solution: "Verify resource name, namespace, and path",
|
|
3401
|
+
},
|
|
3402
|
+
{
|
|
3403
|
+
code: 409,
|
|
3404
|
+
message: "Resource already exists",
|
|
3405
|
+
solution: "Use different name or update existing resource",
|
|
3406
|
+
},
|
|
3407
|
+
{
|
|
3408
|
+
code: 429,
|
|
3409
|
+
message: "Rate limit exceeded",
|
|
3410
|
+
solution: "Wait before retrying the operation",
|
|
3411
|
+
},
|
|
3412
|
+
{
|
|
3413
|
+
code: 500,
|
|
3414
|
+
message: "Server error",
|
|
3415
|
+
solution: "Retry operation or contact support",
|
|
3416
|
+
},
|
|
3417
|
+
],
|
|
3418
|
+
conditions: {
|
|
3419
|
+
postconditions: ["Register resource created", "Resource assigned unique identifier"],
|
|
3420
|
+
prerequisites: ["Active namespace"],
|
|
3421
|
+
},
|
|
3422
|
+
confirmation_required: false,
|
|
3423
|
+
danger_level: "medium",
|
|
3424
|
+
examples: [
|
|
3425
|
+
{
|
|
3426
|
+
command: "f5xcctl default register create {name} --namespace {namespace}",
|
|
3427
|
+
description: "Create register",
|
|
3428
|
+
use_case: "basic_create",
|
|
3429
|
+
},
|
|
3430
|
+
{
|
|
3431
|
+
command: "f5xcctl default register create -f {file}.yaml",
|
|
3432
|
+
description: "Create from YAML file",
|
|
3433
|
+
use_case: "file_based",
|
|
3434
|
+
},
|
|
3435
|
+
],
|
|
3436
|
+
field_docs: {},
|
|
3437
|
+
optional_fields: [],
|
|
3438
|
+
performance_impact: {
|
|
3439
|
+
latency: "low",
|
|
3440
|
+
resource_usage: "low",
|
|
3441
|
+
},
|
|
3442
|
+
purpose: "Create new register",
|
|
3443
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
3444
|
+
side_effects: {
|
|
3445
|
+
creates: ["register"],
|
|
3446
|
+
},
|
|
3447
|
+
},
|
|
3448
|
+
},
|
|
3449
|
+
{
|
|
3450
|
+
toolName: "f5xc-api-marketplace-registration-detail-list",
|
|
3451
|
+
method: "GET",
|
|
3452
|
+
path: "/no_auth/namespaces/system/f5xc-saas/signup/registration_details",
|
|
3453
|
+
operation: "list",
|
|
3454
|
+
domain: "marketplace",
|
|
3455
|
+
resource: "registration-detail",
|
|
3456
|
+
summary: "GET Registration Details.",
|
|
3457
|
+
description: "Use this API to to GET registration details (currently limited to email address and domain) associated with a specific asb_message object.",
|
|
3458
|
+
pathParameters: [],
|
|
3459
|
+
queryParameters: [
|
|
3460
|
+
{
|
|
3461
|
+
description: "The token contains the encrypted data, secured using an HMAC key.",
|
|
3462
|
+
in: "query",
|
|
3463
|
+
name: "token",
|
|
3464
|
+
required: false,
|
|
3465
|
+
schema: {
|
|
3466
|
+
type: "string",
|
|
3467
|
+
},
|
|
3468
|
+
"x-displayname": "Token",
|
|
3469
|
+
"x-ves-example": "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7.",
|
|
3470
|
+
},
|
|
3471
|
+
],
|
|
3472
|
+
requestBodySchema: null,
|
|
3473
|
+
responseSchema: {
|
|
3474
|
+
$ref: "#/components/schemas/xc_saasGetRegistrationDetailsResponse",
|
|
3475
|
+
},
|
|
3476
|
+
requiredParams: [],
|
|
3477
|
+
operationId: "ves.io.schema.marketplace.xc_saas.CustomAPI.GetRegistrationDetails",
|
|
3478
|
+
tags: ["Identity"],
|
|
3479
|
+
sourceFile: "domains/marketplace.json",
|
|
3480
|
+
displayName: null,
|
|
3481
|
+
dangerLevel: "low",
|
|
3482
|
+
sideEffects: null,
|
|
3483
|
+
requiredFields: [],
|
|
3484
|
+
cliExamples: [
|
|
3485
|
+
{
|
|
3486
|
+
command: "f5xcctl default registration-detail list --namespace {namespace}",
|
|
3487
|
+
description: "List all registration-details",
|
|
3488
|
+
use_case: "list_all",
|
|
3489
|
+
},
|
|
3490
|
+
],
|
|
3491
|
+
confirmationRequired: false,
|
|
3492
|
+
parameterExamples: {
|
|
3493
|
+
token: "7b22656e7469746c656d656e745f737562736372697074696f6e5f6964223a2261393933666633302d363138392d346231612d623064632d3630623034393063666463302d5445454d2d62343438666663362d34353166222c2276616c69645f74696c6c223a22323032342d31312d31355431373a31393a35382e3334323934352d30383a3030227d:d1bd81da4772d62fb424b805391fc946c611b5c245246e444410bcb0fe548ad7.",
|
|
3494
|
+
},
|
|
3495
|
+
validationRules: {},
|
|
3496
|
+
operationMetadata: {
|
|
3497
|
+
common_errors: [
|
|
3498
|
+
{
|
|
3499
|
+
code: 401,
|
|
3500
|
+
message: "Authentication required",
|
|
3501
|
+
solution: "Provide valid API credentials",
|
|
3502
|
+
},
|
|
3503
|
+
{
|
|
3504
|
+
code: 403,
|
|
3505
|
+
message: "Permission denied",
|
|
3506
|
+
solution: "Check access permissions for this operation",
|
|
3507
|
+
},
|
|
3508
|
+
{
|
|
3509
|
+
code: 404,
|
|
3510
|
+
message: "Resource not found",
|
|
3511
|
+
solution: "Verify resource name, namespace, and path",
|
|
3512
|
+
},
|
|
3513
|
+
{
|
|
3514
|
+
code: 409,
|
|
3515
|
+
message: "Resource already exists",
|
|
3516
|
+
solution: "Use different name or update existing resource",
|
|
3517
|
+
},
|
|
3518
|
+
{
|
|
3519
|
+
code: 429,
|
|
3520
|
+
message: "Rate limit exceeded",
|
|
3521
|
+
solution: "Wait before retrying the operation",
|
|
3522
|
+
},
|
|
3523
|
+
{
|
|
3524
|
+
code: 500,
|
|
3525
|
+
message: "Server error",
|
|
3526
|
+
solution: "Retry operation or contact support",
|
|
3527
|
+
},
|
|
3528
|
+
],
|
|
3529
|
+
conditions: {
|
|
3530
|
+
postconditions: [],
|
|
3531
|
+
prerequisites: ["Active namespace"],
|
|
3532
|
+
},
|
|
3533
|
+
confirmation_required: false,
|
|
3534
|
+
danger_level: "low",
|
|
3535
|
+
examples: [
|
|
3536
|
+
{
|
|
3537
|
+
command: "f5xcctl default registration-detail list --namespace {namespace}",
|
|
3538
|
+
description: "List all registration-details",
|
|
3539
|
+
use_case: "list_all",
|
|
3540
|
+
},
|
|
3541
|
+
],
|
|
3542
|
+
field_docs: {},
|
|
3543
|
+
optional_fields: [],
|
|
3544
|
+
performance_impact: {
|
|
3545
|
+
latency: "moderate",
|
|
3546
|
+
resource_usage: "moderate",
|
|
3547
|
+
},
|
|
3548
|
+
purpose: "List all registration-details",
|
|
3549
|
+
required_fields: [],
|
|
3550
|
+
side_effects: {},
|
|
3551
|
+
},
|
|
3552
|
+
},
|
|
3553
|
+
{
|
|
3554
|
+
toolName: "f5xc-api-marketplace-run-create",
|
|
3555
|
+
method: "POST",
|
|
3556
|
+
path: "/api/terraform/namespaces/{namespace}/terraform/{view_kind}/{view_name}/run",
|
|
3557
|
+
operation: "create",
|
|
3558
|
+
domain: "marketplace",
|
|
3559
|
+
resource: "run",
|
|
3560
|
+
summary: "Run Terraform Action for view.",
|
|
3561
|
+
description: "Perform terraform actions for a given view. Supported actions are apply and plan.",
|
|
3562
|
+
pathParameters: [
|
|
3563
|
+
{
|
|
3564
|
+
description: "Namespace\nNamespace for the label to be retrieved.",
|
|
3565
|
+
in: "path",
|
|
3566
|
+
name: "namespace",
|
|
3567
|
+
required: true,
|
|
3568
|
+
schema: {
|
|
3569
|
+
type: "string",
|
|
3570
|
+
},
|
|
3571
|
+
"x-displayname": "Namespace",
|
|
3572
|
+
"x-ves-example": "Value",
|
|
3573
|
+
},
|
|
3574
|
+
{
|
|
3575
|
+
description: "Kind of View\nKind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
|
|
3576
|
+
in: "path",
|
|
3577
|
+
name: "view_kind",
|
|
3578
|
+
required: true,
|
|
3579
|
+
schema: {
|
|
3580
|
+
type: "string",
|
|
3581
|
+
},
|
|
3582
|
+
"x-displayname": "Kind of View.",
|
|
3583
|
+
"x-ves-example": "Value",
|
|
3584
|
+
},
|
|
3585
|
+
{
|
|
3586
|
+
description: "Name of view\nName of the view for which terraform parameters are requested.",
|
|
3587
|
+
in: "path",
|
|
3588
|
+
name: "view_name",
|
|
3589
|
+
required: true,
|
|
3590
|
+
schema: {
|
|
3591
|
+
type: "string",
|
|
3592
|
+
},
|
|
3593
|
+
"x-displayname": "Name of view.",
|
|
3594
|
+
"x-ves-example": "Value",
|
|
3595
|
+
},
|
|
3596
|
+
],
|
|
3597
|
+
queryParameters: [],
|
|
3598
|
+
requestBodySchema: {
|
|
3599
|
+
$ref: "#/components/schemas/terraform_parametersRunRequest",
|
|
3600
|
+
},
|
|
3601
|
+
responseSchema: {
|
|
3602
|
+
$ref: "#/components/schemas/terraform_parametersRunResponse",
|
|
3603
|
+
},
|
|
3604
|
+
requiredParams: ["body", "namespace", "view_kind", "view_name"],
|
|
3605
|
+
operationId: "ves.io.schema.views.terraform_parameters.CustomActionAPI.Run",
|
|
3606
|
+
tags: ["Other"],
|
|
3607
|
+
sourceFile: "domains/marketplace.json",
|
|
3608
|
+
displayName: null,
|
|
3609
|
+
dangerLevel: "medium",
|
|
3610
|
+
sideEffects: {
|
|
3611
|
+
creates: ["run"],
|
|
3612
|
+
},
|
|
3613
|
+
requiredFields: [
|
|
3614
|
+
"metadata.name",
|
|
3615
|
+
"metadata.namespace",
|
|
3616
|
+
"path.namespace",
|
|
3617
|
+
"path.view_kind",
|
|
3618
|
+
"path.view_name",
|
|
3619
|
+
],
|
|
3620
|
+
cliExamples: [
|
|
3621
|
+
{
|
|
3622
|
+
command: "f5xcctl terraform run create -f {file}.yaml",
|
|
3623
|
+
description: "Create from YAML file",
|
|
3624
|
+
use_case: "file_based",
|
|
3625
|
+
},
|
|
3626
|
+
{
|
|
3627
|
+
command: "f5xcctl terraform run create {name} --namespace {namespace}",
|
|
3628
|
+
description: "Create run",
|
|
3629
|
+
use_case: "basic_create",
|
|
3630
|
+
},
|
|
3631
|
+
],
|
|
3632
|
+
confirmationRequired: false,
|
|
3633
|
+
parameterExamples: {
|
|
3634
|
+
namespace: "Value",
|
|
3635
|
+
view_kind: "Value",
|
|
3636
|
+
view_name: "Value",
|
|
3637
|
+
},
|
|
3638
|
+
validationRules: {},
|
|
3639
|
+
operationMetadata: {
|
|
3640
|
+
common_errors: [
|
|
3641
|
+
{
|
|
3642
|
+
code: 401,
|
|
3643
|
+
message: "Authentication required",
|
|
3644
|
+
solution: "Provide valid API credentials",
|
|
3645
|
+
},
|
|
3646
|
+
{
|
|
3647
|
+
code: 403,
|
|
3648
|
+
message: "Permission denied",
|
|
3649
|
+
solution: "Check access permissions for this operation",
|
|
3650
|
+
},
|
|
3651
|
+
{
|
|
3652
|
+
code: 404,
|
|
3653
|
+
message: "Resource not found",
|
|
3654
|
+
solution: "Verify resource name, namespace, and path",
|
|
3655
|
+
},
|
|
3656
|
+
{
|
|
3657
|
+
code: 409,
|
|
3658
|
+
message: "Resource already exists",
|
|
3659
|
+
solution: "Use different name or update existing resource",
|
|
3660
|
+
},
|
|
3661
|
+
{
|
|
3662
|
+
code: 429,
|
|
3663
|
+
message: "Rate limit exceeded",
|
|
3664
|
+
solution: "Wait before retrying the operation",
|
|
3665
|
+
},
|
|
3666
|
+
{
|
|
3667
|
+
code: 500,
|
|
3668
|
+
message: "Server error",
|
|
3669
|
+
solution: "Retry operation or contact support",
|
|
3670
|
+
},
|
|
3671
|
+
],
|
|
3672
|
+
conditions: {
|
|
3673
|
+
postconditions: ["Run resource created", "Resource assigned unique identifier"],
|
|
3674
|
+
prerequisites: ["Active namespace"],
|
|
3675
|
+
},
|
|
3676
|
+
confirmation_required: false,
|
|
3677
|
+
danger_level: "medium",
|
|
3678
|
+
examples: [
|
|
3679
|
+
{
|
|
3680
|
+
command: "f5xcctl terraform run create {name} --namespace {namespace}",
|
|
3681
|
+
description: "Create run",
|
|
3682
|
+
use_case: "basic_create",
|
|
3683
|
+
},
|
|
3684
|
+
{
|
|
3685
|
+
command: "f5xcctl terraform run create -f {file}.yaml",
|
|
3686
|
+
description: "Create from YAML file",
|
|
3687
|
+
use_case: "file_based",
|
|
3688
|
+
},
|
|
3689
|
+
],
|
|
3690
|
+
field_docs: {},
|
|
3691
|
+
optional_fields: [],
|
|
3692
|
+
performance_impact: {
|
|
3693
|
+
latency: "low",
|
|
3694
|
+
resource_usage: "low",
|
|
3695
|
+
},
|
|
3696
|
+
purpose: "Create new run",
|
|
3697
|
+
required_fields: [
|
|
3698
|
+
"metadata.name",
|
|
3699
|
+
"metadata.namespace",
|
|
3700
|
+
"path.namespace",
|
|
3701
|
+
"path.view_kind",
|
|
3702
|
+
"path.view_name",
|
|
3703
|
+
],
|
|
3704
|
+
side_effects: {
|
|
3705
|
+
creates: ["run"],
|
|
3706
|
+
},
|
|
3707
|
+
},
|
|
3708
|
+
},
|
|
3709
|
+
{
|
|
3710
|
+
toolName: "f5xc-api-marketplace-send-email-create",
|
|
3711
|
+
method: "POST",
|
|
3712
|
+
path: "/no_auth/namespaces/system/f5xc-saas/signup/send_email",
|
|
3713
|
+
operation: "create",
|
|
3714
|
+
domain: "marketplace",
|
|
3715
|
+
resource: "send-email",
|
|
3716
|
+
summary: "Send Signup Email.",
|
|
3717
|
+
description: "Use this API to send a tenant provisioning signup email when the signup URL link in the previously sent email has expired or is no longer accessible.",
|
|
3718
|
+
pathParameters: [],
|
|
3719
|
+
queryParameters: [],
|
|
3720
|
+
requestBodySchema: {
|
|
3721
|
+
$ref: "#/components/schemas/xc_saasSendSignupEmailRequest",
|
|
3722
|
+
},
|
|
3723
|
+
responseSchema: {
|
|
3724
|
+
$ref: "#/components/schemas/xc_saasSendEmailResponse",
|
|
3725
|
+
},
|
|
3726
|
+
requiredParams: ["body"],
|
|
3727
|
+
operationId: "ves.io.schema.marketplace.xc_saas.CustomAPI.SendSignupEmail",
|
|
3728
|
+
tags: ["Identity"],
|
|
3729
|
+
sourceFile: "domains/marketplace.json",
|
|
3730
|
+
displayName: null,
|
|
3731
|
+
dangerLevel: "medium",
|
|
3732
|
+
sideEffects: {
|
|
3733
|
+
creates: ["send-email"],
|
|
3734
|
+
},
|
|
3735
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
3736
|
+
cliExamples: [
|
|
3737
|
+
{
|
|
3738
|
+
command: "f5xcctl default send-email create -f {file}.yaml",
|
|
3739
|
+
description: "Create from YAML file",
|
|
3740
|
+
use_case: "file_based",
|
|
3741
|
+
},
|
|
3742
|
+
{
|
|
3743
|
+
command: "f5xcctl default send-email create {name} --namespace {namespace}",
|
|
3744
|
+
description: "Create send-email",
|
|
3745
|
+
use_case: "basic_create",
|
|
3746
|
+
},
|
|
3747
|
+
],
|
|
3748
|
+
confirmationRequired: false,
|
|
3749
|
+
parameterExamples: {},
|
|
3750
|
+
validationRules: {},
|
|
3751
|
+
operationMetadata: {
|
|
3752
|
+
common_errors: [
|
|
3753
|
+
{
|
|
3754
|
+
code: 401,
|
|
3755
|
+
message: "Authentication required",
|
|
3756
|
+
solution: "Provide valid API credentials",
|
|
3757
|
+
},
|
|
3758
|
+
{
|
|
3759
|
+
code: 403,
|
|
3760
|
+
message: "Permission denied",
|
|
3761
|
+
solution: "Check access permissions for this operation",
|
|
3762
|
+
},
|
|
3763
|
+
{
|
|
3764
|
+
code: 404,
|
|
3765
|
+
message: "Resource not found",
|
|
3766
|
+
solution: "Verify resource name, namespace, and path",
|
|
3767
|
+
},
|
|
3768
|
+
{
|
|
3769
|
+
code: 409,
|
|
3770
|
+
message: "Resource already exists",
|
|
3771
|
+
solution: "Use different name or update existing resource",
|
|
3772
|
+
},
|
|
3773
|
+
{
|
|
3774
|
+
code: 429,
|
|
3775
|
+
message: "Rate limit exceeded",
|
|
3776
|
+
solution: "Wait before retrying the operation",
|
|
3777
|
+
},
|
|
3778
|
+
{
|
|
3779
|
+
code: 500,
|
|
3780
|
+
message: "Server error",
|
|
3781
|
+
solution: "Retry operation or contact support",
|
|
3782
|
+
},
|
|
3783
|
+
],
|
|
3784
|
+
conditions: {
|
|
3785
|
+
postconditions: ["Send-email resource created", "Resource assigned unique identifier"],
|
|
3786
|
+
prerequisites: ["Active namespace"],
|
|
3787
|
+
},
|
|
3788
|
+
confirmation_required: false,
|
|
3789
|
+
danger_level: "medium",
|
|
3790
|
+
examples: [
|
|
3791
|
+
{
|
|
3792
|
+
command: "f5xcctl default send-email create {name} --namespace {namespace}",
|
|
3793
|
+
description: "Create send-email",
|
|
3794
|
+
use_case: "basic_create",
|
|
3795
|
+
},
|
|
3796
|
+
{
|
|
3797
|
+
command: "f5xcctl default send-email create -f {file}.yaml",
|
|
3798
|
+
description: "Create from YAML file",
|
|
3799
|
+
use_case: "file_based",
|
|
3800
|
+
},
|
|
3801
|
+
],
|
|
3802
|
+
field_docs: {},
|
|
3803
|
+
optional_fields: [],
|
|
3804
|
+
performance_impact: {
|
|
3805
|
+
latency: "low",
|
|
3806
|
+
resource_usage: "low",
|
|
3807
|
+
},
|
|
3808
|
+
purpose: "Create new send-email",
|
|
3809
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
3810
|
+
side_effects: {
|
|
3811
|
+
creates: ["send-email"],
|
|
3812
|
+
},
|
|
3813
|
+
},
|
|
3814
|
+
},
|
|
3815
|
+
{
|
|
3816
|
+
toolName: "f5xc-api-marketplace-signup-create",
|
|
3817
|
+
method: "POST",
|
|
3818
|
+
path: "/no_auth/namespaces/system/aws/f5xc-saas/signup",
|
|
3819
|
+
operation: "create",
|
|
3820
|
+
domain: "marketplace",
|
|
3821
|
+
resource: "signup",
|
|
3822
|
+
summary: "Signup AWS Account.",
|
|
3823
|
+
description: "Use this API to signup AWS account for F5XC service.",
|
|
3824
|
+
pathParameters: [],
|
|
3825
|
+
queryParameters: [],
|
|
3826
|
+
requestBodySchema: {
|
|
3827
|
+
$ref: "#/components/schemas/aws_accountAWSAccountSignupRequest",
|
|
3828
|
+
},
|
|
3829
|
+
responseSchema: {
|
|
3830
|
+
$ref: "#/components/schemas/aws_accountAWSAccountSignupResponse",
|
|
3831
|
+
},
|
|
3832
|
+
requiredParams: ["body"],
|
|
3833
|
+
operationId: "ves.io.schema.marketplace.aws_account.OnboardCustomAPI.SignupAWSAccount",
|
|
3834
|
+
tags: ["Other"],
|
|
3835
|
+
sourceFile: "domains/marketplace.json",
|
|
3836
|
+
displayName: null,
|
|
3837
|
+
dangerLevel: "medium",
|
|
3838
|
+
sideEffects: {
|
|
3839
|
+
creates: ["signup"],
|
|
3840
|
+
},
|
|
3841
|
+
requiredFields: ["metadata.name", "metadata.namespace"],
|
|
3842
|
+
cliExamples: [
|
|
3843
|
+
{
|
|
3844
|
+
command: "f5xcctl default signup create -f {file}.yaml",
|
|
3845
|
+
description: "Create from YAML file",
|
|
3846
|
+
use_case: "file_based",
|
|
3847
|
+
},
|
|
3848
|
+
{
|
|
3849
|
+
command: "f5xcctl default signup create {name} --namespace {namespace}",
|
|
3850
|
+
description: "Create signup",
|
|
3851
|
+
use_case: "basic_create",
|
|
3852
|
+
},
|
|
3853
|
+
],
|
|
3854
|
+
confirmationRequired: false,
|
|
3855
|
+
parameterExamples: {},
|
|
3856
|
+
validationRules: {},
|
|
3857
|
+
operationMetadata: {
|
|
3858
|
+
common_errors: [
|
|
3859
|
+
{
|
|
3860
|
+
code: 401,
|
|
3861
|
+
message: "Authentication required",
|
|
3862
|
+
solution: "Provide valid API credentials",
|
|
3863
|
+
},
|
|
3864
|
+
{
|
|
3865
|
+
code: 403,
|
|
3866
|
+
message: "Permission denied",
|
|
3867
|
+
solution: "Check access permissions for this operation",
|
|
3868
|
+
},
|
|
3869
|
+
{
|
|
3870
|
+
code: 404,
|
|
3871
|
+
message: "Resource not found",
|
|
3872
|
+
solution: "Verify resource name, namespace, and path",
|
|
3873
|
+
},
|
|
3874
|
+
{
|
|
3875
|
+
code: 409,
|
|
3876
|
+
message: "Resource already exists",
|
|
3877
|
+
solution: "Use different name or update existing resource",
|
|
3878
|
+
},
|
|
3879
|
+
{
|
|
3880
|
+
code: 429,
|
|
3881
|
+
message: "Rate limit exceeded",
|
|
3882
|
+
solution: "Wait before retrying the operation",
|
|
3883
|
+
},
|
|
3884
|
+
{
|
|
3885
|
+
code: 500,
|
|
3886
|
+
message: "Server error",
|
|
3887
|
+
solution: "Retry operation or contact support",
|
|
3888
|
+
},
|
|
3889
|
+
],
|
|
3890
|
+
conditions: {
|
|
3891
|
+
postconditions: ["Signup resource created", "Resource assigned unique identifier"],
|
|
3892
|
+
prerequisites: ["Active namespace"],
|
|
3893
|
+
},
|
|
3894
|
+
confirmation_required: false,
|
|
3895
|
+
danger_level: "medium",
|
|
3896
|
+
examples: [
|
|
3897
|
+
{
|
|
3898
|
+
command: "f5xcctl default signup create {name} --namespace {namespace}",
|
|
3899
|
+
description: "Create signup",
|
|
3900
|
+
use_case: "basic_create",
|
|
3901
|
+
},
|
|
3902
|
+
{
|
|
3903
|
+
command: "f5xcctl default signup create -f {file}.yaml",
|
|
3904
|
+
description: "Create from YAML file",
|
|
3905
|
+
use_case: "file_based",
|
|
3906
|
+
},
|
|
3907
|
+
],
|
|
3908
|
+
field_docs: {},
|
|
3909
|
+
optional_fields: [],
|
|
3910
|
+
performance_impact: {
|
|
3911
|
+
latency: "low",
|
|
3912
|
+
resource_usage: "low",
|
|
3913
|
+
},
|
|
3914
|
+
purpose: "Create new signup",
|
|
3915
|
+
required_fields: ["metadata.name", "metadata.namespace"],
|
|
3916
|
+
side_effects: {
|
|
3917
|
+
creates: ["signup"],
|
|
3918
|
+
},
|
|
3919
|
+
},
|
|
3920
|
+
},
|
|
3921
|
+
{
|
|
3922
|
+
toolName: "f5xc-api-marketplace-statu-list",
|
|
3923
|
+
method: "GET",
|
|
3924
|
+
path: "/api/config/namespaces/{namespace}/terraform_parameters/{view_kind}/{view_name}/status",
|
|
3925
|
+
operation: "list",
|
|
3926
|
+
domain: "marketplace",
|
|
3927
|
+
resource: "statu",
|
|
3928
|
+
summary: "GET Status of Terraform for view.",
|
|
3929
|
+
description: "Returned from list of terraform parameter status objects for a given view.",
|
|
3930
|
+
pathParameters: [
|
|
3931
|
+
{
|
|
3932
|
+
description: "Namespace\nNamespace for the label to be retrieved.",
|
|
3933
|
+
in: "path",
|
|
3934
|
+
name: "namespace",
|
|
3935
|
+
required: true,
|
|
3936
|
+
schema: {
|
|
3937
|
+
type: "string",
|
|
3938
|
+
},
|
|
3939
|
+
"x-displayname": "Namespace",
|
|
3940
|
+
"x-ves-example": "Value",
|
|
3941
|
+
},
|
|
3942
|
+
{
|
|
3943
|
+
description: "Kind of View\nKind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
|
|
3944
|
+
in: "path",
|
|
3945
|
+
name: "view_kind",
|
|
3946
|
+
required: true,
|
|
3947
|
+
schema: {
|
|
3948
|
+
type: "string",
|
|
3949
|
+
},
|
|
3950
|
+
"x-displayname": "Kind of View.",
|
|
3951
|
+
"x-ves-example": "Value",
|
|
3952
|
+
},
|
|
3953
|
+
{
|
|
3954
|
+
description: "Name of view\nName of the view for which terraform parameters are requested.",
|
|
3955
|
+
in: "path",
|
|
3956
|
+
name: "view_name",
|
|
3957
|
+
required: true,
|
|
3958
|
+
schema: {
|
|
3959
|
+
type: "string",
|
|
3960
|
+
},
|
|
3961
|
+
"x-displayname": "Name of view.",
|
|
3962
|
+
"x-ves-example": "Value",
|
|
3963
|
+
},
|
|
3964
|
+
],
|
|
3965
|
+
queryParameters: [],
|
|
3966
|
+
requestBodySchema: null,
|
|
3967
|
+
responseSchema: {
|
|
3968
|
+
$ref: "#/components/schemas/terraform_parametersGetStatusResponse",
|
|
3969
|
+
},
|
|
3970
|
+
requiredParams: ["namespace", "view_kind", "view_name"],
|
|
3971
|
+
operationId: "ves.io.schema.views.terraform_parameters.CustomAPI.GetStatus",
|
|
3972
|
+
tags: ["Other"],
|
|
3973
|
+
sourceFile: "domains/marketplace.json",
|
|
3974
|
+
displayName: null,
|
|
3975
|
+
dangerLevel: "low",
|
|
3976
|
+
sideEffects: null,
|
|
3977
|
+
requiredFields: ["path.namespace", "path.view_kind", "path.view_name"],
|
|
3978
|
+
cliExamples: [
|
|
3979
|
+
{
|
|
3980
|
+
command: "f5xcctl config statu list --namespace {namespace}",
|
|
3981
|
+
description: "List all status",
|
|
3982
|
+
use_case: "list_all",
|
|
3983
|
+
},
|
|
3984
|
+
],
|
|
3985
|
+
confirmationRequired: false,
|
|
3986
|
+
parameterExamples: {
|
|
3987
|
+
namespace: "Value",
|
|
3988
|
+
view_kind: "Value",
|
|
3989
|
+
view_name: "Value",
|
|
3990
|
+
},
|
|
3991
|
+
validationRules: {},
|
|
3992
|
+
operationMetadata: {
|
|
3993
|
+
common_errors: [
|
|
3994
|
+
{
|
|
3995
|
+
code: 401,
|
|
3996
|
+
message: "Authentication required",
|
|
3997
|
+
solution: "Provide valid API credentials",
|
|
3998
|
+
},
|
|
3999
|
+
{
|
|
4000
|
+
code: 403,
|
|
4001
|
+
message: "Permission denied",
|
|
4002
|
+
solution: "Check access permissions for this operation",
|
|
4003
|
+
},
|
|
4004
|
+
{
|
|
4005
|
+
code: 404,
|
|
4006
|
+
message: "Resource not found",
|
|
4007
|
+
solution: "Verify resource name, namespace, and path",
|
|
4008
|
+
},
|
|
4009
|
+
{
|
|
4010
|
+
code: 409,
|
|
4011
|
+
message: "Resource already exists",
|
|
4012
|
+
solution: "Use different name or update existing resource",
|
|
4013
|
+
},
|
|
4014
|
+
{
|
|
4015
|
+
code: 429,
|
|
4016
|
+
message: "Rate limit exceeded",
|
|
4017
|
+
solution: "Wait before retrying the operation",
|
|
4018
|
+
},
|
|
4019
|
+
{
|
|
4020
|
+
code: 500,
|
|
4021
|
+
message: "Server error",
|
|
4022
|
+
solution: "Retry operation or contact support",
|
|
4023
|
+
},
|
|
4024
|
+
],
|
|
4025
|
+
conditions: {
|
|
4026
|
+
postconditions: [],
|
|
4027
|
+
prerequisites: ["Active namespace"],
|
|
4028
|
+
},
|
|
4029
|
+
confirmation_required: false,
|
|
4030
|
+
danger_level: "low",
|
|
4031
|
+
examples: [
|
|
4032
|
+
{
|
|
4033
|
+
command: "f5xcctl config statu list --namespace {namespace}",
|
|
4034
|
+
description: "List all status",
|
|
4035
|
+
use_case: "list_all",
|
|
4036
|
+
},
|
|
4037
|
+
],
|
|
4038
|
+
field_docs: {},
|
|
4039
|
+
optional_fields: [],
|
|
4040
|
+
performance_impact: {
|
|
4041
|
+
latency: "moderate",
|
|
4042
|
+
resource_usage: "moderate",
|
|
4043
|
+
},
|
|
4044
|
+
purpose: "List all status",
|
|
4045
|
+
required_fields: ["path.namespace", "path.view_kind", "path.view_name"],
|
|
4046
|
+
side_effects: {},
|
|
4047
|
+
},
|
|
4048
|
+
},
|
|
4049
|
+
{
|
|
4050
|
+
toolName: "f5xc-api-marketplace-third-party-application-get",
|
|
4051
|
+
method: "GET",
|
|
4052
|
+
path: "/api/config/namespaces/{namespace}/third_party_applications/{name}",
|
|
4053
|
+
operation: "get",
|
|
4054
|
+
domain: "marketplace",
|
|
4055
|
+
resource: "third-party-application",
|
|
4056
|
+
summary: "GET Third Party Application.",
|
|
4057
|
+
description: "Shape of the Third Party Application specification.",
|
|
4058
|
+
pathParameters: [
|
|
4059
|
+
{
|
|
4060
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
4061
|
+
in: "path",
|
|
4062
|
+
name: "name",
|
|
4063
|
+
required: true,
|
|
4064
|
+
schema: {
|
|
4065
|
+
type: "string",
|
|
4066
|
+
},
|
|
4067
|
+
"x-displayname": "Name",
|
|
4068
|
+
"x-ves-example": "Name",
|
|
4069
|
+
},
|
|
4070
|
+
{
|
|
4071
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
4072
|
+
in: "path",
|
|
4073
|
+
name: "namespace",
|
|
4074
|
+
required: true,
|
|
4075
|
+
schema: {
|
|
4076
|
+
type: "string",
|
|
4077
|
+
},
|
|
4078
|
+
"x-displayname": "Namespace",
|
|
4079
|
+
"x-ves-example": "Ns1",
|
|
4080
|
+
},
|
|
4081
|
+
],
|
|
4082
|
+
queryParameters: [
|
|
4083
|
+
{
|
|
4084
|
+
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 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.",
|
|
4085
|
+
in: "query",
|
|
4086
|
+
name: "response_format",
|
|
4087
|
+
required: false,
|
|
4088
|
+
schema: {
|
|
4089
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
4090
|
+
enum: [
|
|
4091
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
4092
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
4093
|
+
"GET_RSP_FORMAT_STATUS",
|
|
4094
|
+
"GET_RSP_FORMAT_READ",
|
|
4095
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
4096
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
4097
|
+
],
|
|
4098
|
+
type: "string",
|
|
4099
|
+
},
|
|
4100
|
+
"x-displayname": "Broken Referred Objects.",
|
|
4101
|
+
},
|
|
4102
|
+
],
|
|
4103
|
+
requestBodySchema: null,
|
|
4104
|
+
responseSchema: {
|
|
4105
|
+
$ref: "#/components/schemas/third_party_applicationGetResponse",
|
|
4106
|
+
},
|
|
4107
|
+
requiredParams: ["name", "namespace"],
|
|
4108
|
+
operationId: "ves.io.schema.views.third_party_application.API.Get",
|
|
4109
|
+
tags: ["Other"],
|
|
4110
|
+
sourceFile: "domains/marketplace.json",
|
|
4111
|
+
displayName: null,
|
|
4112
|
+
dangerLevel: "low",
|
|
4113
|
+
sideEffects: null,
|
|
4114
|
+
requiredFields: ["path.name", "path.namespace"],
|
|
4115
|
+
cliExamples: [
|
|
4116
|
+
{
|
|
4117
|
+
command: "f5xcctl config third-party-application get {name} --namespace {namespace}",
|
|
4118
|
+
description: "Get specific third-party-application",
|
|
4119
|
+
use_case: "get_specific",
|
|
4120
|
+
},
|
|
4121
|
+
],
|
|
4122
|
+
confirmationRequired: false,
|
|
4123
|
+
parameterExamples: {
|
|
4124
|
+
name: "Name",
|
|
4125
|
+
namespace: "Ns1",
|
|
4126
|
+
},
|
|
4127
|
+
validationRules: {},
|
|
4128
|
+
operationMetadata: {
|
|
4129
|
+
common_errors: [
|
|
4130
|
+
{
|
|
4131
|
+
code: 401,
|
|
4132
|
+
message: "Authentication required",
|
|
4133
|
+
solution: "Provide valid API credentials",
|
|
4134
|
+
},
|
|
4135
|
+
{
|
|
4136
|
+
code: 403,
|
|
4137
|
+
message: "Permission denied",
|
|
4138
|
+
solution: "Check access permissions for this operation",
|
|
4139
|
+
},
|
|
4140
|
+
{
|
|
4141
|
+
code: 404,
|
|
4142
|
+
message: "Resource not found",
|
|
4143
|
+
solution: "Verify resource name, namespace, and path",
|
|
4144
|
+
},
|
|
4145
|
+
{
|
|
4146
|
+
code: 409,
|
|
4147
|
+
message: "Resource already exists",
|
|
4148
|
+
solution: "Use different name or update existing resource",
|
|
4149
|
+
},
|
|
4150
|
+
{
|
|
4151
|
+
code: 429,
|
|
4152
|
+
message: "Rate limit exceeded",
|
|
4153
|
+
solution: "Wait before retrying the operation",
|
|
4154
|
+
},
|
|
4155
|
+
{
|
|
4156
|
+
code: 500,
|
|
4157
|
+
message: "Server error",
|
|
4158
|
+
solution: "Retry operation or contact support",
|
|
4159
|
+
},
|
|
4160
|
+
],
|
|
4161
|
+
conditions: {
|
|
4162
|
+
postconditions: [],
|
|
4163
|
+
prerequisites: ["Active namespace"],
|
|
4164
|
+
},
|
|
4165
|
+
confirmation_required: false,
|
|
4166
|
+
danger_level: "low",
|
|
4167
|
+
examples: [
|
|
4168
|
+
{
|
|
4169
|
+
command: "f5xcctl config third-party-application get {name} --namespace {namespace}",
|
|
4170
|
+
description: "Get specific third-party-application",
|
|
4171
|
+
use_case: "get_specific",
|
|
4172
|
+
},
|
|
4173
|
+
],
|
|
4174
|
+
field_docs: {},
|
|
4175
|
+
optional_fields: [],
|
|
4176
|
+
performance_impact: {
|
|
4177
|
+
latency: "low",
|
|
4178
|
+
resource_usage: "low",
|
|
4179
|
+
},
|
|
4180
|
+
purpose: "Retrieve specific third-party-application",
|
|
4181
|
+
required_fields: ["path.name", "path.namespace"],
|
|
4182
|
+
side_effects: {},
|
|
4183
|
+
},
|
|
4184
|
+
},
|
|
4185
|
+
{
|
|
4186
|
+
toolName: "f5xc-api-marketplace-third-party-application-list",
|
|
4187
|
+
method: "GET",
|
|
4188
|
+
path: "/api/config/namespaces/{namespace}/third_party_applications",
|
|
4189
|
+
operation: "list",
|
|
4190
|
+
domain: "marketplace",
|
|
4191
|
+
resource: "third-party-application",
|
|
4192
|
+
summary: "List Third Party Application.",
|
|
4193
|
+
description: "List the set of third_party_application in a namespace.",
|
|
4194
|
+
pathParameters: [
|
|
4195
|
+
{
|
|
4196
|
+
description: "Namespace\nNamespace to scope the listing of third_party_application.",
|
|
4197
|
+
in: "path",
|
|
4198
|
+
name: "namespace",
|
|
4199
|
+
required: true,
|
|
4200
|
+
schema: {
|
|
4201
|
+
type: "string",
|
|
4202
|
+
},
|
|
4203
|
+
"x-displayname": "Namespace",
|
|
4204
|
+
"x-ves-example": "Ns1",
|
|
4205
|
+
},
|
|
4206
|
+
],
|
|
4207
|
+
queryParameters: [
|
|
4208
|
+
{
|
|
4209
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
4210
|
+
in: "query",
|
|
4211
|
+
name: "label_filter",
|
|
4212
|
+
required: false,
|
|
4213
|
+
schema: {
|
|
4214
|
+
type: "string",
|
|
4215
|
+
},
|
|
4216
|
+
"x-displayname": "Label Filter.",
|
|
4217
|
+
"x-ves-example": "Env in (staging, testing), tier in (web, db)",
|
|
4218
|
+
},
|
|
4219
|
+
{
|
|
4220
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
4221
|
+
in: "query",
|
|
4222
|
+
name: "report_fields",
|
|
4223
|
+
required: false,
|
|
4224
|
+
schema: {
|
|
4225
|
+
items: {
|
|
4226
|
+
type: "string",
|
|
4227
|
+
},
|
|
4228
|
+
type: "array",
|
|
4229
|
+
},
|
|
4230
|
+
"x-displayname": "Report Fields.",
|
|
4231
|
+
},
|
|
4232
|
+
{
|
|
4233
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
4234
|
+
in: "query",
|
|
4235
|
+
name: "report_status_fields",
|
|
4236
|
+
required: false,
|
|
4237
|
+
schema: {
|
|
4238
|
+
items: {
|
|
4239
|
+
type: "string",
|
|
4240
|
+
},
|
|
4241
|
+
type: "array",
|
|
4242
|
+
},
|
|
4243
|
+
"x-displayname": "Report Status Fields.",
|
|
4244
|
+
},
|
|
4245
|
+
],
|
|
4246
|
+
requestBodySchema: null,
|
|
4247
|
+
responseSchema: {
|
|
4248
|
+
$ref: "#/components/schemas/third_party_applicationListResponse",
|
|
4249
|
+
},
|
|
4250
|
+
requiredParams: ["namespace"],
|
|
4251
|
+
operationId: "ves.io.schema.views.third_party_application.API.List",
|
|
4252
|
+
tags: ["Other"],
|
|
4253
|
+
sourceFile: "domains/marketplace.json",
|
|
4254
|
+
displayName: null,
|
|
4255
|
+
dangerLevel: "low",
|
|
4256
|
+
sideEffects: null,
|
|
4257
|
+
requiredFields: ["path.namespace"],
|
|
4258
|
+
cliExamples: [
|
|
4259
|
+
{
|
|
4260
|
+
command: "f5xcctl config third-party-application list --namespace {namespace}",
|
|
4261
|
+
description: "List all third-party-applications",
|
|
4262
|
+
use_case: "list_all",
|
|
4263
|
+
},
|
|
4264
|
+
],
|
|
4265
|
+
confirmationRequired: false,
|
|
4266
|
+
parameterExamples: {
|
|
4267
|
+
label_filter: "Env in (staging, testing), tier in (web, db)",
|
|
4268
|
+
namespace: "Ns1",
|
|
4269
|
+
},
|
|
4270
|
+
validationRules: {},
|
|
4271
|
+
operationMetadata: {
|
|
4272
|
+
common_errors: [
|
|
4273
|
+
{
|
|
4274
|
+
code: 401,
|
|
4275
|
+
message: "Authentication required",
|
|
4276
|
+
solution: "Provide valid API credentials",
|
|
4277
|
+
},
|
|
4278
|
+
{
|
|
4279
|
+
code: 403,
|
|
4280
|
+
message: "Permission denied",
|
|
4281
|
+
solution: "Check access permissions for this operation",
|
|
4282
|
+
},
|
|
4283
|
+
{
|
|
4284
|
+
code: 404,
|
|
4285
|
+
message: "Resource not found",
|
|
4286
|
+
solution: "Verify resource name, namespace, and path",
|
|
4287
|
+
},
|
|
4288
|
+
{
|
|
4289
|
+
code: 409,
|
|
4290
|
+
message: "Resource already exists",
|
|
4291
|
+
solution: "Use different name or update existing resource",
|
|
4292
|
+
},
|
|
4293
|
+
{
|
|
4294
|
+
code: 429,
|
|
4295
|
+
message: "Rate limit exceeded",
|
|
4296
|
+
solution: "Wait before retrying the operation",
|
|
4297
|
+
},
|
|
4298
|
+
{
|
|
4299
|
+
code: 500,
|
|
4300
|
+
message: "Server error",
|
|
4301
|
+
solution: "Retry operation or contact support",
|
|
4302
|
+
},
|
|
4303
|
+
],
|
|
4304
|
+
conditions: {
|
|
4305
|
+
postconditions: [],
|
|
4306
|
+
prerequisites: ["Active namespace"],
|
|
4307
|
+
},
|
|
4308
|
+
confirmation_required: false,
|
|
4309
|
+
danger_level: "low",
|
|
4310
|
+
examples: [
|
|
4311
|
+
{
|
|
4312
|
+
command: "f5xcctl config third-party-application list --namespace {namespace}",
|
|
4313
|
+
description: "List all third-party-applications",
|
|
4314
|
+
use_case: "list_all",
|
|
4315
|
+
},
|
|
4316
|
+
],
|
|
4317
|
+
field_docs: {},
|
|
4318
|
+
optional_fields: [],
|
|
4319
|
+
performance_impact: {
|
|
4320
|
+
latency: "moderate",
|
|
4321
|
+
resource_usage: "moderate",
|
|
4322
|
+
},
|
|
4323
|
+
purpose: "List all third-party-applications",
|
|
4324
|
+
required_fields: ["path.namespace"],
|
|
4325
|
+
side_effects: {},
|
|
4326
|
+
},
|
|
4327
|
+
},
|
|
4328
|
+
{
|
|
4329
|
+
toolName: "f5xc-api-marketplace-third-party-application-update",
|
|
4330
|
+
method: "PUT",
|
|
4331
|
+
path: "/api/config/namespaces/{metadata.namespace}/third_party_applications/{metadata.name}",
|
|
4332
|
+
operation: "update",
|
|
4333
|
+
domain: "marketplace",
|
|
4334
|
+
resource: "third-party-application",
|
|
4335
|
+
summary: "Replace Third Party Applicationr.",
|
|
4336
|
+
description: "Shape of the Third Party Application specification.",
|
|
4337
|
+
pathParameters: [
|
|
4338
|
+
{
|
|
4339
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
4340
|
+
in: "path",
|
|
4341
|
+
name: "metadata.name",
|
|
4342
|
+
required: true,
|
|
4343
|
+
schema: {
|
|
4344
|
+
type: "string",
|
|
4345
|
+
},
|
|
4346
|
+
"x-displayname": "Name",
|
|
4347
|
+
"x-ves-example": "Example-corp-web.",
|
|
4348
|
+
},
|
|
4349
|
+
{
|
|
4350
|
+
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 ""',
|
|
4351
|
+
in: "path",
|
|
4352
|
+
name: "metadata.namespace",
|
|
4353
|
+
required: true,
|
|
4354
|
+
schema: {
|
|
4355
|
+
type: "string",
|
|
4356
|
+
},
|
|
4357
|
+
"x-displayname": "Namespace",
|
|
4358
|
+
"x-ves-example": "Staging",
|
|
4359
|
+
},
|
|
4360
|
+
],
|
|
4361
|
+
queryParameters: [],
|
|
4362
|
+
requestBodySchema: {
|
|
4363
|
+
$ref: "#/components/schemas/third_party_applicationReplaceRequest",
|
|
4364
|
+
},
|
|
4365
|
+
responseSchema: {
|
|
4366
|
+
$ref: "#/components/schemas/third_party_applicationReplaceResponse",
|
|
4367
|
+
},
|
|
4368
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
4369
|
+
operationId: "ves.io.schema.views.third_party_application.API.Replace",
|
|
4370
|
+
tags: ["Other"],
|
|
4371
|
+
sourceFile: "domains/marketplace.json",
|
|
4372
|
+
displayName: null,
|
|
4373
|
+
dangerLevel: "medium",
|
|
4374
|
+
sideEffects: {
|
|
4375
|
+
modifies: ["third-party-application"],
|
|
4376
|
+
},
|
|
4377
|
+
requiredFields: ["path.metadata.name", "path.metadata.namespace"],
|
|
4378
|
+
cliExamples: [
|
|
4379
|
+
{
|
|
4380
|
+
command: "f5xcctl config third-party-application update {name} --namespace {namespace} -f {file}.yaml",
|
|
4381
|
+
description: "Update third-party-application",
|
|
4382
|
+
use_case: "update",
|
|
4383
|
+
},
|
|
4384
|
+
],
|
|
4385
|
+
confirmationRequired: false,
|
|
4386
|
+
parameterExamples: {
|
|
4387
|
+
"metadata.name": "Example-corp-web.",
|
|
4388
|
+
"metadata.namespace": "Staging",
|
|
4389
|
+
},
|
|
4390
|
+
validationRules: {},
|
|
4391
|
+
operationMetadata: {
|
|
4392
|
+
common_errors: [
|
|
4393
|
+
{
|
|
4394
|
+
code: 401,
|
|
4395
|
+
message: "Authentication required",
|
|
4396
|
+
solution: "Provide valid API credentials",
|
|
4397
|
+
},
|
|
4398
|
+
{
|
|
4399
|
+
code: 403,
|
|
4400
|
+
message: "Permission denied",
|
|
4401
|
+
solution: "Check access permissions for this operation",
|
|
4402
|
+
},
|
|
4403
|
+
{
|
|
4404
|
+
code: 404,
|
|
4405
|
+
message: "Resource not found",
|
|
4406
|
+
solution: "Verify resource name, namespace, and path",
|
|
4407
|
+
},
|
|
4408
|
+
{
|
|
4409
|
+
code: 409,
|
|
4410
|
+
message: "Resource already exists",
|
|
4411
|
+
solution: "Use different name or update existing resource",
|
|
4412
|
+
},
|
|
4413
|
+
{
|
|
4414
|
+
code: 429,
|
|
4415
|
+
message: "Rate limit exceeded",
|
|
4416
|
+
solution: "Wait before retrying the operation",
|
|
4417
|
+
},
|
|
4418
|
+
{
|
|
4419
|
+
code: 500,
|
|
4420
|
+
message: "Server error",
|
|
4421
|
+
solution: "Retry operation or contact support",
|
|
4422
|
+
},
|
|
4423
|
+
],
|
|
4424
|
+
conditions: {
|
|
4425
|
+
postconditions: ["Resource updated with new values"],
|
|
4426
|
+
prerequisites: ["Active namespace"],
|
|
4427
|
+
},
|
|
4428
|
+
confirmation_required: false,
|
|
4429
|
+
danger_level: "medium",
|
|
4430
|
+
examples: [
|
|
4431
|
+
{
|
|
4432
|
+
command: "f5xcctl config third-party-application update {name} --namespace {namespace} -f {file}.yaml",
|
|
4433
|
+
description: "Update third-party-application",
|
|
4434
|
+
use_case: "update",
|
|
4435
|
+
},
|
|
4436
|
+
],
|
|
4437
|
+
field_docs: {},
|
|
4438
|
+
optional_fields: [],
|
|
4439
|
+
performance_impact: {
|
|
4440
|
+
latency: "low",
|
|
4441
|
+
resource_usage: "low",
|
|
4442
|
+
},
|
|
4443
|
+
purpose: "Replace existing third-party-application",
|
|
4444
|
+
required_fields: ["path.metadata.name", "path.metadata.namespace"],
|
|
4445
|
+
side_effects: {
|
|
4446
|
+
modifies: ["third-party-application"],
|
|
4447
|
+
},
|
|
4448
|
+
},
|
|
4449
|
+
},
|
|
4450
|
+
{
|
|
4451
|
+
toolName: "f5xc-api-marketplace-view-kind-list",
|
|
4452
|
+
method: "GET",
|
|
4453
|
+
path: "/api/config/namespaces/{namespace}/terraform_parameters/{view_kind}/{view_name}",
|
|
4454
|
+
operation: "list",
|
|
4455
|
+
domain: "marketplace",
|
|
4456
|
+
resource: "{view-kind}",
|
|
4457
|
+
summary: "GET Terraform Parameters for view.",
|
|
4458
|
+
description: "Returned from list of terraform parameter objects for a given view.",
|
|
4459
|
+
pathParameters: [
|
|
4460
|
+
{
|
|
4461
|
+
description: "Namespace\nNamespace for the label to be retrieved.",
|
|
4462
|
+
in: "path",
|
|
4463
|
+
name: "namespace",
|
|
4464
|
+
required: true,
|
|
4465
|
+
schema: {
|
|
4466
|
+
type: "string",
|
|
4467
|
+
},
|
|
4468
|
+
"x-displayname": "Namespace",
|
|
4469
|
+
"x-ves-example": "Value",
|
|
4470
|
+
},
|
|
4471
|
+
{
|
|
4472
|
+
description: "Kind of View\nKind of view of which terraform parameters are requested e.g. Aws_vpc_site, azure_vnet_site.",
|
|
4473
|
+
in: "path",
|
|
4474
|
+
name: "view_kind",
|
|
4475
|
+
required: true,
|
|
4476
|
+
schema: {
|
|
4477
|
+
type: "string",
|
|
4478
|
+
},
|
|
4479
|
+
"x-displayname": "Kind of View.",
|
|
4480
|
+
"x-ves-example": "Value",
|
|
4481
|
+
},
|
|
4482
|
+
{
|
|
4483
|
+
description: "Name of view\nName of the view for which terraform parameters are requested.",
|
|
4484
|
+
in: "path",
|
|
4485
|
+
name: "view_name",
|
|
4486
|
+
required: true,
|
|
4487
|
+
schema: {
|
|
4488
|
+
type: "string",
|
|
4489
|
+
},
|
|
4490
|
+
"x-displayname": "Name of view.",
|
|
4491
|
+
"x-ves-example": "Value",
|
|
4492
|
+
},
|
|
4493
|
+
],
|
|
4494
|
+
queryParameters: [],
|
|
4495
|
+
requestBodySchema: null,
|
|
4496
|
+
responseSchema: {
|
|
4497
|
+
$ref: "#/components/schemas/terraform_parametersGetResponse",
|
|
4498
|
+
},
|
|
4499
|
+
requiredParams: ["namespace", "view_kind", "view_name"],
|
|
4500
|
+
operationId: "ves.io.schema.views.terraform_parameters.CustomAPI.Get",
|
|
4501
|
+
tags: ["Other"],
|
|
4502
|
+
sourceFile: "domains/marketplace.json",
|
|
4503
|
+
displayName: null,
|
|
4504
|
+
dangerLevel: "low",
|
|
4505
|
+
sideEffects: null,
|
|
4506
|
+
requiredFields: ["path.namespace", "path.view_kind", "path.view_name"],
|
|
4507
|
+
cliExamples: [
|
|
4508
|
+
{
|
|
4509
|
+
command: "f5xcctl config terraform-parameter list --namespace {namespace}",
|
|
4510
|
+
description: "List all terraform-parameters",
|
|
4511
|
+
use_case: "list_all",
|
|
4512
|
+
},
|
|
4513
|
+
],
|
|
4514
|
+
confirmationRequired: false,
|
|
4515
|
+
parameterExamples: {
|
|
4516
|
+
namespace: "Value",
|
|
4517
|
+
view_kind: "Value",
|
|
4518
|
+
view_name: "Value",
|
|
4519
|
+
},
|
|
4520
|
+
validationRules: {},
|
|
4521
|
+
operationMetadata: {
|
|
4522
|
+
common_errors: [
|
|
4523
|
+
{
|
|
4524
|
+
code: 401,
|
|
4525
|
+
message: "Authentication required",
|
|
4526
|
+
solution: "Provide valid API credentials",
|
|
4527
|
+
},
|
|
4528
|
+
{
|
|
4529
|
+
code: 403,
|
|
4530
|
+
message: "Permission denied",
|
|
4531
|
+
solution: "Check access permissions for this operation",
|
|
4532
|
+
},
|
|
4533
|
+
{
|
|
4534
|
+
code: 404,
|
|
4535
|
+
message: "Resource not found",
|
|
4536
|
+
solution: "Verify resource name, namespace, and path",
|
|
4537
|
+
},
|
|
4538
|
+
{
|
|
4539
|
+
code: 409,
|
|
4540
|
+
message: "Resource already exists",
|
|
4541
|
+
solution: "Use different name or update existing resource",
|
|
4542
|
+
},
|
|
4543
|
+
{
|
|
4544
|
+
code: 429,
|
|
4545
|
+
message: "Rate limit exceeded",
|
|
4546
|
+
solution: "Wait before retrying the operation",
|
|
4547
|
+
},
|
|
4548
|
+
{
|
|
4549
|
+
code: 500,
|
|
4550
|
+
message: "Server error",
|
|
4551
|
+
solution: "Retry operation or contact support",
|
|
4552
|
+
},
|
|
4553
|
+
],
|
|
4554
|
+
conditions: {
|
|
4555
|
+
postconditions: [],
|
|
4556
|
+
prerequisites: ["Active namespace"],
|
|
4557
|
+
},
|
|
4558
|
+
confirmation_required: false,
|
|
4559
|
+
danger_level: "low",
|
|
4560
|
+
examples: [
|
|
4561
|
+
{
|
|
4562
|
+
command: "f5xcctl config terraform-parameter list --namespace {namespace}",
|
|
4563
|
+
description: "List all terraform-parameters",
|
|
4564
|
+
use_case: "list_all",
|
|
4565
|
+
},
|
|
4566
|
+
],
|
|
4567
|
+
field_docs: {},
|
|
4568
|
+
optional_fields: [],
|
|
4569
|
+
performance_impact: {
|
|
4570
|
+
latency: "low",
|
|
4571
|
+
resource_usage: "low",
|
|
4572
|
+
},
|
|
4573
|
+
purpose: "List all terraform-parameters",
|
|
4574
|
+
required_fields: ["path.namespace", "path.view_kind", "path.view_name"],
|
|
4575
|
+
side_effects: {},
|
|
4576
|
+
},
|
|
4577
|
+
},
|
|
4578
|
+
];
|
|
4579
|
+
export default marketplaceTools;
|
|
4580
|
+
//# sourceMappingURL=index.js.map
|