@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,1055 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for object_storage domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const object_storageTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-objectstorage-mobile-app-shield-list",
|
|
8
|
+
method: "GET",
|
|
9
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield",
|
|
10
|
+
operation: "list",
|
|
11
|
+
domain: "object_storage",
|
|
12
|
+
resource: "mobile-app-shield",
|
|
13
|
+
summary: "GET List Of Mobile App Shields.",
|
|
14
|
+
description: "ListMobileAppShields is an API to list all mobile app shields available for download.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
description: "Namespace\nx-required\nNamespace of the stored_object.",
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "namespace",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
"x-displayname": "Namespace",
|
|
25
|
+
"x-ves-example": "System",
|
|
26
|
+
},
|
|
27
|
+
],
|
|
28
|
+
queryParameters: [
|
|
29
|
+
{
|
|
30
|
+
description: "Optional query parameter. If passed, returns only latest version of the objects.",
|
|
31
|
+
in: "query",
|
|
32
|
+
name: "latest_version_only",
|
|
33
|
+
required: false,
|
|
34
|
+
schema: {
|
|
35
|
+
format: "boolean",
|
|
36
|
+
type: "boolean",
|
|
37
|
+
},
|
|
38
|
+
"x-displayname": "Latest Versions Only.",
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
description: "Optional query parameter. Name of the stored_object.",
|
|
42
|
+
in: "query",
|
|
43
|
+
name: "name",
|
|
44
|
+
required: false,
|
|
45
|
+
schema: {
|
|
46
|
+
type: "string",
|
|
47
|
+
},
|
|
48
|
+
"x-displayname": "Name",
|
|
49
|
+
"x-ves-example": "Example-file, shared/example-file, example-ns/example-file.",
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
description: "Optional query parameter. Type of the stored_object.",
|
|
53
|
+
in: "query",
|
|
54
|
+
name: "object_type",
|
|
55
|
+
required: false,
|
|
56
|
+
schema: {
|
|
57
|
+
type: "string",
|
|
58
|
+
},
|
|
59
|
+
"x-displayname": "Object Type.",
|
|
60
|
+
"x-ves-example": "Swagger",
|
|
61
|
+
},
|
|
62
|
+
{
|
|
63
|
+
description: "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.",
|
|
64
|
+
in: "query",
|
|
65
|
+
name: "query_type",
|
|
66
|
+
required: false,
|
|
67
|
+
schema: {
|
|
68
|
+
default: "EXACT_MATCH",
|
|
69
|
+
enum: ["EXACT_MATCH", "PREFIX_MATCH"],
|
|
70
|
+
type: "string",
|
|
71
|
+
},
|
|
72
|
+
"x-displayname": "PREFIX MATCH.",
|
|
73
|
+
},
|
|
74
|
+
],
|
|
75
|
+
requestBodySchema: null,
|
|
76
|
+
responseSchema: {
|
|
77
|
+
$ref: "#/components/schemas/stored_objectListObjectsResponse",
|
|
78
|
+
},
|
|
79
|
+
requiredParams: ["namespace"],
|
|
80
|
+
operationId: "ves.io.schema.stored_object.MobileAppShieldCustomAPI.ListMobileAppShields",
|
|
81
|
+
tags: ["Other"],
|
|
82
|
+
sourceFile: "domains/object_storage.json",
|
|
83
|
+
displayName: null,
|
|
84
|
+
dangerLevel: "low",
|
|
85
|
+
sideEffects: null,
|
|
86
|
+
requiredFields: ["path.namespace"],
|
|
87
|
+
cliExamples: [
|
|
88
|
+
{
|
|
89
|
+
command: "f5xcctl object_store mobile-app-shield list --namespace {namespace}",
|
|
90
|
+
description: "List all mobile-app-shields",
|
|
91
|
+
use_case: "list_all",
|
|
92
|
+
},
|
|
93
|
+
],
|
|
94
|
+
confirmationRequired: false,
|
|
95
|
+
parameterExamples: {
|
|
96
|
+
name: "Example-file, shared/example-file, example-ns/example-file.",
|
|
97
|
+
namespace: "System",
|
|
98
|
+
object_type: "Swagger",
|
|
99
|
+
},
|
|
100
|
+
validationRules: {},
|
|
101
|
+
operationMetadata: {
|
|
102
|
+
common_errors: [
|
|
103
|
+
{
|
|
104
|
+
code: 401,
|
|
105
|
+
message: "Authentication required",
|
|
106
|
+
solution: "Provide valid API credentials",
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
code: 403,
|
|
110
|
+
message: "Permission denied",
|
|
111
|
+
solution: "Check access permissions for this operation",
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
code: 404,
|
|
115
|
+
message: "Resource not found",
|
|
116
|
+
solution: "Verify resource name, namespace, and path",
|
|
117
|
+
},
|
|
118
|
+
{
|
|
119
|
+
code: 409,
|
|
120
|
+
message: "Resource already exists",
|
|
121
|
+
solution: "Use different name or update existing resource",
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
code: 429,
|
|
125
|
+
message: "Rate limit exceeded",
|
|
126
|
+
solution: "Wait before retrying the operation",
|
|
127
|
+
},
|
|
128
|
+
{
|
|
129
|
+
code: 500,
|
|
130
|
+
message: "Server error",
|
|
131
|
+
solution: "Retry operation or contact support",
|
|
132
|
+
},
|
|
133
|
+
],
|
|
134
|
+
conditions: {
|
|
135
|
+
postconditions: [],
|
|
136
|
+
prerequisites: ["Active namespace"],
|
|
137
|
+
},
|
|
138
|
+
confirmation_required: false,
|
|
139
|
+
danger_level: "low",
|
|
140
|
+
examples: [
|
|
141
|
+
{
|
|
142
|
+
command: "f5xcctl object_store mobile-app-shield list --namespace {namespace}",
|
|
143
|
+
description: "List all mobile-app-shields",
|
|
144
|
+
use_case: "list_all",
|
|
145
|
+
},
|
|
146
|
+
],
|
|
147
|
+
field_docs: {},
|
|
148
|
+
optional_fields: [],
|
|
149
|
+
performance_impact: {
|
|
150
|
+
latency: "moderate",
|
|
151
|
+
resource_usage: "moderate",
|
|
152
|
+
},
|
|
153
|
+
purpose: "List all mobile-app-shields",
|
|
154
|
+
required_fields: ["path.namespace"],
|
|
155
|
+
side_effects: {},
|
|
156
|
+
},
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
toolName: "f5xc-api-objectstorage-mobile-integrator-list",
|
|
160
|
+
method: "GET",
|
|
161
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/mobile-integrator",
|
|
162
|
+
operation: "list",
|
|
163
|
+
domain: "object_storage",
|
|
164
|
+
resource: "mobile-integrator",
|
|
165
|
+
summary: "GET List Of Mobile Integrators.",
|
|
166
|
+
description: "ListMobileIntegrators is an API to list all mobile integrators available for download.",
|
|
167
|
+
pathParameters: [
|
|
168
|
+
{
|
|
169
|
+
description: "Namespace\nx-required\nNamespace of the stored_object.",
|
|
170
|
+
in: "path",
|
|
171
|
+
name: "namespace",
|
|
172
|
+
required: true,
|
|
173
|
+
schema: {
|
|
174
|
+
type: "string",
|
|
175
|
+
},
|
|
176
|
+
"x-displayname": "Namespace",
|
|
177
|
+
"x-ves-example": "System",
|
|
178
|
+
},
|
|
179
|
+
],
|
|
180
|
+
queryParameters: [
|
|
181
|
+
{
|
|
182
|
+
description: "Optional query parameter. If passed, returns only latest version of the objects.",
|
|
183
|
+
in: "query",
|
|
184
|
+
name: "latest_version_only",
|
|
185
|
+
required: false,
|
|
186
|
+
schema: {
|
|
187
|
+
format: "boolean",
|
|
188
|
+
type: "boolean",
|
|
189
|
+
},
|
|
190
|
+
"x-displayname": "Latest Versions Only.",
|
|
191
|
+
},
|
|
192
|
+
{
|
|
193
|
+
description: "Optional query parameter. Name of the stored_object.",
|
|
194
|
+
in: "query",
|
|
195
|
+
name: "name",
|
|
196
|
+
required: false,
|
|
197
|
+
schema: {
|
|
198
|
+
type: "string",
|
|
199
|
+
},
|
|
200
|
+
"x-displayname": "Name",
|
|
201
|
+
"x-ves-example": "Example-file, shared/example-file, example-ns/example-file.",
|
|
202
|
+
},
|
|
203
|
+
{
|
|
204
|
+
description: "Optional query parameter. Type of the stored_object.",
|
|
205
|
+
in: "query",
|
|
206
|
+
name: "object_type",
|
|
207
|
+
required: false,
|
|
208
|
+
schema: {
|
|
209
|
+
type: "string",
|
|
210
|
+
},
|
|
211
|
+
"x-displayname": "Object Type.",
|
|
212
|
+
"x-ves-example": "Swagger",
|
|
213
|
+
},
|
|
214
|
+
{
|
|
215
|
+
description: "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.",
|
|
216
|
+
in: "query",
|
|
217
|
+
name: "query_type",
|
|
218
|
+
required: false,
|
|
219
|
+
schema: {
|
|
220
|
+
default: "EXACT_MATCH",
|
|
221
|
+
enum: ["EXACT_MATCH", "PREFIX_MATCH"],
|
|
222
|
+
type: "string",
|
|
223
|
+
},
|
|
224
|
+
"x-displayname": "PREFIX MATCH.",
|
|
225
|
+
},
|
|
226
|
+
],
|
|
227
|
+
requestBodySchema: null,
|
|
228
|
+
responseSchema: {
|
|
229
|
+
$ref: "#/components/schemas/stored_objectListObjectsResponse",
|
|
230
|
+
},
|
|
231
|
+
requiredParams: ["namespace"],
|
|
232
|
+
operationId: "ves.io.schema.stored_object.MobileIntegratorCustomAPI.ListMobileIntegrators",
|
|
233
|
+
tags: ["Other"],
|
|
234
|
+
sourceFile: "domains/object_storage.json",
|
|
235
|
+
displayName: null,
|
|
236
|
+
dangerLevel: "low",
|
|
237
|
+
sideEffects: null,
|
|
238
|
+
requiredFields: ["path.namespace"],
|
|
239
|
+
cliExamples: [
|
|
240
|
+
{
|
|
241
|
+
command: "f5xcctl object_store mobile-integrator list --namespace {namespace}",
|
|
242
|
+
description: "List all mobile-integrators",
|
|
243
|
+
use_case: "list_all",
|
|
244
|
+
},
|
|
245
|
+
],
|
|
246
|
+
confirmationRequired: false,
|
|
247
|
+
parameterExamples: {
|
|
248
|
+
name: "Example-file, shared/example-file, example-ns/example-file.",
|
|
249
|
+
namespace: "System",
|
|
250
|
+
object_type: "Swagger",
|
|
251
|
+
},
|
|
252
|
+
validationRules: {},
|
|
253
|
+
operationMetadata: {
|
|
254
|
+
common_errors: [
|
|
255
|
+
{
|
|
256
|
+
code: 401,
|
|
257
|
+
message: "Authentication required",
|
|
258
|
+
solution: "Provide valid API credentials",
|
|
259
|
+
},
|
|
260
|
+
{
|
|
261
|
+
code: 403,
|
|
262
|
+
message: "Permission denied",
|
|
263
|
+
solution: "Check access permissions for this operation",
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
code: 404,
|
|
267
|
+
message: "Resource not found",
|
|
268
|
+
solution: "Verify resource name, namespace, and path",
|
|
269
|
+
},
|
|
270
|
+
{
|
|
271
|
+
code: 409,
|
|
272
|
+
message: "Resource already exists",
|
|
273
|
+
solution: "Use different name or update existing resource",
|
|
274
|
+
},
|
|
275
|
+
{
|
|
276
|
+
code: 429,
|
|
277
|
+
message: "Rate limit exceeded",
|
|
278
|
+
solution: "Wait before retrying the operation",
|
|
279
|
+
},
|
|
280
|
+
{
|
|
281
|
+
code: 500,
|
|
282
|
+
message: "Server error",
|
|
283
|
+
solution: "Retry operation or contact support",
|
|
284
|
+
},
|
|
285
|
+
],
|
|
286
|
+
conditions: {
|
|
287
|
+
postconditions: [],
|
|
288
|
+
prerequisites: ["Active namespace"],
|
|
289
|
+
},
|
|
290
|
+
confirmation_required: false,
|
|
291
|
+
danger_level: "low",
|
|
292
|
+
examples: [
|
|
293
|
+
{
|
|
294
|
+
command: "f5xcctl object_store mobile-integrator list --namespace {namespace}",
|
|
295
|
+
description: "List all mobile-integrators",
|
|
296
|
+
use_case: "list_all",
|
|
297
|
+
},
|
|
298
|
+
],
|
|
299
|
+
field_docs: {},
|
|
300
|
+
optional_fields: [],
|
|
301
|
+
performance_impact: {
|
|
302
|
+
latency: "moderate",
|
|
303
|
+
resource_usage: "moderate",
|
|
304
|
+
},
|
|
305
|
+
purpose: "List all mobile-integrators",
|
|
306
|
+
required_fields: ["path.namespace"],
|
|
307
|
+
side_effects: {},
|
|
308
|
+
},
|
|
309
|
+
},
|
|
310
|
+
{
|
|
311
|
+
toolName: "f5xc-api-objectstorage-name-delete",
|
|
312
|
+
method: "DELETE",
|
|
313
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}/{version}",
|
|
314
|
+
operation: "delete",
|
|
315
|
+
domain: "object_storage",
|
|
316
|
+
resource: "{name}",
|
|
317
|
+
summary: "DELETE Stored Object(s)",
|
|
318
|
+
description: "DeleteObjects is an API to DELETE object(s) in object store.",
|
|
319
|
+
pathParameters: [
|
|
320
|
+
{
|
|
321
|
+
description: "Name\nx-required\nName of the stored_object.",
|
|
322
|
+
in: "path",
|
|
323
|
+
name: "name",
|
|
324
|
+
required: true,
|
|
325
|
+
schema: {
|
|
326
|
+
type: "string",
|
|
327
|
+
},
|
|
328
|
+
"x-displayname": "Name",
|
|
329
|
+
"x-ves-example": "Volt-API-specs.",
|
|
330
|
+
},
|
|
331
|
+
{
|
|
332
|
+
description: "Namespace\nx-required\nNamespace of the stored_object.",
|
|
333
|
+
in: "path",
|
|
334
|
+
name: "namespace",
|
|
335
|
+
required: true,
|
|
336
|
+
schema: {
|
|
337
|
+
type: "string",
|
|
338
|
+
},
|
|
339
|
+
"x-displayname": "Namespace",
|
|
340
|
+
"x-ves-example": "System",
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
description: "Object_type\nx-required\nType of the stored_object.",
|
|
344
|
+
in: "path",
|
|
345
|
+
name: "object_type",
|
|
346
|
+
required: true,
|
|
347
|
+
schema: {
|
|
348
|
+
type: "string",
|
|
349
|
+
},
|
|
350
|
+
"x-displayname": "Object Type.",
|
|
351
|
+
"x-ves-example": "Swagger",
|
|
352
|
+
},
|
|
353
|
+
{
|
|
354
|
+
description: 'Version\nVersion of the stored_object in "v{n}-{YY}-{MM}-{DD}" formatted string, where n is version number and YY/MM/DD is year, month and date.',
|
|
355
|
+
in: "path",
|
|
356
|
+
name: "version",
|
|
357
|
+
required: true,
|
|
358
|
+
schema: {
|
|
359
|
+
type: "string",
|
|
360
|
+
},
|
|
361
|
+
"x-displayname": "Version",
|
|
362
|
+
"x-ves-example": "V1-21-01-12.",
|
|
363
|
+
},
|
|
364
|
+
],
|
|
365
|
+
queryParameters: [
|
|
366
|
+
{
|
|
367
|
+
description: "Optional query parameter. If provided will DELETE all the versions of the specified object.",
|
|
368
|
+
in: "query",
|
|
369
|
+
name: "force_delete",
|
|
370
|
+
required: false,
|
|
371
|
+
schema: {
|
|
372
|
+
format: "boolean",
|
|
373
|
+
type: "boolean",
|
|
374
|
+
},
|
|
375
|
+
"x-displayname": "Force DELETE.",
|
|
376
|
+
"x-ves-example": "Value",
|
|
377
|
+
},
|
|
378
|
+
],
|
|
379
|
+
requestBodySchema: null,
|
|
380
|
+
responseSchema: {
|
|
381
|
+
$ref: "#/components/schemas/stored_objectDeleteObjectResponse",
|
|
382
|
+
},
|
|
383
|
+
requiredParams: ["name", "namespace", "object_type", "version"],
|
|
384
|
+
operationId: "docs_cloud_f5_com_0222_public_ves_io_schema_stored_object_ves_swagger_ves.io.schema.stored_object.CustomAPI.DeleteObject",
|
|
385
|
+
tags: ["Other"],
|
|
386
|
+
sourceFile: "domains/object_storage.json",
|
|
387
|
+
displayName: null,
|
|
388
|
+
dangerLevel: "high",
|
|
389
|
+
sideEffects: {
|
|
390
|
+
deletes: ["stored-object", "contained_resources"],
|
|
391
|
+
},
|
|
392
|
+
requiredFields: ["path.name", "path.namespace", "path.object_type", "path.version"],
|
|
393
|
+
cliExamples: [
|
|
394
|
+
{
|
|
395
|
+
command: "f5xcctl object_store stored-object delete {name} --namespace {namespace}",
|
|
396
|
+
description: "Delete stored-object",
|
|
397
|
+
use_case: "delete",
|
|
398
|
+
},
|
|
399
|
+
],
|
|
400
|
+
confirmationRequired: true,
|
|
401
|
+
parameterExamples: {
|
|
402
|
+
force_delete: "Value",
|
|
403
|
+
name: "Volt-API-specs.",
|
|
404
|
+
namespace: "System",
|
|
405
|
+
object_type: "Swagger",
|
|
406
|
+
version: "V1-21-01-12.",
|
|
407
|
+
},
|
|
408
|
+
validationRules: {},
|
|
409
|
+
operationMetadata: {
|
|
410
|
+
common_errors: [
|
|
411
|
+
{
|
|
412
|
+
code: 401,
|
|
413
|
+
message: "Authentication required",
|
|
414
|
+
solution: "Provide valid API credentials",
|
|
415
|
+
},
|
|
416
|
+
{
|
|
417
|
+
code: 403,
|
|
418
|
+
message: "Permission denied",
|
|
419
|
+
solution: "Check access permissions for this operation",
|
|
420
|
+
},
|
|
421
|
+
{
|
|
422
|
+
code: 404,
|
|
423
|
+
message: "Resource not found",
|
|
424
|
+
solution: "Verify resource name, namespace, and path",
|
|
425
|
+
},
|
|
426
|
+
{
|
|
427
|
+
code: 409,
|
|
428
|
+
message: "Resource already exists",
|
|
429
|
+
solution: "Use different name or update existing resource",
|
|
430
|
+
},
|
|
431
|
+
{
|
|
432
|
+
code: 429,
|
|
433
|
+
message: "Rate limit exceeded",
|
|
434
|
+
solution: "Wait before retrying the operation",
|
|
435
|
+
},
|
|
436
|
+
{
|
|
437
|
+
code: 500,
|
|
438
|
+
message: "Server error",
|
|
439
|
+
solution: "Retry operation or contact support",
|
|
440
|
+
},
|
|
441
|
+
],
|
|
442
|
+
conditions: {
|
|
443
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
444
|
+
prerequisites: ["Active namespace"],
|
|
445
|
+
},
|
|
446
|
+
confirmation_required: true,
|
|
447
|
+
danger_level: "high",
|
|
448
|
+
examples: [
|
|
449
|
+
{
|
|
450
|
+
command: "f5xcctl object_store stored-object delete {name} --namespace {namespace}",
|
|
451
|
+
description: "Delete stored-object",
|
|
452
|
+
use_case: "delete",
|
|
453
|
+
},
|
|
454
|
+
],
|
|
455
|
+
field_docs: {},
|
|
456
|
+
optional_fields: [],
|
|
457
|
+
performance_impact: {
|
|
458
|
+
latency: "high",
|
|
459
|
+
resource_usage: "moderate",
|
|
460
|
+
},
|
|
461
|
+
purpose: "Delete stored-object",
|
|
462
|
+
required_fields: ["path.name", "path.namespace", "path.object_type", "path.version"],
|
|
463
|
+
side_effects: {
|
|
464
|
+
deletes: ["stored-object", "contained_resources"],
|
|
465
|
+
},
|
|
466
|
+
},
|
|
467
|
+
},
|
|
468
|
+
{
|
|
469
|
+
toolName: "f5xc-api-objectstorage-name-get",
|
|
470
|
+
method: "GET",
|
|
471
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/mobile-app-shield/{name}/{version}",
|
|
472
|
+
operation: "get",
|
|
473
|
+
domain: "object_storage",
|
|
474
|
+
resource: "{name}",
|
|
475
|
+
summary: "GET Mobile App Shield.",
|
|
476
|
+
description: "GetMobileAppShield is an API to download particular version of mobile app shield.",
|
|
477
|
+
pathParameters: [
|
|
478
|
+
{
|
|
479
|
+
description: "Name\nx-required\nName of the stored_object.",
|
|
480
|
+
in: "path",
|
|
481
|
+
name: "name",
|
|
482
|
+
required: true,
|
|
483
|
+
schema: {
|
|
484
|
+
type: "string",
|
|
485
|
+
},
|
|
486
|
+
"x-displayname": "Name",
|
|
487
|
+
"x-ves-example": "Volt-API-specs.",
|
|
488
|
+
},
|
|
489
|
+
{
|
|
490
|
+
description: "Namespace\nx-required\nNamespace of the stored_object.",
|
|
491
|
+
in: "path",
|
|
492
|
+
name: "namespace",
|
|
493
|
+
required: true,
|
|
494
|
+
schema: {
|
|
495
|
+
type: "string",
|
|
496
|
+
},
|
|
497
|
+
"x-displayname": "Namespace",
|
|
498
|
+
"x-ves-example": "System",
|
|
499
|
+
},
|
|
500
|
+
{
|
|
501
|
+
description: 'Version\nVersion of the stored_object in "v{n}-{YY}-{MM}-{DD}" formatted string, where n is version number and YY/MM/DD is year, month and date.',
|
|
502
|
+
in: "path",
|
|
503
|
+
name: "version",
|
|
504
|
+
required: true,
|
|
505
|
+
schema: {
|
|
506
|
+
type: "string",
|
|
507
|
+
},
|
|
508
|
+
"x-displayname": "Version",
|
|
509
|
+
"x-ves-example": "V0-21-09-13.",
|
|
510
|
+
},
|
|
511
|
+
],
|
|
512
|
+
queryParameters: [
|
|
513
|
+
{
|
|
514
|
+
description: "X-required\nType of the stored_object.",
|
|
515
|
+
in: "query",
|
|
516
|
+
name: "object_type",
|
|
517
|
+
required: false,
|
|
518
|
+
schema: {
|
|
519
|
+
type: "string",
|
|
520
|
+
},
|
|
521
|
+
"x-displayname": "Object Type.",
|
|
522
|
+
"x-ves-example": "Swagger",
|
|
523
|
+
},
|
|
524
|
+
],
|
|
525
|
+
requestBodySchema: null,
|
|
526
|
+
responseSchema: {
|
|
527
|
+
$ref: "#/components/schemas/stored_objectGetObjectResponse",
|
|
528
|
+
},
|
|
529
|
+
requiredParams: ["name", "namespace", "version"],
|
|
530
|
+
operationId: "ves.io.schema.stored_object.MobileAppShieldCustomAPI.GetMobileAppShield",
|
|
531
|
+
tags: ["Other"],
|
|
532
|
+
sourceFile: "domains/object_storage.json",
|
|
533
|
+
displayName: null,
|
|
534
|
+
dangerLevel: "low",
|
|
535
|
+
sideEffects: null,
|
|
536
|
+
requiredFields: ["path.name", "path.namespace", "path.version"],
|
|
537
|
+
cliExamples: [
|
|
538
|
+
{
|
|
539
|
+
command: "f5xcctl object_store mobile-app-shield get {name} --namespace {namespace}",
|
|
540
|
+
description: "Get specific mobile-app-shield",
|
|
541
|
+
use_case: "get_specific",
|
|
542
|
+
},
|
|
543
|
+
],
|
|
544
|
+
confirmationRequired: false,
|
|
545
|
+
parameterExamples: {
|
|
546
|
+
name: "Volt-API-specs.",
|
|
547
|
+
namespace: "System",
|
|
548
|
+
object_type: "Swagger",
|
|
549
|
+
version: "V0-21-09-13.",
|
|
550
|
+
},
|
|
551
|
+
validationRules: {},
|
|
552
|
+
operationMetadata: {
|
|
553
|
+
common_errors: [
|
|
554
|
+
{
|
|
555
|
+
code: 401,
|
|
556
|
+
message: "Authentication required",
|
|
557
|
+
solution: "Provide valid API credentials",
|
|
558
|
+
},
|
|
559
|
+
{
|
|
560
|
+
code: 403,
|
|
561
|
+
message: "Permission denied",
|
|
562
|
+
solution: "Check access permissions for this operation",
|
|
563
|
+
},
|
|
564
|
+
{
|
|
565
|
+
code: 404,
|
|
566
|
+
message: "Resource not found",
|
|
567
|
+
solution: "Verify resource name, namespace, and path",
|
|
568
|
+
},
|
|
569
|
+
{
|
|
570
|
+
code: 409,
|
|
571
|
+
message: "Resource already exists",
|
|
572
|
+
solution: "Use different name or update existing resource",
|
|
573
|
+
},
|
|
574
|
+
{
|
|
575
|
+
code: 429,
|
|
576
|
+
message: "Rate limit exceeded",
|
|
577
|
+
solution: "Wait before retrying the operation",
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
code: 500,
|
|
581
|
+
message: "Server error",
|
|
582
|
+
solution: "Retry operation or contact support",
|
|
583
|
+
},
|
|
584
|
+
],
|
|
585
|
+
conditions: {
|
|
586
|
+
postconditions: [],
|
|
587
|
+
prerequisites: ["Active namespace"],
|
|
588
|
+
},
|
|
589
|
+
confirmation_required: false,
|
|
590
|
+
danger_level: "low",
|
|
591
|
+
examples: [
|
|
592
|
+
{
|
|
593
|
+
command: "f5xcctl object_store mobile-app-shield get {name} --namespace {namespace}",
|
|
594
|
+
description: "Get specific mobile-app-shield",
|
|
595
|
+
use_case: "get_specific",
|
|
596
|
+
},
|
|
597
|
+
],
|
|
598
|
+
field_docs: {},
|
|
599
|
+
optional_fields: [],
|
|
600
|
+
performance_impact: {
|
|
601
|
+
latency: "low",
|
|
602
|
+
resource_usage: "low",
|
|
603
|
+
},
|
|
604
|
+
purpose: "Retrieve specific mobile-app-shield",
|
|
605
|
+
required_fields: ["path.name", "path.namespace", "path.version"],
|
|
606
|
+
side_effects: {},
|
|
607
|
+
},
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
toolName: "f5xc-api-objectstorage-object-type-delete",
|
|
611
|
+
method: "DELETE",
|
|
612
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}",
|
|
613
|
+
operation: "delete",
|
|
614
|
+
domain: "object_storage",
|
|
615
|
+
resource: "{object-type}",
|
|
616
|
+
summary: "DELETE Stored Object(s)",
|
|
617
|
+
description: "DeleteObjects is an API to DELETE object(s) in object store.",
|
|
618
|
+
pathParameters: [
|
|
619
|
+
{
|
|
620
|
+
description: "Name\nx-required\nName of the stored_object.",
|
|
621
|
+
in: "path",
|
|
622
|
+
name: "name",
|
|
623
|
+
required: true,
|
|
624
|
+
schema: {
|
|
625
|
+
type: "string",
|
|
626
|
+
},
|
|
627
|
+
"x-displayname": "Name",
|
|
628
|
+
"x-ves-example": "Volt-API-specs.",
|
|
629
|
+
},
|
|
630
|
+
{
|
|
631
|
+
description: "Namespace\nx-required\nNamespace of the stored_object.",
|
|
632
|
+
in: "path",
|
|
633
|
+
name: "namespace",
|
|
634
|
+
required: true,
|
|
635
|
+
schema: {
|
|
636
|
+
type: "string",
|
|
637
|
+
},
|
|
638
|
+
"x-displayname": "Namespace",
|
|
639
|
+
"x-ves-example": "System",
|
|
640
|
+
},
|
|
641
|
+
{
|
|
642
|
+
description: "Object_type\nx-required\nType of the stored_object.",
|
|
643
|
+
in: "path",
|
|
644
|
+
name: "object_type",
|
|
645
|
+
required: true,
|
|
646
|
+
schema: {
|
|
647
|
+
type: "string",
|
|
648
|
+
},
|
|
649
|
+
"x-displayname": "Object Type.",
|
|
650
|
+
"x-ves-example": "Swagger",
|
|
651
|
+
},
|
|
652
|
+
],
|
|
653
|
+
queryParameters: [
|
|
654
|
+
{
|
|
655
|
+
description: "Optional query parameter. If provided will DELETE all the versions of the specified object.",
|
|
656
|
+
in: "query",
|
|
657
|
+
name: "force_delete",
|
|
658
|
+
required: false,
|
|
659
|
+
schema: {
|
|
660
|
+
format: "boolean",
|
|
661
|
+
type: "boolean",
|
|
662
|
+
},
|
|
663
|
+
"x-displayname": "Force DELETE.",
|
|
664
|
+
"x-ves-example": "Value",
|
|
665
|
+
},
|
|
666
|
+
{
|
|
667
|
+
description: 'Version of the stored_object in "v{n}-{YY}-{MM}-{DD}" formatted string, where n is version number and YY/MM/DD is year, month and date.',
|
|
668
|
+
in: "query",
|
|
669
|
+
name: "version",
|
|
670
|
+
required: false,
|
|
671
|
+
schema: {
|
|
672
|
+
type: "string",
|
|
673
|
+
},
|
|
674
|
+
"x-displayname": "Version",
|
|
675
|
+
"x-ves-example": "V1-21-01-12.",
|
|
676
|
+
},
|
|
677
|
+
],
|
|
678
|
+
requestBodySchema: null,
|
|
679
|
+
responseSchema: {
|
|
680
|
+
$ref: "#/components/schemas/stored_objectDeleteObjectResponse",
|
|
681
|
+
},
|
|
682
|
+
requiredParams: ["name", "namespace", "object_type"],
|
|
683
|
+
operationId: "ves.io.schema.stored_object.CustomAPI.DeleteObject",
|
|
684
|
+
tags: ["Other"],
|
|
685
|
+
sourceFile: "domains/object_storage.json",
|
|
686
|
+
displayName: null,
|
|
687
|
+
dangerLevel: "high",
|
|
688
|
+
sideEffects: {
|
|
689
|
+
deletes: ["stored-object", "contained_resources"],
|
|
690
|
+
},
|
|
691
|
+
requiredFields: ["path.name", "path.namespace", "path.object_type"],
|
|
692
|
+
cliExamples: [
|
|
693
|
+
{
|
|
694
|
+
command: "f5xcctl object_store stored-object delete {name} --namespace {namespace}",
|
|
695
|
+
description: "Delete stored-object",
|
|
696
|
+
use_case: "delete",
|
|
697
|
+
},
|
|
698
|
+
],
|
|
699
|
+
confirmationRequired: true,
|
|
700
|
+
parameterExamples: {
|
|
701
|
+
force_delete: "Value",
|
|
702
|
+
name: "Volt-API-specs.",
|
|
703
|
+
namespace: "System",
|
|
704
|
+
object_type: "Swagger",
|
|
705
|
+
version: "V1-21-01-12.",
|
|
706
|
+
},
|
|
707
|
+
validationRules: {},
|
|
708
|
+
operationMetadata: {
|
|
709
|
+
common_errors: [
|
|
710
|
+
{
|
|
711
|
+
code: 401,
|
|
712
|
+
message: "Authentication required",
|
|
713
|
+
solution: "Provide valid API credentials",
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
code: 403,
|
|
717
|
+
message: "Permission denied",
|
|
718
|
+
solution: "Check access permissions for this operation",
|
|
719
|
+
},
|
|
720
|
+
{
|
|
721
|
+
code: 404,
|
|
722
|
+
message: "Resource not found",
|
|
723
|
+
solution: "Verify resource name, namespace, and path",
|
|
724
|
+
},
|
|
725
|
+
{
|
|
726
|
+
code: 409,
|
|
727
|
+
message: "Resource already exists",
|
|
728
|
+
solution: "Use different name or update existing resource",
|
|
729
|
+
},
|
|
730
|
+
{
|
|
731
|
+
code: 429,
|
|
732
|
+
message: "Rate limit exceeded",
|
|
733
|
+
solution: "Wait before retrying the operation",
|
|
734
|
+
},
|
|
735
|
+
{
|
|
736
|
+
code: 500,
|
|
737
|
+
message: "Server error",
|
|
738
|
+
solution: "Retry operation or contact support",
|
|
739
|
+
},
|
|
740
|
+
],
|
|
741
|
+
conditions: {
|
|
742
|
+
postconditions: ["Resource removed from system", "Associated resources may be affected"],
|
|
743
|
+
prerequisites: ["Active namespace"],
|
|
744
|
+
},
|
|
745
|
+
confirmation_required: true,
|
|
746
|
+
danger_level: "high",
|
|
747
|
+
examples: [
|
|
748
|
+
{
|
|
749
|
+
command: "f5xcctl object_store stored-object delete {name} --namespace {namespace}",
|
|
750
|
+
description: "Delete stored-object",
|
|
751
|
+
use_case: "delete",
|
|
752
|
+
},
|
|
753
|
+
],
|
|
754
|
+
field_docs: {},
|
|
755
|
+
optional_fields: [],
|
|
756
|
+
performance_impact: {
|
|
757
|
+
latency: "high",
|
|
758
|
+
resource_usage: "moderate",
|
|
759
|
+
},
|
|
760
|
+
purpose: "Delete stored-object",
|
|
761
|
+
required_fields: ["path.name", "path.namespace", "path.object_type"],
|
|
762
|
+
side_effects: {
|
|
763
|
+
deletes: ["stored-object", "contained_resources"],
|
|
764
|
+
},
|
|
765
|
+
},
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
toolName: "f5xc-api-objectstorage-object-type-update",
|
|
769
|
+
method: "PUT",
|
|
770
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}/{name}",
|
|
771
|
+
operation: "update",
|
|
772
|
+
domain: "object_storage",
|
|
773
|
+
resource: "{object-type}",
|
|
774
|
+
summary: "Create Stored Object.",
|
|
775
|
+
description: "CreateObject is an API to upload an object to generic object store. Objects are immutable, a new version is created when the content is updated.",
|
|
776
|
+
pathParameters: [
|
|
777
|
+
{
|
|
778
|
+
description: "Name\nx-required\nName of the stored_object.",
|
|
779
|
+
in: "path",
|
|
780
|
+
name: "name",
|
|
781
|
+
required: true,
|
|
782
|
+
schema: {
|
|
783
|
+
type: "string",
|
|
784
|
+
},
|
|
785
|
+
"x-displayname": "Name",
|
|
786
|
+
"x-ves-example": "Volt-API-specs.",
|
|
787
|
+
},
|
|
788
|
+
{
|
|
789
|
+
description: "Namespace\nx-required\nNamespace in which object is to be created.",
|
|
790
|
+
in: "path",
|
|
791
|
+
name: "namespace",
|
|
792
|
+
required: true,
|
|
793
|
+
schema: {
|
|
794
|
+
type: "string",
|
|
795
|
+
},
|
|
796
|
+
"x-displayname": "Namespace",
|
|
797
|
+
"x-ves-example": "System",
|
|
798
|
+
},
|
|
799
|
+
{
|
|
800
|
+
description: "Object_type\nx-required\nType of the stored_object.",
|
|
801
|
+
in: "path",
|
|
802
|
+
name: "object_type",
|
|
803
|
+
required: true,
|
|
804
|
+
schema: {
|
|
805
|
+
type: "string",
|
|
806
|
+
},
|
|
807
|
+
"x-displayname": "Object Type.",
|
|
808
|
+
"x-ves-example": "Swagger",
|
|
809
|
+
},
|
|
810
|
+
],
|
|
811
|
+
queryParameters: [],
|
|
812
|
+
requestBodySchema: {
|
|
813
|
+
$ref: "#/components/schemas/stored_objectCreateObjectRequest",
|
|
814
|
+
},
|
|
815
|
+
responseSchema: {
|
|
816
|
+
$ref: "#/components/schemas/stored_objectCreateObjectResponse",
|
|
817
|
+
},
|
|
818
|
+
requiredParams: ["body", "name", "namespace", "object_type"],
|
|
819
|
+
operationId: "ves.io.schema.stored_object.CustomAPI.CreateObject",
|
|
820
|
+
tags: ["Other"],
|
|
821
|
+
sourceFile: "domains/object_storage.json",
|
|
822
|
+
displayName: null,
|
|
823
|
+
dangerLevel: "medium",
|
|
824
|
+
sideEffects: {
|
|
825
|
+
modifies: ["stored-object"],
|
|
826
|
+
},
|
|
827
|
+
requiredFields: ["path.name", "path.namespace", "path.object_type"],
|
|
828
|
+
cliExamples: [
|
|
829
|
+
{
|
|
830
|
+
command: "f5xcctl object_store stored-object update {name} --namespace {namespace} -f {file}.yaml",
|
|
831
|
+
description: "Update stored-object",
|
|
832
|
+
use_case: "update",
|
|
833
|
+
},
|
|
834
|
+
],
|
|
835
|
+
confirmationRequired: false,
|
|
836
|
+
parameterExamples: {
|
|
837
|
+
name: "Volt-API-specs.",
|
|
838
|
+
namespace: "System",
|
|
839
|
+
object_type: "Swagger",
|
|
840
|
+
},
|
|
841
|
+
validationRules: {},
|
|
842
|
+
operationMetadata: {
|
|
843
|
+
common_errors: [
|
|
844
|
+
{
|
|
845
|
+
code: 401,
|
|
846
|
+
message: "Authentication required",
|
|
847
|
+
solution: "Provide valid API credentials",
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
code: 403,
|
|
851
|
+
message: "Permission denied",
|
|
852
|
+
solution: "Check access permissions for this operation",
|
|
853
|
+
},
|
|
854
|
+
{
|
|
855
|
+
code: 404,
|
|
856
|
+
message: "Resource not found",
|
|
857
|
+
solution: "Verify resource name, namespace, and path",
|
|
858
|
+
},
|
|
859
|
+
{
|
|
860
|
+
code: 409,
|
|
861
|
+
message: "Resource already exists",
|
|
862
|
+
solution: "Use different name or update existing resource",
|
|
863
|
+
},
|
|
864
|
+
{
|
|
865
|
+
code: 429,
|
|
866
|
+
message: "Rate limit exceeded",
|
|
867
|
+
solution: "Wait before retrying the operation",
|
|
868
|
+
},
|
|
869
|
+
{
|
|
870
|
+
code: 500,
|
|
871
|
+
message: "Server error",
|
|
872
|
+
solution: "Retry operation or contact support",
|
|
873
|
+
},
|
|
874
|
+
],
|
|
875
|
+
conditions: {
|
|
876
|
+
postconditions: ["Resource updated with new values"],
|
|
877
|
+
prerequisites: ["Active namespace"],
|
|
878
|
+
},
|
|
879
|
+
confirmation_required: false,
|
|
880
|
+
danger_level: "medium",
|
|
881
|
+
examples: [
|
|
882
|
+
{
|
|
883
|
+
command: "f5xcctl object_store stored-object update {name} --namespace {namespace} -f {file}.yaml",
|
|
884
|
+
description: "Update stored-object",
|
|
885
|
+
use_case: "update",
|
|
886
|
+
},
|
|
887
|
+
],
|
|
888
|
+
field_docs: {},
|
|
889
|
+
optional_fields: [],
|
|
890
|
+
performance_impact: {
|
|
891
|
+
latency: "low",
|
|
892
|
+
resource_usage: "low",
|
|
893
|
+
},
|
|
894
|
+
purpose: "Replace existing stored-object",
|
|
895
|
+
required_fields: ["path.name", "path.namespace", "path.object_type"],
|
|
896
|
+
side_effects: {
|
|
897
|
+
modifies: ["stored-object"],
|
|
898
|
+
},
|
|
899
|
+
},
|
|
900
|
+
},
|
|
901
|
+
{
|
|
902
|
+
toolName: "f5xc-api-objectstorage-stored-object-list",
|
|
903
|
+
method: "GET",
|
|
904
|
+
path: "/api/object_store/namespaces/{namespace}/stored_objects/{object_type}",
|
|
905
|
+
operation: "list",
|
|
906
|
+
domain: "object_storage",
|
|
907
|
+
resource: "stored-object",
|
|
908
|
+
summary: "GET List Of Stored Objects.",
|
|
909
|
+
description: "ListObjects is an API to list objects in object store.",
|
|
910
|
+
pathParameters: [
|
|
911
|
+
{
|
|
912
|
+
description: "Namespace\nx-required\nNamespace of the stored_object.",
|
|
913
|
+
in: "path",
|
|
914
|
+
name: "namespace",
|
|
915
|
+
required: true,
|
|
916
|
+
schema: {
|
|
917
|
+
type: "string",
|
|
918
|
+
},
|
|
919
|
+
"x-displayname": "Namespace",
|
|
920
|
+
"x-ves-example": "System",
|
|
921
|
+
},
|
|
922
|
+
{
|
|
923
|
+
description: "Object_type\nOptional query parameter. Type of the stored_object.",
|
|
924
|
+
in: "path",
|
|
925
|
+
name: "object_type",
|
|
926
|
+
required: true,
|
|
927
|
+
schema: {
|
|
928
|
+
type: "string",
|
|
929
|
+
},
|
|
930
|
+
"x-displayname": "Object Type.",
|
|
931
|
+
"x-ves-example": "Swagger",
|
|
932
|
+
},
|
|
933
|
+
],
|
|
934
|
+
queryParameters: [
|
|
935
|
+
{
|
|
936
|
+
description: "Optional query parameter. If passed, returns only latest version of the objects.",
|
|
937
|
+
in: "query",
|
|
938
|
+
name: "latest_version_only",
|
|
939
|
+
required: false,
|
|
940
|
+
schema: {
|
|
941
|
+
format: "boolean",
|
|
942
|
+
type: "boolean",
|
|
943
|
+
},
|
|
944
|
+
"x-displayname": "Latest Versions Only.",
|
|
945
|
+
},
|
|
946
|
+
{
|
|
947
|
+
description: "Optional query parameter. Name of the stored_object.",
|
|
948
|
+
in: "query",
|
|
949
|
+
name: "name",
|
|
950
|
+
required: false,
|
|
951
|
+
schema: {
|
|
952
|
+
type: "string",
|
|
953
|
+
},
|
|
954
|
+
"x-displayname": "Name",
|
|
955
|
+
"x-ves-example": "Example-file, shared/example-file, example-ns/example-file.",
|
|
956
|
+
},
|
|
957
|
+
{
|
|
958
|
+
description: "Optional query parameter. The type of search query needs to be performed. Could be EXACT_MATCH or PREFIX_MATCH.\nEXACT_MATCH returns the objects with exact match on the name filed, while PREFIX_MATCH returns the list of object matching the 'name' prefix. Default is EXACT_MATCH.\n\n- EXACT_MATCH: EXACT_MATCH\n\nReturns list of objects with exact match on the name filed.\n- PREFIX_MATCH: PREFIX_MATCH\n\nReturns the list of object matching the 'name' prefix.",
|
|
959
|
+
in: "query",
|
|
960
|
+
name: "query_type",
|
|
961
|
+
required: false,
|
|
962
|
+
schema: {
|
|
963
|
+
default: "EXACT_MATCH",
|
|
964
|
+
enum: ["EXACT_MATCH", "PREFIX_MATCH"],
|
|
965
|
+
type: "string",
|
|
966
|
+
},
|
|
967
|
+
"x-displayname": "PREFIX MATCH.",
|
|
968
|
+
},
|
|
969
|
+
],
|
|
970
|
+
requestBodySchema: null,
|
|
971
|
+
responseSchema: {
|
|
972
|
+
$ref: "#/components/schemas/stored_objectListObjectsResponse",
|
|
973
|
+
},
|
|
974
|
+
requiredParams: ["namespace", "object_type"],
|
|
975
|
+
operationId: "ves.io.schema.stored_object.CustomAPI.ListObjects",
|
|
976
|
+
tags: ["Other"],
|
|
977
|
+
sourceFile: "domains/object_storage.json",
|
|
978
|
+
displayName: null,
|
|
979
|
+
dangerLevel: "low",
|
|
980
|
+
sideEffects: null,
|
|
981
|
+
requiredFields: ["path.namespace", "path.object_type"],
|
|
982
|
+
cliExamples: [
|
|
983
|
+
{
|
|
984
|
+
command: "f5xcctl object_store stored-object list --namespace {namespace}",
|
|
985
|
+
description: "List all stored-objects",
|
|
986
|
+
use_case: "list_all",
|
|
987
|
+
},
|
|
988
|
+
],
|
|
989
|
+
confirmationRequired: false,
|
|
990
|
+
parameterExamples: {
|
|
991
|
+
name: "Example-file, shared/example-file, example-ns/example-file.",
|
|
992
|
+
namespace: "System",
|
|
993
|
+
object_type: "Swagger",
|
|
994
|
+
},
|
|
995
|
+
validationRules: {},
|
|
996
|
+
operationMetadata: {
|
|
997
|
+
common_errors: [
|
|
998
|
+
{
|
|
999
|
+
code: 401,
|
|
1000
|
+
message: "Authentication required",
|
|
1001
|
+
solution: "Provide valid API credentials",
|
|
1002
|
+
},
|
|
1003
|
+
{
|
|
1004
|
+
code: 403,
|
|
1005
|
+
message: "Permission denied",
|
|
1006
|
+
solution: "Check access permissions for this operation",
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
code: 404,
|
|
1010
|
+
message: "Resource not found",
|
|
1011
|
+
solution: "Verify resource name, namespace, and path",
|
|
1012
|
+
},
|
|
1013
|
+
{
|
|
1014
|
+
code: 409,
|
|
1015
|
+
message: "Resource already exists",
|
|
1016
|
+
solution: "Use different name or update existing resource",
|
|
1017
|
+
},
|
|
1018
|
+
{
|
|
1019
|
+
code: 429,
|
|
1020
|
+
message: "Rate limit exceeded",
|
|
1021
|
+
solution: "Wait before retrying the operation",
|
|
1022
|
+
},
|
|
1023
|
+
{
|
|
1024
|
+
code: 500,
|
|
1025
|
+
message: "Server error",
|
|
1026
|
+
solution: "Retry operation or contact support",
|
|
1027
|
+
},
|
|
1028
|
+
],
|
|
1029
|
+
conditions: {
|
|
1030
|
+
postconditions: [],
|
|
1031
|
+
prerequisites: ["Active namespace"],
|
|
1032
|
+
},
|
|
1033
|
+
confirmation_required: false,
|
|
1034
|
+
danger_level: "low",
|
|
1035
|
+
examples: [
|
|
1036
|
+
{
|
|
1037
|
+
command: "f5xcctl object_store stored-object list --namespace {namespace}",
|
|
1038
|
+
description: "List all stored-objects",
|
|
1039
|
+
use_case: "list_all",
|
|
1040
|
+
},
|
|
1041
|
+
],
|
|
1042
|
+
field_docs: {},
|
|
1043
|
+
optional_fields: [],
|
|
1044
|
+
performance_impact: {
|
|
1045
|
+
latency: "low",
|
|
1046
|
+
resource_usage: "low",
|
|
1047
|
+
},
|
|
1048
|
+
purpose: "List all stored-objects",
|
|
1049
|
+
required_fields: ["path.namespace", "path.object_type"],
|
|
1050
|
+
side_effects: {},
|
|
1051
|
+
},
|
|
1052
|
+
},
|
|
1053
|
+
];
|
|
1054
|
+
export default object_storageTools;
|
|
1055
|
+
//# sourceMappingURL=index.js.map
|