@robinmordasiewicz/f5xc-api-mcp 3.0.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/CHANGELOG.md +74 -0
- package/README.md +234 -0
- package/dist/auth/credential-manager.d.ts +116 -0
- package/dist/auth/credential-manager.d.ts.map +1 -0
- package/dist/auth/credential-manager.js +208 -0
- package/dist/auth/credential-manager.js.map +1 -0
- package/dist/auth/http-client.d.ts +81 -0
- package/dist/auth/http-client.d.ts.map +1 -0
- package/dist/auth/http-client.js +197 -0
- package/dist/auth/http-client.js.map +1 -0
- package/dist/auth/index.d.ts +8 -0
- package/dist/auth/index.d.ts.map +1 -0
- package/dist/auth/index.js +6 -0
- package/dist/auth/index.js.map +1 -0
- package/dist/generator/index.d.ts +7 -0
- package/dist/generator/index.d.ts.map +1 -0
- package/dist/generator/index.js +7 -0
- package/dist/generator/index.js.map +1 -0
- package/dist/generator/naming/acronyms.d.ts +81 -0
- package/dist/generator/naming/acronyms.d.ts.map +1 -0
- package/dist/generator/naming/acronyms.js +253 -0
- package/dist/generator/naming/acronyms.js.map +1 -0
- package/dist/generator/naming/index.d.ts +6 -0
- package/dist/generator/naming/index.d.ts.map +1 -0
- package/dist/generator/naming/index.js +6 -0
- package/dist/generator/naming/index.js.map +1 -0
- package/dist/generator/naming/volterra-mapping.d.ts +102 -0
- package/dist/generator/naming/volterra-mapping.d.ts.map +1 -0
- package/dist/generator/naming/volterra-mapping.js +259 -0
- package/dist/generator/naming/volterra-mapping.js.map +1 -0
- package/dist/generator/openapi-parser.d.ts +339 -0
- package/dist/generator/openapi-parser.d.ts.map +1 -0
- package/dist/generator/openapi-parser.js +463 -0
- package/dist/generator/openapi-parser.js.map +1 -0
- package/dist/generator/tool-generator.d.ts +74 -0
- package/dist/generator/tool-generator.d.ts.map +1 -0
- package/dist/generator/tool-generator.js +387 -0
- package/dist/generator/tool-generator.js.map +1 -0
- package/dist/generator/transformers/index.d.ts +7 -0
- package/dist/generator/transformers/index.d.ts.map +1 -0
- package/dist/generator/transformers/index.js +7 -0
- package/dist/generator/transformers/index.js.map +1 -0
- package/dist/generator/transformers/normalize-examples.d.ts +48 -0
- package/dist/generator/transformers/normalize-examples.d.ts.map +1 -0
- package/dist/generator/transformers/normalize-examples.js +66 -0
- package/dist/generator/transformers/normalize-examples.js.map +1 -0
- package/dist/index.d.ts +21 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +70 -0
- package/dist/index.js.map +1 -0
- package/dist/prompts/index.d.ts +6 -0
- package/dist/prompts/index.d.ts.map +1 -0
- package/dist/prompts/index.js +5 -0
- package/dist/prompts/index.js.map +1 -0
- package/dist/prompts/workflows.d.ts +59 -0
- package/dist/prompts/workflows.d.ts.map +1 -0
- package/dist/prompts/workflows.js +585 -0
- package/dist/prompts/workflows.js.map +1 -0
- package/dist/resources/handlers.d.ts +72 -0
- package/dist/resources/handlers.d.ts.map +1 -0
- package/dist/resources/handlers.js +279 -0
- package/dist/resources/handlers.js.map +1 -0
- package/dist/resources/index.d.ts +8 -0
- package/dist/resources/index.d.ts.map +1 -0
- package/dist/resources/index.js +6 -0
- package/dist/resources/index.js.map +1 -0
- package/dist/resources/templates.d.ts +86 -0
- package/dist/resources/templates.d.ts.map +1 -0
- package/dist/resources/templates.js +248 -0
- package/dist/resources/templates.js.map +1 -0
- package/dist/server.d.ts +78 -0
- package/dist/server.d.ts.map +1 -0
- package/dist/server.js +426 -0
- package/dist/server.js.map +1 -0
- package/dist/tools/discovery/consolidate.d.ts +97 -0
- package/dist/tools/discovery/consolidate.d.ts.map +1 -0
- package/dist/tools/discovery/consolidate.js +200 -0
- package/dist/tools/discovery/consolidate.js.map +1 -0
- package/dist/tools/discovery/describe.d.ts +132 -0
- package/dist/tools/discovery/describe.d.ts.map +1 -0
- package/dist/tools/discovery/describe.js +206 -0
- package/dist/tools/discovery/describe.js.map +1 -0
- package/dist/tools/discovery/execute.d.ts +98 -0
- package/dist/tools/discovery/execute.d.ts.map +1 -0
- package/dist/tools/discovery/execute.js +251 -0
- package/dist/tools/discovery/execute.js.map +1 -0
- package/dist/tools/discovery/index-loader.d.ts +28 -0
- package/dist/tools/discovery/index-loader.d.ts.map +1 -0
- package/dist/tools/discovery/index-loader.js +69 -0
- package/dist/tools/discovery/index-loader.js.map +1 -0
- package/dist/tools/discovery/index.d.ts +185 -0
- package/dist/tools/discovery/index.d.ts.map +1 -0
- package/dist/tools/discovery/index.js +177 -0
- package/dist/tools/discovery/index.js.map +1 -0
- package/dist/tools/discovery/search.d.ts +41 -0
- package/dist/tools/discovery/search.d.ts.map +1 -0
- package/dist/tools/discovery/search.js +155 -0
- package/dist/tools/discovery/search.js.map +1 -0
- package/dist/tools/discovery/types.d.ts +70 -0
- package/dist/tools/discovery/types.d.ts.map +1 -0
- package/dist/tools/discovery/types.js +9 -0
- package/dist/tools/discovery/types.js.map +1 -0
- package/dist/tools/generated/ai_intelligence/index.d.ts +8 -0
- package/dist/tools/generated/ai_intelligence/index.d.ts.map +1 -0
- package/dist/tools/generated/ai_intelligence/index.js +282 -0
- package/dist/tools/generated/ai_intelligence/index.js.map +1 -0
- package/dist/tools/generated/api_security/index.d.ts +8 -0
- package/dist/tools/generated/api_security/index.d.ts.map +1 -0
- package/dist/tools/generated/api_security/index.js +1852 -0
- package/dist/tools/generated/api_security/index.js.map +1 -0
- package/dist/tools/generated/applications/index.d.ts +8 -0
- package/dist/tools/generated/applications/index.d.ts.map +1 -0
- package/dist/tools/generated/applications/index.js +1589 -0
- package/dist/tools/generated/applications/index.js.map +1 -0
- package/dist/tools/generated/bigip/index.d.ts +8 -0
- package/dist/tools/generated/bigip/index.d.ts.map +1 -0
- package/dist/tools/generated/bigip/index.js +1173 -0
- package/dist/tools/generated/bigip/index.js.map +1 -0
- package/dist/tools/generated/billing/index.d.ts +8 -0
- package/dist/tools/generated/billing/index.d.ts.map +1 -0
- package/dist/tools/generated/billing/index.js +759 -0
- package/dist/tools/generated/billing/index.js.map +1 -0
- package/dist/tools/generated/cdn/index.d.ts +8 -0
- package/dist/tools/generated/cdn/index.d.ts.map +1 -0
- package/dist/tools/generated/cdn/index.js +841 -0
- package/dist/tools/generated/cdn/index.js.map +1 -0
- package/dist/tools/generated/config/index.d.ts +8 -0
- package/dist/tools/generated/config/index.d.ts.map +1 -0
- package/dist/tools/generated/config/index.js +316 -0
- package/dist/tools/generated/config/index.js.map +1 -0
- package/dist/tools/generated/identity/index.d.ts +8 -0
- package/dist/tools/generated/identity/index.d.ts.map +1 -0
- package/dist/tools/generated/identity/index.js +5371 -0
- package/dist/tools/generated/identity/index.js.map +1 -0
- package/dist/tools/generated/infrastructure/index.d.ts +8 -0
- package/dist/tools/generated/infrastructure/index.d.ts.map +1 -0
- package/dist/tools/generated/infrastructure/index.js +5342 -0
- package/dist/tools/generated/infrastructure/index.js.map +1 -0
- package/dist/tools/generated/infrastructure_protection/index.d.ts +8 -0
- package/dist/tools/generated/infrastructure_protection/index.d.ts.map +1 -0
- package/dist/tools/generated/infrastructure_protection/index.js +2919 -0
- package/dist/tools/generated/infrastructure_protection/index.js.map +1 -0
- package/dist/tools/generated/integrations/index.d.ts +8 -0
- package/dist/tools/generated/integrations/index.d.ts.map +1 -0
- package/dist/tools/generated/integrations/index.js +1995 -0
- package/dist/tools/generated/integrations/index.js.map +1 -0
- package/dist/tools/generated/load_balancer/index.d.ts +8 -0
- package/dist/tools/generated/load_balancer/index.d.ts.map +1 -0
- package/dist/tools/generated/load_balancer/index.js +2269 -0
- package/dist/tools/generated/load_balancer/index.js.map +1 -0
- package/dist/tools/generated/networking/index.d.ts +8 -0
- package/dist/tools/generated/networking/index.d.ts.map +1 -0
- package/dist/tools/generated/networking/index.js +11289 -0
- package/dist/tools/generated/networking/index.js.map +1 -0
- package/dist/tools/generated/nginx/index.d.ts +8 -0
- package/dist/tools/generated/nginx/index.d.ts.map +1 -0
- package/dist/tools/generated/nginx/index.js +680 -0
- package/dist/tools/generated/nginx/index.js.map +1 -0
- package/dist/tools/generated/observability/index.d.ts +8 -0
- package/dist/tools/generated/observability/index.d.ts.map +1 -0
- package/dist/tools/generated/observability/index.js +6140 -0
- package/dist/tools/generated/observability/index.js.map +1 -0
- package/dist/tools/generated/operations/index.d.ts +8 -0
- package/dist/tools/generated/operations/index.d.ts.map +1 -0
- package/dist/tools/generated/operations/index.js +1759 -0
- package/dist/tools/generated/operations/index.js.map +1 -0
- package/dist/tools/generated/security/index.d.ts +8 -0
- package/dist/tools/generated/security/index.d.ts.map +1 -0
- package/dist/tools/generated/security/index.js +9111 -0
- package/dist/tools/generated/security/index.js.map +1 -0
- package/dist/tools/generated/service_mesh/index.d.ts +8 -0
- package/dist/tools/generated/service_mesh/index.d.ts.map +1 -0
- package/dist/tools/generated/service_mesh/index.js +1628 -0
- package/dist/tools/generated/service_mesh/index.js.map +1 -0
- package/dist/tools/generated/shape_security/index.d.ts +8 -0
- package/dist/tools/generated/shape_security/index.d.ts.map +1 -0
- package/dist/tools/generated/shape_security/index.js +4121 -0
- package/dist/tools/generated/shape_security/index.js.map +1 -0
- package/dist/tools/generated/subscriptions/index.d.ts +8 -0
- package/dist/tools/generated/subscriptions/index.d.ts.map +1 -0
- package/dist/tools/generated/subscriptions/index.js +778 -0
- package/dist/tools/generated/subscriptions/index.js.map +1 -0
- package/dist/tools/generated/tenant_management/index.d.ts +8 -0
- package/dist/tools/generated/tenant_management/index.d.ts.map +1 -0
- package/dist/tools/generated/tenant_management/index.js +2292 -0
- package/dist/tools/generated/tenant_management/index.js.map +1 -0
- package/dist/tools/generated/vpn/index.d.ts +8 -0
- package/dist/tools/generated/vpn/index.d.ts.map +1 -0
- package/dist/tools/generated/vpn/index.js +1183 -0
- package/dist/tools/generated/vpn/index.js.map +1 -0
- package/dist/tools/index.d.ts +7 -0
- package/dist/tools/index.d.ts.map +1 -0
- package/dist/tools/index.js +6 -0
- package/dist/tools/index.js.map +1 -0
- package/dist/tools/registry.d.ts +27 -0
- package/dist/tools/registry.d.ts.map +1 -0
- package/dist/tools/registry.js +83 -0
- package/dist/tools/registry.js.map +1 -0
- package/dist/utils/error-handling.d.ts +109 -0
- package/dist/utils/error-handling.d.ts.map +1 -0
- package/dist/utils/error-handling.js +239 -0
- package/dist/utils/error-handling.js.map +1 -0
- package/dist/utils/index.d.ts +7 -0
- package/dist/utils/index.d.ts.map +1 -0
- package/dist/utils/index.js +6 -0
- package/dist/utils/index.js.map +1 -0
- package/dist/utils/logging.d.ts +75 -0
- package/dist/utils/logging.d.ts.map +1 -0
- package/dist/utils/logging.js +131 -0
- package/dist/utils/logging.js.map +1 -0
- package/manifest.json +143 -0
- package/package.json +95 -0
|
@@ -0,0 +1,1589 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated tool definitions for applications domain
|
|
3
|
+
* DO NOT EDIT - This file is auto-generated by scripts/generate.ts
|
|
4
|
+
*/
|
|
5
|
+
export const applicationsTools = [
|
|
6
|
+
{
|
|
7
|
+
toolName: "f5xc-api-applications-api-endpoint-create",
|
|
8
|
+
method: "POST",
|
|
9
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/services/{service_name}/api_endpoints",
|
|
10
|
+
operation: "create",
|
|
11
|
+
domain: "applications",
|
|
12
|
+
resource: "api-endpoint",
|
|
13
|
+
summary: "GET Service API Endpoints.",
|
|
14
|
+
description: "GET all autodiscovered API endpoints for Service.",
|
|
15
|
+
pathParameters: [
|
|
16
|
+
{
|
|
17
|
+
description: "App Type\nApp Type for current request.",
|
|
18
|
+
in: "path",
|
|
19
|
+
name: "app_type_name",
|
|
20
|
+
required: true,
|
|
21
|
+
schema: {
|
|
22
|
+
type: "string",
|
|
23
|
+
},
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
27
|
+
in: "path",
|
|
28
|
+
name: "namespace",
|
|
29
|
+
required: true,
|
|
30
|
+
schema: {
|
|
31
|
+
type: "string",
|
|
32
|
+
},
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
description: "Service\nIdentifies the destination service.",
|
|
36
|
+
in: "path",
|
|
37
|
+
name: "service_name",
|
|
38
|
+
required: true,
|
|
39
|
+
schema: {
|
|
40
|
+
type: "string",
|
|
41
|
+
},
|
|
42
|
+
},
|
|
43
|
+
],
|
|
44
|
+
queryParameters: [],
|
|
45
|
+
requestBodySchema: {
|
|
46
|
+
$ref: "#/components/schemas/app_typeServiceAPIEndpointsReq",
|
|
47
|
+
},
|
|
48
|
+
responseSchema: {
|
|
49
|
+
$ref: "#/components/schemas/app_typeAPIEndpointsRsp",
|
|
50
|
+
},
|
|
51
|
+
requiredParams: ["app_type_name", "body", "namespace", "service_name"],
|
|
52
|
+
operationId: "ves.io.schema.app_type.CustomAPI.GetServiceAPIEndpoints",
|
|
53
|
+
tags: ["Other"],
|
|
54
|
+
sourceFile: "domains/applications.json",
|
|
55
|
+
},
|
|
56
|
+
{
|
|
57
|
+
toolName: "f5xc-api-applications-api-endpoint-list",
|
|
58
|
+
method: "GET",
|
|
59
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoints",
|
|
60
|
+
operation: "list",
|
|
61
|
+
domain: "applications",
|
|
62
|
+
resource: "api-endpoint",
|
|
63
|
+
summary: "GET API endpoints.",
|
|
64
|
+
description: "GET all auto discovered API endpoints for App type.",
|
|
65
|
+
pathParameters: [
|
|
66
|
+
{
|
|
67
|
+
description: "App Type\nApp Type for current request.",
|
|
68
|
+
in: "path",
|
|
69
|
+
name: "app_type_name",
|
|
70
|
+
required: true,
|
|
71
|
+
schema: {
|
|
72
|
+
type: "string",
|
|
73
|
+
},
|
|
74
|
+
},
|
|
75
|
+
{
|
|
76
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
77
|
+
in: "path",
|
|
78
|
+
name: "namespace",
|
|
79
|
+
required: true,
|
|
80
|
+
schema: {
|
|
81
|
+
type: "string",
|
|
82
|
+
},
|
|
83
|
+
},
|
|
84
|
+
],
|
|
85
|
+
queryParameters: [
|
|
86
|
+
{
|
|
87
|
+
description: "List of additional things that needs to be sent as part of the request\n\nAPI ENDPOINT INFO NONE option is used to disable any additional info request per API endpoint response\nAPI ENDPOINT INFO PDF SPARKLINES option is used to enable pdf sparkline info along with the API endpoint response.",
|
|
88
|
+
in: "query",
|
|
89
|
+
name: "api_endpoint_info_request",
|
|
90
|
+
required: false,
|
|
91
|
+
schema: {
|
|
92
|
+
items: {
|
|
93
|
+
enum: ["API_ENDPOINT_INFO_NONE", "API_ENDPOINT_INFO_PDF_SPARKLINES"],
|
|
94
|
+
type: "string",
|
|
95
|
+
},
|
|
96
|
+
type: "array",
|
|
97
|
+
},
|
|
98
|
+
},
|
|
99
|
+
],
|
|
100
|
+
requestBodySchema: null,
|
|
101
|
+
responseSchema: {
|
|
102
|
+
$ref: "#/components/schemas/app_typeAPIEndpointsRsp",
|
|
103
|
+
},
|
|
104
|
+
requiredParams: ["app_type_name", "namespace"],
|
|
105
|
+
operationId: "ves.io.schema.app_type.CustomAPI.APIEndpoints",
|
|
106
|
+
tags: ["Other"],
|
|
107
|
+
sourceFile: "domains/applications.json",
|
|
108
|
+
},
|
|
109
|
+
{
|
|
110
|
+
toolName: "f5xc-api-applications-app-setting-create",
|
|
111
|
+
method: "POST",
|
|
112
|
+
path: "/api/config/namespaces/{metadata.namespace}/app_settings",
|
|
113
|
+
operation: "create",
|
|
114
|
+
domain: "applications",
|
|
115
|
+
resource: "app-setting",
|
|
116
|
+
summary: "Create App Setting.",
|
|
117
|
+
description: "Create App setting configuration in namespace metadata.namespace.",
|
|
118
|
+
pathParameters: [
|
|
119
|
+
{
|
|
120
|
+
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 ""',
|
|
121
|
+
in: "path",
|
|
122
|
+
name: "metadata.namespace",
|
|
123
|
+
required: true,
|
|
124
|
+
schema: {
|
|
125
|
+
type: "string",
|
|
126
|
+
},
|
|
127
|
+
},
|
|
128
|
+
],
|
|
129
|
+
queryParameters: [],
|
|
130
|
+
requestBodySchema: {
|
|
131
|
+
$ref: "#/components/schemas/app_settingCreateRequest",
|
|
132
|
+
},
|
|
133
|
+
responseSchema: {
|
|
134
|
+
$ref: "#/components/schemas/app_settingCreateResponse",
|
|
135
|
+
},
|
|
136
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
137
|
+
operationId: "ves.io.schema.app_setting.API.Create",
|
|
138
|
+
tags: ["Other"],
|
|
139
|
+
sourceFile: "domains/applications.json",
|
|
140
|
+
},
|
|
141
|
+
{
|
|
142
|
+
toolName: "f5xc-api-applications-app-setting-delete",
|
|
143
|
+
method: "DELETE",
|
|
144
|
+
path: "/api/config/namespaces/{namespace}/app_settings/{name}",
|
|
145
|
+
operation: "delete",
|
|
146
|
+
domain: "applications",
|
|
147
|
+
resource: "app-setting",
|
|
148
|
+
summary: "DELETE App Setting.",
|
|
149
|
+
description: "DELETE the specified app_setting.",
|
|
150
|
+
pathParameters: [
|
|
151
|
+
{
|
|
152
|
+
description: "Name\nName of the configuration object.",
|
|
153
|
+
in: "path",
|
|
154
|
+
name: "name",
|
|
155
|
+
required: true,
|
|
156
|
+
schema: {
|
|
157
|
+
type: "string",
|
|
158
|
+
},
|
|
159
|
+
},
|
|
160
|
+
{
|
|
161
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
162
|
+
in: "path",
|
|
163
|
+
name: "namespace",
|
|
164
|
+
required: true,
|
|
165
|
+
schema: {
|
|
166
|
+
type: "string",
|
|
167
|
+
},
|
|
168
|
+
},
|
|
169
|
+
],
|
|
170
|
+
queryParameters: [],
|
|
171
|
+
requestBodySchema: {
|
|
172
|
+
$ref: "#/components/schemas/app_settingDeleteRequest",
|
|
173
|
+
},
|
|
174
|
+
responseSchema: {},
|
|
175
|
+
requiredParams: ["body", "name", "namespace"],
|
|
176
|
+
operationId: "ves.io.schema.app_setting.API.Delete",
|
|
177
|
+
tags: ["Other"],
|
|
178
|
+
sourceFile: "domains/applications.json",
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
toolName: "f5xc-api-applications-app-setting-get",
|
|
182
|
+
method: "GET",
|
|
183
|
+
path: "/api/config/namespaces/{namespace}/app_settings/{name}",
|
|
184
|
+
operation: "get",
|
|
185
|
+
domain: "applications",
|
|
186
|
+
resource: "app-setting",
|
|
187
|
+
summary: "GET App Setting.",
|
|
188
|
+
description: "GET App setting will retrieve the configuration from namespace metadata.namespace.",
|
|
189
|
+
pathParameters: [
|
|
190
|
+
{
|
|
191
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
192
|
+
in: "path",
|
|
193
|
+
name: "name",
|
|
194
|
+
required: true,
|
|
195
|
+
schema: {
|
|
196
|
+
type: "string",
|
|
197
|
+
},
|
|
198
|
+
},
|
|
199
|
+
{
|
|
200
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
201
|
+
in: "path",
|
|
202
|
+
name: "namespace",
|
|
203
|
+
required: true,
|
|
204
|
+
schema: {
|
|
205
|
+
type: "string",
|
|
206
|
+
},
|
|
207
|
+
},
|
|
208
|
+
],
|
|
209
|
+
queryParameters: [
|
|
210
|
+
{
|
|
211
|
+
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.",
|
|
212
|
+
in: "query",
|
|
213
|
+
name: "response_format",
|
|
214
|
+
required: false,
|
|
215
|
+
schema: {
|
|
216
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
217
|
+
enum: [
|
|
218
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
219
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
220
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
221
|
+
"GET_RSP_FORMAT_STATUS",
|
|
222
|
+
"GET_RSP_FORMAT_READ",
|
|
223
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
224
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
225
|
+
],
|
|
226
|
+
type: "string",
|
|
227
|
+
},
|
|
228
|
+
},
|
|
229
|
+
],
|
|
230
|
+
requestBodySchema: null,
|
|
231
|
+
responseSchema: {
|
|
232
|
+
$ref: "#/components/schemas/app_settingGetResponse",
|
|
233
|
+
},
|
|
234
|
+
requiredParams: ["name", "namespace"],
|
|
235
|
+
operationId: "ves.io.schema.app_setting.API.Get",
|
|
236
|
+
tags: ["Other"],
|
|
237
|
+
sourceFile: "domains/applications.json",
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
toolName: "f5xc-api-applications-app-setting-list",
|
|
241
|
+
method: "GET",
|
|
242
|
+
path: "/api/config/namespaces/{namespace}/app_settings",
|
|
243
|
+
operation: "list",
|
|
244
|
+
domain: "applications",
|
|
245
|
+
resource: "app-setting",
|
|
246
|
+
summary: "List App Setting.",
|
|
247
|
+
description: "List the set of app_setting in a namespace.",
|
|
248
|
+
pathParameters: [
|
|
249
|
+
{
|
|
250
|
+
description: "Namespace\nNamespace to scope the listing of app_setting.",
|
|
251
|
+
in: "path",
|
|
252
|
+
name: "namespace",
|
|
253
|
+
required: true,
|
|
254
|
+
schema: {
|
|
255
|
+
type: "string",
|
|
256
|
+
},
|
|
257
|
+
},
|
|
258
|
+
],
|
|
259
|
+
queryParameters: [
|
|
260
|
+
{
|
|
261
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
262
|
+
in: "query",
|
|
263
|
+
name: "label_filter",
|
|
264
|
+
required: false,
|
|
265
|
+
schema: {
|
|
266
|
+
type: "string",
|
|
267
|
+
},
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
271
|
+
in: "query",
|
|
272
|
+
name: "report_fields",
|
|
273
|
+
required: false,
|
|
274
|
+
schema: {
|
|
275
|
+
items: {
|
|
276
|
+
type: "string",
|
|
277
|
+
},
|
|
278
|
+
type: "array",
|
|
279
|
+
},
|
|
280
|
+
},
|
|
281
|
+
{
|
|
282
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
283
|
+
in: "query",
|
|
284
|
+
name: "report_status_fields",
|
|
285
|
+
required: false,
|
|
286
|
+
schema: {
|
|
287
|
+
items: {
|
|
288
|
+
type: "string",
|
|
289
|
+
},
|
|
290
|
+
type: "array",
|
|
291
|
+
},
|
|
292
|
+
},
|
|
293
|
+
],
|
|
294
|
+
requestBodySchema: null,
|
|
295
|
+
responseSchema: {
|
|
296
|
+
$ref: "#/components/schemas/app_settingListResponse",
|
|
297
|
+
},
|
|
298
|
+
requiredParams: ["namespace"],
|
|
299
|
+
operationId: "ves.io.schema.app_setting.API.List",
|
|
300
|
+
tags: ["Other"],
|
|
301
|
+
sourceFile: "domains/applications.json",
|
|
302
|
+
},
|
|
303
|
+
{
|
|
304
|
+
toolName: "f5xc-api-applications-app-setting-update",
|
|
305
|
+
method: "PUT",
|
|
306
|
+
path: "/api/config/namespaces/{metadata.namespace}/app_settings/{metadata.name}",
|
|
307
|
+
operation: "update",
|
|
308
|
+
domain: "applications",
|
|
309
|
+
resource: "app-setting",
|
|
310
|
+
summary: "Replace App Setting.",
|
|
311
|
+
description: "Replacing an App setting will 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.",
|
|
312
|
+
pathParameters: [
|
|
313
|
+
{
|
|
314
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
315
|
+
in: "path",
|
|
316
|
+
name: "metadata.name",
|
|
317
|
+
required: true,
|
|
318
|
+
schema: {
|
|
319
|
+
type: "string",
|
|
320
|
+
},
|
|
321
|
+
},
|
|
322
|
+
{
|
|
323
|
+
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 ""',
|
|
324
|
+
in: "path",
|
|
325
|
+
name: "metadata.namespace",
|
|
326
|
+
required: true,
|
|
327
|
+
schema: {
|
|
328
|
+
type: "string",
|
|
329
|
+
},
|
|
330
|
+
},
|
|
331
|
+
],
|
|
332
|
+
queryParameters: [],
|
|
333
|
+
requestBodySchema: {
|
|
334
|
+
$ref: "#/components/schemas/app_settingReplaceRequest",
|
|
335
|
+
},
|
|
336
|
+
responseSchema: {
|
|
337
|
+
$ref: "#/components/schemas/app_settingReplaceResponse",
|
|
338
|
+
},
|
|
339
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
340
|
+
operationId: "ves.io.schema.app_setting.API.Replace",
|
|
341
|
+
tags: ["Other"],
|
|
342
|
+
sourceFile: "domains/applications.json",
|
|
343
|
+
},
|
|
344
|
+
{
|
|
345
|
+
toolName: "f5xc-api-applications-app-type-create",
|
|
346
|
+
method: "POST",
|
|
347
|
+
path: "/api/config/namespaces/{metadata.namespace}/app_types",
|
|
348
|
+
operation: "create",
|
|
349
|
+
domain: "applications",
|
|
350
|
+
resource: "app-type",
|
|
351
|
+
summary: "Create App Type.",
|
|
352
|
+
description: "Create App type will create the configuration in namespace metadata.namespace.",
|
|
353
|
+
pathParameters: [
|
|
354
|
+
{
|
|
355
|
+
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 ""',
|
|
356
|
+
in: "path",
|
|
357
|
+
name: "metadata.namespace",
|
|
358
|
+
required: true,
|
|
359
|
+
schema: {
|
|
360
|
+
type: "string",
|
|
361
|
+
},
|
|
362
|
+
},
|
|
363
|
+
],
|
|
364
|
+
queryParameters: [],
|
|
365
|
+
requestBodySchema: {
|
|
366
|
+
$ref: "#/components/schemas/app_typeCreateRequest",
|
|
367
|
+
},
|
|
368
|
+
responseSchema: {
|
|
369
|
+
$ref: "#/components/schemas/app_typeCreateResponse",
|
|
370
|
+
},
|
|
371
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
372
|
+
operationId: "ves.io.schema.app_type.API.Create",
|
|
373
|
+
tags: ["Other"],
|
|
374
|
+
sourceFile: "domains/applications.json",
|
|
375
|
+
},
|
|
376
|
+
{
|
|
377
|
+
toolName: "f5xc-api-applications-app-type-delete",
|
|
378
|
+
method: "DELETE",
|
|
379
|
+
path: "/api/config/namespaces/{namespace}/app_types/{name}",
|
|
380
|
+
operation: "delete",
|
|
381
|
+
domain: "applications",
|
|
382
|
+
resource: "app-type",
|
|
383
|
+
summary: "DELETE App Type.",
|
|
384
|
+
description: "DELETE the specified app_type.",
|
|
385
|
+
pathParameters: [
|
|
386
|
+
{
|
|
387
|
+
description: "Name\nName of the configuration object.",
|
|
388
|
+
in: "path",
|
|
389
|
+
name: "name",
|
|
390
|
+
required: true,
|
|
391
|
+
schema: {
|
|
392
|
+
type: "string",
|
|
393
|
+
},
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
397
|
+
in: "path",
|
|
398
|
+
name: "namespace",
|
|
399
|
+
required: true,
|
|
400
|
+
schema: {
|
|
401
|
+
type: "string",
|
|
402
|
+
},
|
|
403
|
+
},
|
|
404
|
+
],
|
|
405
|
+
queryParameters: [],
|
|
406
|
+
requestBodySchema: {
|
|
407
|
+
$ref: "#/components/schemas/app_typeDeleteRequest",
|
|
408
|
+
},
|
|
409
|
+
responseSchema: {},
|
|
410
|
+
requiredParams: ["body", "name", "namespace"],
|
|
411
|
+
operationId: "ves.io.schema.app_type.API.Delete",
|
|
412
|
+
tags: ["Other"],
|
|
413
|
+
sourceFile: "domains/applications.json",
|
|
414
|
+
},
|
|
415
|
+
{
|
|
416
|
+
toolName: "f5xc-api-applications-app-type-get",
|
|
417
|
+
method: "GET",
|
|
418
|
+
path: "/api/config/namespaces/{namespace}/app_types/{name}",
|
|
419
|
+
operation: "get",
|
|
420
|
+
domain: "applications",
|
|
421
|
+
resource: "app-type",
|
|
422
|
+
summary: "GET App Type.",
|
|
423
|
+
description: "GET App type will read the configuration from namespace metadata.namespace.",
|
|
424
|
+
pathParameters: [
|
|
425
|
+
{
|
|
426
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
427
|
+
in: "path",
|
|
428
|
+
name: "name",
|
|
429
|
+
required: true,
|
|
430
|
+
schema: {
|
|
431
|
+
type: "string",
|
|
432
|
+
},
|
|
433
|
+
},
|
|
434
|
+
{
|
|
435
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
436
|
+
in: "path",
|
|
437
|
+
name: "namespace",
|
|
438
|
+
required: true,
|
|
439
|
+
schema: {
|
|
440
|
+
type: "string",
|
|
441
|
+
},
|
|
442
|
+
},
|
|
443
|
+
],
|
|
444
|
+
queryParameters: [
|
|
445
|
+
{
|
|
446
|
+
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.",
|
|
447
|
+
in: "query",
|
|
448
|
+
name: "response_format",
|
|
449
|
+
required: false,
|
|
450
|
+
schema: {
|
|
451
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
452
|
+
enum: [
|
|
453
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
454
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
455
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
456
|
+
"GET_RSP_FORMAT_STATUS",
|
|
457
|
+
"GET_RSP_FORMAT_READ",
|
|
458
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
459
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
460
|
+
],
|
|
461
|
+
type: "string",
|
|
462
|
+
},
|
|
463
|
+
},
|
|
464
|
+
],
|
|
465
|
+
requestBodySchema: null,
|
|
466
|
+
responseSchema: {
|
|
467
|
+
$ref: "#/components/schemas/app_typeGetResponse",
|
|
468
|
+
},
|
|
469
|
+
requiredParams: ["name", "namespace"],
|
|
470
|
+
operationId: "ves.io.schema.app_type.API.Get",
|
|
471
|
+
tags: ["Other"],
|
|
472
|
+
sourceFile: "domains/applications.json",
|
|
473
|
+
},
|
|
474
|
+
{
|
|
475
|
+
toolName: "f5xc-api-applications-app-type-list",
|
|
476
|
+
method: "GET",
|
|
477
|
+
path: "/api/config/namespaces/{namespace}/app_types",
|
|
478
|
+
operation: "list",
|
|
479
|
+
domain: "applications",
|
|
480
|
+
resource: "app-type",
|
|
481
|
+
summary: "List App Type.",
|
|
482
|
+
description: "List the set of app_type in a namespace.",
|
|
483
|
+
pathParameters: [
|
|
484
|
+
{
|
|
485
|
+
description: "Namespace\nNamespace to scope the listing of app_type.",
|
|
486
|
+
in: "path",
|
|
487
|
+
name: "namespace",
|
|
488
|
+
required: true,
|
|
489
|
+
schema: {
|
|
490
|
+
type: "string",
|
|
491
|
+
},
|
|
492
|
+
},
|
|
493
|
+
],
|
|
494
|
+
queryParameters: [
|
|
495
|
+
{
|
|
496
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
497
|
+
in: "query",
|
|
498
|
+
name: "label_filter",
|
|
499
|
+
required: false,
|
|
500
|
+
schema: {
|
|
501
|
+
type: "string",
|
|
502
|
+
},
|
|
503
|
+
},
|
|
504
|
+
{
|
|
505
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
506
|
+
in: "query",
|
|
507
|
+
name: "report_fields",
|
|
508
|
+
required: false,
|
|
509
|
+
schema: {
|
|
510
|
+
items: {
|
|
511
|
+
type: "string",
|
|
512
|
+
},
|
|
513
|
+
type: "array",
|
|
514
|
+
},
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
518
|
+
in: "query",
|
|
519
|
+
name: "report_status_fields",
|
|
520
|
+
required: false,
|
|
521
|
+
schema: {
|
|
522
|
+
items: {
|
|
523
|
+
type: "string",
|
|
524
|
+
},
|
|
525
|
+
type: "array",
|
|
526
|
+
},
|
|
527
|
+
},
|
|
528
|
+
],
|
|
529
|
+
requestBodySchema: null,
|
|
530
|
+
responseSchema: {
|
|
531
|
+
$ref: "#/components/schemas/app_typeListResponse",
|
|
532
|
+
},
|
|
533
|
+
requiredParams: ["namespace"],
|
|
534
|
+
operationId: "ves.io.schema.app_type.API.List",
|
|
535
|
+
tags: ["Other"],
|
|
536
|
+
sourceFile: "domains/applications.json",
|
|
537
|
+
},
|
|
538
|
+
{
|
|
539
|
+
toolName: "f5xc-api-applications-app-type-update",
|
|
540
|
+
method: "PUT",
|
|
541
|
+
path: "/api/config/namespaces/{metadata.namespace}/app_types/{metadata.name}",
|
|
542
|
+
operation: "update",
|
|
543
|
+
domain: "applications",
|
|
544
|
+
resource: "app-type",
|
|
545
|
+
summary: "Replace App Type.",
|
|
546
|
+
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.",
|
|
547
|
+
pathParameters: [
|
|
548
|
+
{
|
|
549
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
550
|
+
in: "path",
|
|
551
|
+
name: "metadata.name",
|
|
552
|
+
required: true,
|
|
553
|
+
schema: {
|
|
554
|
+
type: "string",
|
|
555
|
+
},
|
|
556
|
+
},
|
|
557
|
+
{
|
|
558
|
+
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 ""',
|
|
559
|
+
in: "path",
|
|
560
|
+
name: "metadata.namespace",
|
|
561
|
+
required: true,
|
|
562
|
+
schema: {
|
|
563
|
+
type: "string",
|
|
564
|
+
},
|
|
565
|
+
},
|
|
566
|
+
],
|
|
567
|
+
queryParameters: [],
|
|
568
|
+
requestBodySchema: {
|
|
569
|
+
$ref: "#/components/schemas/app_typeReplaceRequest",
|
|
570
|
+
},
|
|
571
|
+
responseSchema: {
|
|
572
|
+
$ref: "#/components/schemas/app_typeReplaceResponse",
|
|
573
|
+
},
|
|
574
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
575
|
+
operationId: "ves.io.schema.app_type.API.Replace",
|
|
576
|
+
tags: ["Other"],
|
|
577
|
+
sourceFile: "domains/applications.json",
|
|
578
|
+
},
|
|
579
|
+
{
|
|
580
|
+
toolName: "f5xc-api-applications-learnt-schema-create",
|
|
581
|
+
method: "POST",
|
|
582
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoint/learnt_schema",
|
|
583
|
+
operation: "create",
|
|
584
|
+
domain: "applications",
|
|
585
|
+
resource: "learnt-schema",
|
|
586
|
+
summary: "GET Learnt Schema per API endpoint.",
|
|
587
|
+
description: "GET Learnt Schema per API endpoint for a given auto discovered API endpoint for Service.",
|
|
588
|
+
pathParameters: [
|
|
589
|
+
{
|
|
590
|
+
description: "App Type\nApp Type for current request.",
|
|
591
|
+
in: "path",
|
|
592
|
+
name: "app_type_name",
|
|
593
|
+
required: true,
|
|
594
|
+
schema: {
|
|
595
|
+
type: "string",
|
|
596
|
+
},
|
|
597
|
+
},
|
|
598
|
+
{
|
|
599
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
600
|
+
in: "path",
|
|
601
|
+
name: "namespace",
|
|
602
|
+
required: true,
|
|
603
|
+
schema: {
|
|
604
|
+
type: "string",
|
|
605
|
+
},
|
|
606
|
+
},
|
|
607
|
+
],
|
|
608
|
+
queryParameters: [],
|
|
609
|
+
requestBodySchema: {
|
|
610
|
+
$ref: "#/components/schemas/app_typeAPIEndpointLearntSchemaReq",
|
|
611
|
+
},
|
|
612
|
+
responseSchema: {
|
|
613
|
+
$ref: "#/components/schemas/app_typeAPIEndpointLearntSchemaRsp",
|
|
614
|
+
},
|
|
615
|
+
requiredParams: ["app_type_name", "body", "namespace"],
|
|
616
|
+
operationId: "ves.io.schema.app_type.CustomAPI.GetAPIEndpointLearntSchema",
|
|
617
|
+
tags: ["Other"],
|
|
618
|
+
sourceFile: "domains/applications.json",
|
|
619
|
+
},
|
|
620
|
+
{
|
|
621
|
+
toolName: "f5xc-api-applications-override-list",
|
|
622
|
+
method: "GET",
|
|
623
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/overrides",
|
|
624
|
+
operation: "list",
|
|
625
|
+
domain: "applications",
|
|
626
|
+
resource: "override",
|
|
627
|
+
summary: "GET Override.",
|
|
628
|
+
description: "GET all override for API endpoints configured for this App type.",
|
|
629
|
+
pathParameters: [
|
|
630
|
+
{
|
|
631
|
+
description: "App Type\nApp Type for current request.",
|
|
632
|
+
in: "path",
|
|
633
|
+
name: "app_type_name",
|
|
634
|
+
required: true,
|
|
635
|
+
schema: {
|
|
636
|
+
type: "string",
|
|
637
|
+
},
|
|
638
|
+
},
|
|
639
|
+
{
|
|
640
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
641
|
+
in: "path",
|
|
642
|
+
name: "namespace",
|
|
643
|
+
required: true,
|
|
644
|
+
schema: {
|
|
645
|
+
type: "string",
|
|
646
|
+
},
|
|
647
|
+
},
|
|
648
|
+
],
|
|
649
|
+
queryParameters: [],
|
|
650
|
+
requestBodySchema: null,
|
|
651
|
+
responseSchema: {
|
|
652
|
+
$ref: "#/components/schemas/app_typeOverridesRsp",
|
|
653
|
+
},
|
|
654
|
+
requiredParams: ["app_type_name", "namespace"],
|
|
655
|
+
operationId: "ves.io.schema.app_type.CustomAPI.Overrides",
|
|
656
|
+
tags: ["Other"],
|
|
657
|
+
sourceFile: "domains/applications.json",
|
|
658
|
+
},
|
|
659
|
+
{
|
|
660
|
+
toolName: "f5xc-api-applications-pdf-create",
|
|
661
|
+
method: "POST",
|
|
662
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/services/{service_name}/api_endpoint/pdf",
|
|
663
|
+
operation: "create",
|
|
664
|
+
domain: "applications",
|
|
665
|
+
resource: "pdf",
|
|
666
|
+
summary: "GET Service API Endpoint PDF.",
|
|
667
|
+
description: "GET PDF of all metrics for a given auto discovered API endpoint for Service.",
|
|
668
|
+
pathParameters: [
|
|
669
|
+
{
|
|
670
|
+
description: "App Type\nApp Type for current request.",
|
|
671
|
+
in: "path",
|
|
672
|
+
name: "app_type_name",
|
|
673
|
+
required: true,
|
|
674
|
+
schema: {
|
|
675
|
+
type: "string",
|
|
676
|
+
},
|
|
677
|
+
},
|
|
678
|
+
{
|
|
679
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
680
|
+
in: "path",
|
|
681
|
+
name: "namespace",
|
|
682
|
+
required: true,
|
|
683
|
+
schema: {
|
|
684
|
+
type: "string",
|
|
685
|
+
},
|
|
686
|
+
},
|
|
687
|
+
{
|
|
688
|
+
description: "Service\nIdentifies the destination service.",
|
|
689
|
+
in: "path",
|
|
690
|
+
name: "service_name",
|
|
691
|
+
required: true,
|
|
692
|
+
schema: {
|
|
693
|
+
type: "string",
|
|
694
|
+
},
|
|
695
|
+
},
|
|
696
|
+
],
|
|
697
|
+
queryParameters: [],
|
|
698
|
+
requestBodySchema: {
|
|
699
|
+
$ref: "#/components/schemas/app_typeServiceAPIEndpointPDFReq",
|
|
700
|
+
},
|
|
701
|
+
responseSchema: {
|
|
702
|
+
$ref: "#/components/schemas/app_typeAPIEndpointPDFRsp",
|
|
703
|
+
},
|
|
704
|
+
requiredParams: ["app_type_name", "body", "namespace", "service_name"],
|
|
705
|
+
operationId: "ves.io.schema.app_type.CustomAPI.GetServiceAPIEndpointPDF",
|
|
706
|
+
tags: ["Other"],
|
|
707
|
+
sourceFile: "domains/applications.json",
|
|
708
|
+
},
|
|
709
|
+
{
|
|
710
|
+
toolName: "f5xc-api-applications-pdf-list",
|
|
711
|
+
method: "GET",
|
|
712
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoint/pdf",
|
|
713
|
+
operation: "list",
|
|
714
|
+
domain: "applications",
|
|
715
|
+
resource: "pdf",
|
|
716
|
+
summary: "GET PDF",
|
|
717
|
+
description: "GET PDF of all metrics for a given auto discovered API endpoint for App type.",
|
|
718
|
+
pathParameters: [
|
|
719
|
+
{
|
|
720
|
+
description: "App Type\nApp Type for current request.",
|
|
721
|
+
in: "path",
|
|
722
|
+
name: "app_type_name",
|
|
723
|
+
required: true,
|
|
724
|
+
schema: {
|
|
725
|
+
type: "string",
|
|
726
|
+
},
|
|
727
|
+
},
|
|
728
|
+
{
|
|
729
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
730
|
+
in: "path",
|
|
731
|
+
name: "namespace",
|
|
732
|
+
required: true,
|
|
733
|
+
schema: {
|
|
734
|
+
type: "string",
|
|
735
|
+
},
|
|
736
|
+
},
|
|
737
|
+
],
|
|
738
|
+
queryParameters: [
|
|
739
|
+
{
|
|
740
|
+
description: "API endpoint for which PDFs are requested.",
|
|
741
|
+
in: "query",
|
|
742
|
+
name: "collapsed_url",
|
|
743
|
+
required: false,
|
|
744
|
+
schema: {
|
|
745
|
+
type: "string",
|
|
746
|
+
},
|
|
747
|
+
},
|
|
748
|
+
{
|
|
749
|
+
description: "Method of API endpoint for which PDFs are requested.",
|
|
750
|
+
in: "query",
|
|
751
|
+
name: "method",
|
|
752
|
+
required: false,
|
|
753
|
+
schema: {
|
|
754
|
+
type: "string",
|
|
755
|
+
},
|
|
756
|
+
},
|
|
757
|
+
],
|
|
758
|
+
requestBodySchema: null,
|
|
759
|
+
responseSchema: {
|
|
760
|
+
$ref: "#/components/schemas/app_typeAPIEndpointPDFRsp",
|
|
761
|
+
},
|
|
762
|
+
requiredParams: ["app_type_name", "namespace"],
|
|
763
|
+
operationId: "ves.io.schema.app_type.CustomAPI.APIEndpointPDF",
|
|
764
|
+
tags: ["Other"],
|
|
765
|
+
sourceFile: "domains/applications.json",
|
|
766
|
+
},
|
|
767
|
+
{
|
|
768
|
+
toolName: "f5xc-api-applications-pop-create",
|
|
769
|
+
method: "POST",
|
|
770
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/pop",
|
|
771
|
+
operation: "create",
|
|
772
|
+
domain: "applications",
|
|
773
|
+
resource: "pop",
|
|
774
|
+
summary: "Remove Override.",
|
|
775
|
+
description: "Remove override for dynamic component for API endpoints discovered for this App type.",
|
|
776
|
+
pathParameters: [
|
|
777
|
+
{
|
|
778
|
+
description: "App Type\nApp Type for current request.",
|
|
779
|
+
in: "path",
|
|
780
|
+
name: "app_type_name",
|
|
781
|
+
required: true,
|
|
782
|
+
schema: {
|
|
783
|
+
type: "string",
|
|
784
|
+
},
|
|
785
|
+
},
|
|
786
|
+
{
|
|
787
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
788
|
+
in: "path",
|
|
789
|
+
name: "namespace",
|
|
790
|
+
required: true,
|
|
791
|
+
schema: {
|
|
792
|
+
type: "string",
|
|
793
|
+
},
|
|
794
|
+
},
|
|
795
|
+
],
|
|
796
|
+
queryParameters: [],
|
|
797
|
+
requestBodySchema: {
|
|
798
|
+
$ref: "#/components/schemas/app_typeOverridePopReq",
|
|
799
|
+
},
|
|
800
|
+
responseSchema: {
|
|
801
|
+
$ref: "#/components/schemas/app_typeOverridePopRsp",
|
|
802
|
+
},
|
|
803
|
+
requiredParams: ["app_type_name", "body", "namespace"],
|
|
804
|
+
operationId: "ves.io.schema.app_type.CustomAPI.OverridePop",
|
|
805
|
+
tags: ["Other"],
|
|
806
|
+
sourceFile: "domains/applications.json",
|
|
807
|
+
},
|
|
808
|
+
{
|
|
809
|
+
toolName: "f5xc-api-applications-push-create",
|
|
810
|
+
method: "POST",
|
|
811
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/override/push",
|
|
812
|
+
operation: "create",
|
|
813
|
+
domain: "applications",
|
|
814
|
+
resource: "push",
|
|
815
|
+
summary: "Add Override.",
|
|
816
|
+
description: "Add override for dynamic component for API endpoints discovered for this App type.",
|
|
817
|
+
pathParameters: [
|
|
818
|
+
{
|
|
819
|
+
description: "App Type\nApp Type for current request.",
|
|
820
|
+
in: "path",
|
|
821
|
+
name: "app_type_name",
|
|
822
|
+
required: true,
|
|
823
|
+
schema: {
|
|
824
|
+
type: "string",
|
|
825
|
+
},
|
|
826
|
+
},
|
|
827
|
+
{
|
|
828
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
829
|
+
in: "path",
|
|
830
|
+
name: "namespace",
|
|
831
|
+
required: true,
|
|
832
|
+
schema: {
|
|
833
|
+
type: "string",
|
|
834
|
+
},
|
|
835
|
+
},
|
|
836
|
+
],
|
|
837
|
+
queryParameters: [],
|
|
838
|
+
requestBodySchema: {
|
|
839
|
+
$ref: "#/components/schemas/app_typeOverridePushReq",
|
|
840
|
+
},
|
|
841
|
+
responseSchema: {
|
|
842
|
+
$ref: "#/components/schemas/app_typeOverridePushRsp",
|
|
843
|
+
},
|
|
844
|
+
requiredParams: ["app_type_name", "body", "namespace"],
|
|
845
|
+
operationId: "ves.io.schema.app_type.CustomAPI.OverridePush",
|
|
846
|
+
tags: ["Other"],
|
|
847
|
+
sourceFile: "domains/applications.json",
|
|
848
|
+
},
|
|
849
|
+
{
|
|
850
|
+
toolName: "f5xc-api-applications-static-component-get",
|
|
851
|
+
method: "GET",
|
|
852
|
+
path: "/api/web/namespaces/{namespace}/static_components/{name}",
|
|
853
|
+
operation: "get",
|
|
854
|
+
domain: "applications",
|
|
855
|
+
resource: "static-component",
|
|
856
|
+
summary: "GET UI static component.",
|
|
857
|
+
description: "GET UI static component.",
|
|
858
|
+
pathParameters: [
|
|
859
|
+
{
|
|
860
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
861
|
+
in: "path",
|
|
862
|
+
name: "name",
|
|
863
|
+
required: true,
|
|
864
|
+
schema: {
|
|
865
|
+
type: "string",
|
|
866
|
+
},
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
870
|
+
in: "path",
|
|
871
|
+
name: "namespace",
|
|
872
|
+
required: true,
|
|
873
|
+
schema: {
|
|
874
|
+
type: "string",
|
|
875
|
+
},
|
|
876
|
+
},
|
|
877
|
+
],
|
|
878
|
+
queryParameters: [
|
|
879
|
+
{
|
|
880
|
+
description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
|
|
881
|
+
in: "query",
|
|
882
|
+
name: "response_format",
|
|
883
|
+
required: false,
|
|
884
|
+
schema: {
|
|
885
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
886
|
+
enum: [
|
|
887
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
888
|
+
"GET_RSP_FORMAT_READ",
|
|
889
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
890
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
891
|
+
],
|
|
892
|
+
type: "string",
|
|
893
|
+
},
|
|
894
|
+
},
|
|
895
|
+
],
|
|
896
|
+
requestBodySchema: null,
|
|
897
|
+
responseSchema: {
|
|
898
|
+
$ref: "#/components/schemas/static_componentGetResponse",
|
|
899
|
+
},
|
|
900
|
+
requiredParams: ["name", "namespace"],
|
|
901
|
+
operationId: "ves.io.schema.ui.static_component.API.Get",
|
|
902
|
+
tags: ["Other"],
|
|
903
|
+
sourceFile: "domains/applications.json",
|
|
904
|
+
},
|
|
905
|
+
{
|
|
906
|
+
toolName: "f5xc-api-applications-static-component-list",
|
|
907
|
+
method: "GET",
|
|
908
|
+
path: "/api/web/namespaces/{namespace}/static_components",
|
|
909
|
+
operation: "list",
|
|
910
|
+
domain: "applications",
|
|
911
|
+
resource: "static-component",
|
|
912
|
+
summary: "List UI Static Component.",
|
|
913
|
+
description: "List the set of static_component in a namespace.",
|
|
914
|
+
pathParameters: [
|
|
915
|
+
{
|
|
916
|
+
description: "Namespace\nNamespace to scope the listing of static_component.",
|
|
917
|
+
in: "path",
|
|
918
|
+
name: "namespace",
|
|
919
|
+
required: true,
|
|
920
|
+
schema: {
|
|
921
|
+
type: "string",
|
|
922
|
+
},
|
|
923
|
+
},
|
|
924
|
+
],
|
|
925
|
+
queryParameters: [
|
|
926
|
+
{
|
|
927
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
928
|
+
in: "query",
|
|
929
|
+
name: "label_filter",
|
|
930
|
+
required: false,
|
|
931
|
+
schema: {
|
|
932
|
+
type: "string",
|
|
933
|
+
},
|
|
934
|
+
},
|
|
935
|
+
{
|
|
936
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
937
|
+
in: "query",
|
|
938
|
+
name: "report_fields",
|
|
939
|
+
required: false,
|
|
940
|
+
schema: {
|
|
941
|
+
items: {
|
|
942
|
+
type: "string",
|
|
943
|
+
},
|
|
944
|
+
type: "array",
|
|
945
|
+
},
|
|
946
|
+
},
|
|
947
|
+
{
|
|
948
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
949
|
+
in: "query",
|
|
950
|
+
name: "report_status_fields",
|
|
951
|
+
required: false,
|
|
952
|
+
schema: {
|
|
953
|
+
items: {
|
|
954
|
+
type: "string",
|
|
955
|
+
},
|
|
956
|
+
type: "array",
|
|
957
|
+
},
|
|
958
|
+
},
|
|
959
|
+
],
|
|
960
|
+
requestBodySchema: null,
|
|
961
|
+
responseSchema: {
|
|
962
|
+
$ref: "#/components/schemas/static_componentListResponse",
|
|
963
|
+
},
|
|
964
|
+
requiredParams: ["namespace"],
|
|
965
|
+
operationId: "ves.io.schema.ui.static_component.API.List",
|
|
966
|
+
tags: ["Other"],
|
|
967
|
+
sourceFile: "domains/applications.json",
|
|
968
|
+
},
|
|
969
|
+
{
|
|
970
|
+
toolName: "f5xc-api-applications-suspicious-user-get",
|
|
971
|
+
method: "GET",
|
|
972
|
+
path: "/api/ml/data/namespaces/{namespace}/app_settings/{name}/suspicious_users",
|
|
973
|
+
operation: "get",
|
|
974
|
+
domain: "applications",
|
|
975
|
+
resource: "suspicious-user",
|
|
976
|
+
summary: "GET Status of Suspicious users.",
|
|
977
|
+
description: "GET status of suspicious users.",
|
|
978
|
+
pathParameters: [
|
|
979
|
+
{
|
|
980
|
+
description: "Name\nfetch suspicious users based on a given app setting.",
|
|
981
|
+
in: "path",
|
|
982
|
+
name: "name",
|
|
983
|
+
required: true,
|
|
984
|
+
schema: {
|
|
985
|
+
type: "string",
|
|
986
|
+
},
|
|
987
|
+
},
|
|
988
|
+
{
|
|
989
|
+
description: "Namespace\n\nfetch suspicious users for a given namespace.",
|
|
990
|
+
in: "path",
|
|
991
|
+
name: "namespace",
|
|
992
|
+
required: true,
|
|
993
|
+
schema: {
|
|
994
|
+
type: "string",
|
|
995
|
+
},
|
|
996
|
+
},
|
|
997
|
+
],
|
|
998
|
+
queryParameters: [
|
|
999
|
+
{
|
|
1000
|
+
description: "Fetch suspicious users during timestamp <= end_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the end_time will be evaluated to start_time+10m\nIf start_time is not specified, then the end_time will be evaluated to <current time>",
|
|
1001
|
+
in: "query",
|
|
1002
|
+
name: "end_time",
|
|
1003
|
+
required: false,
|
|
1004
|
+
schema: {
|
|
1005
|
+
type: "string",
|
|
1006
|
+
},
|
|
1007
|
+
},
|
|
1008
|
+
{
|
|
1009
|
+
description: 'Blogging_app"}"\nquery is used to specify the list of matchers\nsyntax for query := {[<matcher>]}\n<matcher> := <field_name><operator>"<value>"\n<field_name> := string\nOne or more of these fields in the security event may be specified in the query.\nApp_type - application type\nvh_name - name of the virtual host\n<value> := string\n<operator> := ["="|"!="]\n= : equal to\n!= : not equal to\nWhen more than one matcher is specified in the query, then security events matching ALL the matchers will be returned in the response.\nExample: query={country="United States", city="California"} will return all security events originating from California, United States.\n\nOptional: If not specified, all the security events matching the given tenant and namespace will be returned in the response.',
|
|
1010
|
+
in: "query",
|
|
1011
|
+
name: "query",
|
|
1012
|
+
required: false,
|
|
1013
|
+
schema: {
|
|
1014
|
+
type: "string",
|
|
1015
|
+
},
|
|
1016
|
+
},
|
|
1017
|
+
{
|
|
1018
|
+
description: "Fetch suspicious users during timestamp >= start_time\nformat: unix_timestamp|RFC 3339\n\nOptional: If not specified, then the start_time will be evaluated to end_time-10m\nIf end_time is not specified, then the start_time will be evaluated to <current time>-10m.",
|
|
1019
|
+
in: "query",
|
|
1020
|
+
name: "start_time",
|
|
1021
|
+
required: false,
|
|
1022
|
+
schema: {
|
|
1023
|
+
type: "string",
|
|
1024
|
+
},
|
|
1025
|
+
},
|
|
1026
|
+
{
|
|
1027
|
+
description: "X-example: 10\nfetch top 10 suspicious users\n\nNumber of top field values to be returned in the response.\nOptional: If not specified, top 5 values will be returned in the response.",
|
|
1028
|
+
in: "query",
|
|
1029
|
+
name: "topn",
|
|
1030
|
+
required: false,
|
|
1031
|
+
schema: {
|
|
1032
|
+
format: "int64",
|
|
1033
|
+
type: "integer",
|
|
1034
|
+
},
|
|
1035
|
+
},
|
|
1036
|
+
],
|
|
1037
|
+
requestBodySchema: null,
|
|
1038
|
+
responseSchema: {
|
|
1039
|
+
$ref: "#/components/schemas/app_settingSuspiciousUserStatusRsp",
|
|
1040
|
+
},
|
|
1041
|
+
requiredParams: ["name", "namespace"],
|
|
1042
|
+
operationId: "ves.io.schema.app_setting.CustomAPI.SuspiciousUserStatus",
|
|
1043
|
+
tags: ["Other"],
|
|
1044
|
+
sourceFile: "domains/applications.json",
|
|
1045
|
+
},
|
|
1046
|
+
{
|
|
1047
|
+
toolName: "f5xc-api-applications-swagger-spec-list",
|
|
1048
|
+
method: "GET",
|
|
1049
|
+
path: "/api/ml/data/namespaces/{namespace}/app_types/{app_type_name}/api_endpoints/swagger_spec",
|
|
1050
|
+
operation: "list",
|
|
1051
|
+
domain: "applications",
|
|
1052
|
+
resource: "swagger-spec",
|
|
1053
|
+
summary: "GET Swagger Spec for App Type.",
|
|
1054
|
+
description: "GET the corresponding Swagger spec for the given app type.",
|
|
1055
|
+
pathParameters: [
|
|
1056
|
+
{
|
|
1057
|
+
description: "App Type\nApp Type for current request.",
|
|
1058
|
+
in: "path",
|
|
1059
|
+
name: "app_type_name",
|
|
1060
|
+
required: true,
|
|
1061
|
+
schema: {
|
|
1062
|
+
type: "string",
|
|
1063
|
+
},
|
|
1064
|
+
},
|
|
1065
|
+
{
|
|
1066
|
+
description: "Namespace\nNamespace of the App type for current request.",
|
|
1067
|
+
in: "path",
|
|
1068
|
+
name: "namespace",
|
|
1069
|
+
required: true,
|
|
1070
|
+
schema: {
|
|
1071
|
+
type: "string",
|
|
1072
|
+
},
|
|
1073
|
+
},
|
|
1074
|
+
],
|
|
1075
|
+
queryParameters: [],
|
|
1076
|
+
requestBodySchema: null,
|
|
1077
|
+
responseSchema: {
|
|
1078
|
+
$ref: "#/components/schemas/apiHttpBody",
|
|
1079
|
+
},
|
|
1080
|
+
requiredParams: ["app_type_name", "namespace"],
|
|
1081
|
+
operationId: "ves.io.schema.app_type.CustomAPI.GetSwaggerSpec",
|
|
1082
|
+
tags: ["Other"],
|
|
1083
|
+
sourceFile: "domains/applications.json",
|
|
1084
|
+
},
|
|
1085
|
+
{
|
|
1086
|
+
toolName: "f5xc-api-applications-usage-create",
|
|
1087
|
+
method: "POST",
|
|
1088
|
+
path: "/api/data/namespaces/{namespace}/workloads/usage",
|
|
1089
|
+
operation: "create",
|
|
1090
|
+
domain: "applications",
|
|
1091
|
+
resource: "usage",
|
|
1092
|
+
summary: "Usage Metrics.",
|
|
1093
|
+
description: "GET the workload usage.",
|
|
1094
|
+
pathParameters: [
|
|
1095
|
+
{
|
|
1096
|
+
description: "Namespace\nnamespace is used to scope the workload usage to a given namespace.",
|
|
1097
|
+
in: "path",
|
|
1098
|
+
name: "namespace",
|
|
1099
|
+
required: true,
|
|
1100
|
+
schema: {
|
|
1101
|
+
type: "string",
|
|
1102
|
+
},
|
|
1103
|
+
},
|
|
1104
|
+
],
|
|
1105
|
+
queryParameters: [],
|
|
1106
|
+
requestBodySchema: {
|
|
1107
|
+
$ref: "#/components/schemas/workloadUsageRequest",
|
|
1108
|
+
},
|
|
1109
|
+
responseSchema: {
|
|
1110
|
+
$ref: "#/components/schemas/workloadUsageResponse",
|
|
1111
|
+
},
|
|
1112
|
+
requiredParams: ["body", "namespace"],
|
|
1113
|
+
operationId: "ves.io.schema.views.workload.CustomDataAPI.Usage",
|
|
1114
|
+
tags: ["Other"],
|
|
1115
|
+
sourceFile: "domains/applications.json",
|
|
1116
|
+
},
|
|
1117
|
+
{
|
|
1118
|
+
toolName: "f5xc-api-applications-workload-create",
|
|
1119
|
+
method: "POST",
|
|
1120
|
+
path: "/api/config/namespaces/{metadata.namespace}/workloads",
|
|
1121
|
+
operation: "create",
|
|
1122
|
+
domain: "applications",
|
|
1123
|
+
resource: "workload",
|
|
1124
|
+
summary: "Create Workload.",
|
|
1125
|
+
description: "Shape of Workload.",
|
|
1126
|
+
pathParameters: [
|
|
1127
|
+
{
|
|
1128
|
+
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 ""',
|
|
1129
|
+
in: "path",
|
|
1130
|
+
name: "metadata.namespace",
|
|
1131
|
+
required: true,
|
|
1132
|
+
schema: {
|
|
1133
|
+
type: "string",
|
|
1134
|
+
},
|
|
1135
|
+
},
|
|
1136
|
+
],
|
|
1137
|
+
queryParameters: [],
|
|
1138
|
+
requestBodySchema: {
|
|
1139
|
+
$ref: "#/components/schemas/workloadCreateRequest",
|
|
1140
|
+
},
|
|
1141
|
+
responseSchema: {
|
|
1142
|
+
$ref: "#/components/schemas/workloadCreateResponse",
|
|
1143
|
+
},
|
|
1144
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1145
|
+
operationId: "ves.io.schema.views.workload.API.Create",
|
|
1146
|
+
tags: ["Other"],
|
|
1147
|
+
sourceFile: "domains/applications.json",
|
|
1148
|
+
},
|
|
1149
|
+
{
|
|
1150
|
+
toolName: "f5xc-api-applications-workload-delete",
|
|
1151
|
+
method: "DELETE",
|
|
1152
|
+
path: "/api/config/namespaces/{namespace}/workloads/{name}",
|
|
1153
|
+
operation: "delete",
|
|
1154
|
+
domain: "applications",
|
|
1155
|
+
resource: "workload",
|
|
1156
|
+
summary: "DELETE Workload.",
|
|
1157
|
+
description: "DELETE the specified workload.",
|
|
1158
|
+
pathParameters: [
|
|
1159
|
+
{
|
|
1160
|
+
description: "Name\nName of the configuration object.",
|
|
1161
|
+
in: "path",
|
|
1162
|
+
name: "name",
|
|
1163
|
+
required: true,
|
|
1164
|
+
schema: {
|
|
1165
|
+
type: "string",
|
|
1166
|
+
},
|
|
1167
|
+
},
|
|
1168
|
+
{
|
|
1169
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1170
|
+
in: "path",
|
|
1171
|
+
name: "namespace",
|
|
1172
|
+
required: true,
|
|
1173
|
+
schema: {
|
|
1174
|
+
type: "string",
|
|
1175
|
+
},
|
|
1176
|
+
},
|
|
1177
|
+
],
|
|
1178
|
+
queryParameters: [],
|
|
1179
|
+
requestBodySchema: {
|
|
1180
|
+
$ref: "#/components/schemas/workloadDeleteRequest",
|
|
1181
|
+
},
|
|
1182
|
+
responseSchema: {},
|
|
1183
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1184
|
+
operationId: "ves.io.schema.views.workload.API.Delete",
|
|
1185
|
+
tags: ["Other"],
|
|
1186
|
+
sourceFile: "domains/applications.json",
|
|
1187
|
+
},
|
|
1188
|
+
{
|
|
1189
|
+
toolName: "f5xc-api-applications-workload-flavor-create",
|
|
1190
|
+
method: "POST",
|
|
1191
|
+
path: "/api/config/namespaces/{metadata.namespace}/workload_flavors",
|
|
1192
|
+
operation: "create",
|
|
1193
|
+
domain: "applications",
|
|
1194
|
+
resource: "workload-flavor",
|
|
1195
|
+
summary: "Create Workload Flavor.",
|
|
1196
|
+
description: "Create a workload_flavor.",
|
|
1197
|
+
pathParameters: [
|
|
1198
|
+
{
|
|
1199
|
+
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 ""',
|
|
1200
|
+
in: "path",
|
|
1201
|
+
name: "metadata.namespace",
|
|
1202
|
+
required: true,
|
|
1203
|
+
schema: {
|
|
1204
|
+
type: "string",
|
|
1205
|
+
},
|
|
1206
|
+
},
|
|
1207
|
+
],
|
|
1208
|
+
queryParameters: [],
|
|
1209
|
+
requestBodySchema: {
|
|
1210
|
+
$ref: "#/components/schemas/workload_flavorCreateRequest",
|
|
1211
|
+
},
|
|
1212
|
+
responseSchema: {
|
|
1213
|
+
$ref: "#/components/schemas/workload_flavorCreateResponse",
|
|
1214
|
+
},
|
|
1215
|
+
requiredParams: ["body", "metadata.namespace"],
|
|
1216
|
+
operationId: "ves.io.schema.workload_flavor.API.Create",
|
|
1217
|
+
tags: ["Other"],
|
|
1218
|
+
sourceFile: "domains/applications.json",
|
|
1219
|
+
},
|
|
1220
|
+
{
|
|
1221
|
+
toolName: "f5xc-api-applications-workload-flavor-delete",
|
|
1222
|
+
method: "DELETE",
|
|
1223
|
+
path: "/api/config/namespaces/{namespace}/workload_flavors/{name}",
|
|
1224
|
+
operation: "delete",
|
|
1225
|
+
domain: "applications",
|
|
1226
|
+
resource: "workload-flavor",
|
|
1227
|
+
summary: "DELETE Workload Flavor.",
|
|
1228
|
+
description: "DELETE the specified workload_flavor.",
|
|
1229
|
+
pathParameters: [
|
|
1230
|
+
{
|
|
1231
|
+
description: "Name\nName of the configuration object.",
|
|
1232
|
+
in: "path",
|
|
1233
|
+
name: "name",
|
|
1234
|
+
required: true,
|
|
1235
|
+
schema: {
|
|
1236
|
+
type: "string",
|
|
1237
|
+
},
|
|
1238
|
+
},
|
|
1239
|
+
{
|
|
1240
|
+
description: "Namespace\nNamespace in which the configuration object is present.",
|
|
1241
|
+
in: "path",
|
|
1242
|
+
name: "namespace",
|
|
1243
|
+
required: true,
|
|
1244
|
+
schema: {
|
|
1245
|
+
type: "string",
|
|
1246
|
+
},
|
|
1247
|
+
},
|
|
1248
|
+
],
|
|
1249
|
+
queryParameters: [],
|
|
1250
|
+
requestBodySchema: {
|
|
1251
|
+
$ref: "#/components/schemas/workload_flavorDeleteRequest",
|
|
1252
|
+
},
|
|
1253
|
+
responseSchema: {},
|
|
1254
|
+
requiredParams: ["body", "name", "namespace"],
|
|
1255
|
+
operationId: "ves.io.schema.workload_flavor.API.Delete",
|
|
1256
|
+
tags: ["Other"],
|
|
1257
|
+
sourceFile: "domains/applications.json",
|
|
1258
|
+
},
|
|
1259
|
+
{
|
|
1260
|
+
toolName: "f5xc-api-applications-workload-flavor-get",
|
|
1261
|
+
method: "GET",
|
|
1262
|
+
path: "/api/config/namespaces/{namespace}/workload_flavors/{name}",
|
|
1263
|
+
operation: "get",
|
|
1264
|
+
domain: "applications",
|
|
1265
|
+
resource: "workload-flavor",
|
|
1266
|
+
summary: "GET Workload Flavor.",
|
|
1267
|
+
description: "GET Workload Flavor.",
|
|
1268
|
+
pathParameters: [
|
|
1269
|
+
{
|
|
1270
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1271
|
+
in: "path",
|
|
1272
|
+
name: "name",
|
|
1273
|
+
required: true,
|
|
1274
|
+
schema: {
|
|
1275
|
+
type: "string",
|
|
1276
|
+
},
|
|
1277
|
+
},
|
|
1278
|
+
{
|
|
1279
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1280
|
+
in: "path",
|
|
1281
|
+
name: "namespace",
|
|
1282
|
+
required: true,
|
|
1283
|
+
schema: {
|
|
1284
|
+
type: "string",
|
|
1285
|
+
},
|
|
1286
|
+
},
|
|
1287
|
+
],
|
|
1288
|
+
queryParameters: [
|
|
1289
|
+
{
|
|
1290
|
+
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.",
|
|
1291
|
+
in: "query",
|
|
1292
|
+
name: "response_format",
|
|
1293
|
+
required: false,
|
|
1294
|
+
schema: {
|
|
1295
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1296
|
+
enum: [
|
|
1297
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1298
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1299
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1300
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1301
|
+
"GET_RSP_FORMAT_READ",
|
|
1302
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1303
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1304
|
+
],
|
|
1305
|
+
type: "string",
|
|
1306
|
+
},
|
|
1307
|
+
},
|
|
1308
|
+
],
|
|
1309
|
+
requestBodySchema: null,
|
|
1310
|
+
responseSchema: {
|
|
1311
|
+
$ref: "#/components/schemas/workload_flavorGetResponse",
|
|
1312
|
+
},
|
|
1313
|
+
requiredParams: ["name", "namespace"],
|
|
1314
|
+
operationId: "ves.io.schema.workload_flavor.API.Get",
|
|
1315
|
+
tags: ["Other"],
|
|
1316
|
+
sourceFile: "domains/applications.json",
|
|
1317
|
+
},
|
|
1318
|
+
{
|
|
1319
|
+
toolName: "f5xc-api-applications-workload-flavor-list",
|
|
1320
|
+
method: "GET",
|
|
1321
|
+
path: "/api/config/namespaces/{namespace}/workload_flavors",
|
|
1322
|
+
operation: "list",
|
|
1323
|
+
domain: "applications",
|
|
1324
|
+
resource: "workload-flavor",
|
|
1325
|
+
summary: "List Workload Flavor.",
|
|
1326
|
+
description: "List the set of workload_flavor in a namespace.",
|
|
1327
|
+
pathParameters: [
|
|
1328
|
+
{
|
|
1329
|
+
description: "Namespace\nNamespace to scope the listing of workload_flavor.",
|
|
1330
|
+
in: "path",
|
|
1331
|
+
name: "namespace",
|
|
1332
|
+
required: true,
|
|
1333
|
+
schema: {
|
|
1334
|
+
type: "string",
|
|
1335
|
+
},
|
|
1336
|
+
},
|
|
1337
|
+
],
|
|
1338
|
+
queryParameters: [
|
|
1339
|
+
{
|
|
1340
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1341
|
+
in: "query",
|
|
1342
|
+
name: "label_filter",
|
|
1343
|
+
required: false,
|
|
1344
|
+
schema: {
|
|
1345
|
+
type: "string",
|
|
1346
|
+
},
|
|
1347
|
+
},
|
|
1348
|
+
{
|
|
1349
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1350
|
+
in: "query",
|
|
1351
|
+
name: "report_fields",
|
|
1352
|
+
required: false,
|
|
1353
|
+
schema: {
|
|
1354
|
+
items: {
|
|
1355
|
+
type: "string",
|
|
1356
|
+
},
|
|
1357
|
+
type: "array",
|
|
1358
|
+
},
|
|
1359
|
+
},
|
|
1360
|
+
{
|
|
1361
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1362
|
+
in: "query",
|
|
1363
|
+
name: "report_status_fields",
|
|
1364
|
+
required: false,
|
|
1365
|
+
schema: {
|
|
1366
|
+
items: {
|
|
1367
|
+
type: "string",
|
|
1368
|
+
},
|
|
1369
|
+
type: "array",
|
|
1370
|
+
},
|
|
1371
|
+
},
|
|
1372
|
+
],
|
|
1373
|
+
requestBodySchema: null,
|
|
1374
|
+
responseSchema: {
|
|
1375
|
+
$ref: "#/components/schemas/workload_flavorListResponse",
|
|
1376
|
+
},
|
|
1377
|
+
requiredParams: ["namespace"],
|
|
1378
|
+
operationId: "ves.io.schema.workload_flavor.API.List",
|
|
1379
|
+
tags: ["Other"],
|
|
1380
|
+
sourceFile: "domains/applications.json",
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
toolName: "f5xc-api-applications-workload-flavor-update",
|
|
1384
|
+
method: "PUT",
|
|
1385
|
+
path: "/api/config/namespaces/{metadata.namespace}/workload_flavors/{metadata.name}",
|
|
1386
|
+
operation: "update",
|
|
1387
|
+
domain: "applications",
|
|
1388
|
+
resource: "workload-flavor",
|
|
1389
|
+
summary: "Replace Flavor.",
|
|
1390
|
+
description: "Replace a K8s workload_flavor.",
|
|
1391
|
+
pathParameters: [
|
|
1392
|
+
{
|
|
1393
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1394
|
+
in: "path",
|
|
1395
|
+
name: "metadata.name",
|
|
1396
|
+
required: true,
|
|
1397
|
+
schema: {
|
|
1398
|
+
type: "string",
|
|
1399
|
+
},
|
|
1400
|
+
},
|
|
1401
|
+
{
|
|
1402
|
+
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 ""',
|
|
1403
|
+
in: "path",
|
|
1404
|
+
name: "metadata.namespace",
|
|
1405
|
+
required: true,
|
|
1406
|
+
schema: {
|
|
1407
|
+
type: "string",
|
|
1408
|
+
},
|
|
1409
|
+
},
|
|
1410
|
+
],
|
|
1411
|
+
queryParameters: [],
|
|
1412
|
+
requestBodySchema: {
|
|
1413
|
+
$ref: "#/components/schemas/workload_flavorReplaceRequest",
|
|
1414
|
+
},
|
|
1415
|
+
responseSchema: {
|
|
1416
|
+
$ref: "#/components/schemas/workload_flavorReplaceResponse",
|
|
1417
|
+
},
|
|
1418
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1419
|
+
operationId: "ves.io.schema.workload_flavor.API.Replace",
|
|
1420
|
+
tags: ["Other"],
|
|
1421
|
+
sourceFile: "domains/applications.json",
|
|
1422
|
+
},
|
|
1423
|
+
{
|
|
1424
|
+
toolName: "f5xc-api-applications-workload-get",
|
|
1425
|
+
method: "GET",
|
|
1426
|
+
path: "/api/config/namespaces/{namespace}/workloads/{name}",
|
|
1427
|
+
operation: "get",
|
|
1428
|
+
domain: "applications",
|
|
1429
|
+
resource: "workload",
|
|
1430
|
+
summary: "GET Workload.",
|
|
1431
|
+
description: "Shape of Workload.",
|
|
1432
|
+
pathParameters: [
|
|
1433
|
+
{
|
|
1434
|
+
description: "Name\nThe name of the configuration object to be fetched.",
|
|
1435
|
+
in: "path",
|
|
1436
|
+
name: "name",
|
|
1437
|
+
required: true,
|
|
1438
|
+
schema: {
|
|
1439
|
+
type: "string",
|
|
1440
|
+
},
|
|
1441
|
+
},
|
|
1442
|
+
{
|
|
1443
|
+
description: "Namespace\nThe namespace in which the configuration object is present.",
|
|
1444
|
+
in: "path",
|
|
1445
|
+
name: "namespace",
|
|
1446
|
+
required: true,
|
|
1447
|
+
schema: {
|
|
1448
|
+
type: "string",
|
|
1449
|
+
},
|
|
1450
|
+
},
|
|
1451
|
+
],
|
|
1452
|
+
queryParameters: [
|
|
1453
|
+
{
|
|
1454
|
+
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.",
|
|
1455
|
+
in: "query",
|
|
1456
|
+
name: "response_format",
|
|
1457
|
+
required: false,
|
|
1458
|
+
schema: {
|
|
1459
|
+
default: "GET_RSP_FORMAT_DEFAULT",
|
|
1460
|
+
enum: [
|
|
1461
|
+
"GET_RSP_FORMAT_DEFAULT",
|
|
1462
|
+
"GET_RSP_FORMAT_FOR_CREATE",
|
|
1463
|
+
"GET_RSP_FORMAT_FOR_REPLACE",
|
|
1464
|
+
"GET_RSP_FORMAT_STATUS",
|
|
1465
|
+
"GET_RSP_FORMAT_READ",
|
|
1466
|
+
"GET_RSP_FORMAT_REFERRING_OBJECTS",
|
|
1467
|
+
"GET_RSP_FORMAT_BROKEN_REFERENCES",
|
|
1468
|
+
],
|
|
1469
|
+
type: "string",
|
|
1470
|
+
},
|
|
1471
|
+
},
|
|
1472
|
+
],
|
|
1473
|
+
requestBodySchema: null,
|
|
1474
|
+
responseSchema: {
|
|
1475
|
+
$ref: "#/components/schemas/workloadGetResponse",
|
|
1476
|
+
},
|
|
1477
|
+
requiredParams: ["name", "namespace"],
|
|
1478
|
+
operationId: "ves.io.schema.views.workload.API.Get",
|
|
1479
|
+
tags: ["Other"],
|
|
1480
|
+
sourceFile: "domains/applications.json",
|
|
1481
|
+
},
|
|
1482
|
+
{
|
|
1483
|
+
toolName: "f5xc-api-applications-workload-list",
|
|
1484
|
+
method: "GET",
|
|
1485
|
+
path: "/api/config/namespaces/{namespace}/workloads",
|
|
1486
|
+
operation: "list",
|
|
1487
|
+
domain: "applications",
|
|
1488
|
+
resource: "workload",
|
|
1489
|
+
summary: "List Workload.",
|
|
1490
|
+
description: "List the set of workload in a namespace.",
|
|
1491
|
+
pathParameters: [
|
|
1492
|
+
{
|
|
1493
|
+
description: "Namespace\nNamespace to scope the listing of workload.",
|
|
1494
|
+
in: "path",
|
|
1495
|
+
name: "namespace",
|
|
1496
|
+
required: true,
|
|
1497
|
+
schema: {
|
|
1498
|
+
type: "string",
|
|
1499
|
+
},
|
|
1500
|
+
},
|
|
1501
|
+
],
|
|
1502
|
+
queryParameters: [
|
|
1503
|
+
{
|
|
1504
|
+
description: "A LabelSelectorType expression that every item in list response will satisfy.",
|
|
1505
|
+
in: "query",
|
|
1506
|
+
name: "label_filter",
|
|
1507
|
+
required: false,
|
|
1508
|
+
schema: {
|
|
1509
|
+
type: "string",
|
|
1510
|
+
},
|
|
1511
|
+
},
|
|
1512
|
+
{
|
|
1513
|
+
description: 'X-example: ""\nExtra fields to return along with summary fields.',
|
|
1514
|
+
in: "query",
|
|
1515
|
+
name: "report_fields",
|
|
1516
|
+
required: false,
|
|
1517
|
+
schema: {
|
|
1518
|
+
items: {
|
|
1519
|
+
type: "string",
|
|
1520
|
+
},
|
|
1521
|
+
type: "array",
|
|
1522
|
+
},
|
|
1523
|
+
},
|
|
1524
|
+
{
|
|
1525
|
+
description: 'X-example: ""\nExtra status fields to return along with summary fields.',
|
|
1526
|
+
in: "query",
|
|
1527
|
+
name: "report_status_fields",
|
|
1528
|
+
required: false,
|
|
1529
|
+
schema: {
|
|
1530
|
+
items: {
|
|
1531
|
+
type: "string",
|
|
1532
|
+
},
|
|
1533
|
+
type: "array",
|
|
1534
|
+
},
|
|
1535
|
+
},
|
|
1536
|
+
],
|
|
1537
|
+
requestBodySchema: null,
|
|
1538
|
+
responseSchema: {
|
|
1539
|
+
$ref: "#/components/schemas/workloadListResponse",
|
|
1540
|
+
},
|
|
1541
|
+
requiredParams: ["namespace"],
|
|
1542
|
+
operationId: "ves.io.schema.views.workload.API.List",
|
|
1543
|
+
tags: ["Other"],
|
|
1544
|
+
sourceFile: "domains/applications.json",
|
|
1545
|
+
},
|
|
1546
|
+
{
|
|
1547
|
+
toolName: "f5xc-api-applications-workload-update",
|
|
1548
|
+
method: "PUT",
|
|
1549
|
+
path: "/api/config/namespaces/{metadata.namespace}/workloads/{metadata.name}",
|
|
1550
|
+
operation: "update",
|
|
1551
|
+
domain: "applications",
|
|
1552
|
+
resource: "workload",
|
|
1553
|
+
summary: "Replace Workload.",
|
|
1554
|
+
description: "Shape of Workload.",
|
|
1555
|
+
pathParameters: [
|
|
1556
|
+
{
|
|
1557
|
+
description: "Name\nThe configuration object to be replaced will be looked up by name.",
|
|
1558
|
+
in: "path",
|
|
1559
|
+
name: "metadata.name",
|
|
1560
|
+
required: true,
|
|
1561
|
+
schema: {
|
|
1562
|
+
type: "string",
|
|
1563
|
+
},
|
|
1564
|
+
},
|
|
1565
|
+
{
|
|
1566
|
+
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 ""',
|
|
1567
|
+
in: "path",
|
|
1568
|
+
name: "metadata.namespace",
|
|
1569
|
+
required: true,
|
|
1570
|
+
schema: {
|
|
1571
|
+
type: "string",
|
|
1572
|
+
},
|
|
1573
|
+
},
|
|
1574
|
+
],
|
|
1575
|
+
queryParameters: [],
|
|
1576
|
+
requestBodySchema: {
|
|
1577
|
+
$ref: "#/components/schemas/workloadReplaceRequest",
|
|
1578
|
+
},
|
|
1579
|
+
responseSchema: {
|
|
1580
|
+
$ref: "#/components/schemas/workloadReplaceResponse",
|
|
1581
|
+
},
|
|
1582
|
+
requiredParams: ["body", "metadata.name", "metadata.namespace"],
|
|
1583
|
+
operationId: "ves.io.schema.views.workload.API.Replace",
|
|
1584
|
+
tags: ["Other"],
|
|
1585
|
+
sourceFile: "domains/applications.json",
|
|
1586
|
+
},
|
|
1587
|
+
];
|
|
1588
|
+
export default applicationsTools;
|
|
1589
|
+
//# sourceMappingURL=index.js.map
|