@robinmordasiewicz/f5xc-api-mcp 3.0.0

package/dist/tools/generated/nginx/index.js

@@ -0,0 +1,680 @@
+/**
+ * Generated tool definitions for nginx domain
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
+ */
+export const nginxTools = [
+    {
+        toolName: "f5xc-api-nginx-nginx-csg-get",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_csgs/{name}",
+        operation: "get",
+        domain: "nginx",
+        resource: "nginx-csg",
+        summary: "GET Request.",
+        description: "GET NGINX csg configuration.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                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.",
+                in: "query",
+                name: "response_format",
+                required: false,
+                schema: {
+                    default: "GET_RSP_FORMAT_DEFAULT",
+                    enum: [
+                        "GET_RSP_FORMAT_DEFAULT",
+                        "GET_RSP_FORMAT_READ",
+                        "GET_RSP_FORMAT_REFERRING_OBJECTS",
+                        "GET_RSP_FORMAT_BROKEN_REFERENCES",
+                    ],
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_csgGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_csg.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-csg-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_csgs",
+        operation: "list",
+        domain: "nginx",
+        resource: "nginx-csg",
+        summary: "List NGINX One CSG Object configuration.",
+        description: "List the set of nginx_csg in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of nginx_csg.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra status fields to return along with summary fields.',
+                in: "query",
+                name: "report_status_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_csgListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_csg.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-dataplane-server-create",
+        method: "POST",
+        path: "/api/config/namespaces/{namespace}/nginx_dataplane_servers",
+        operation: "create",
+        domain: "nginx",
+        resource: "nginx-dataplane-server",
+        summary: "GET NGINX One Dataplane Servers.",
+        description: "GET NGINX One Servers associated to an NGINX dataplane.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace of the NGINX One Instance.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/nginx_serverGetDataplaneServersRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_serverGetDataplaneServersResponse",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_server.CustomAPI.GetDataplaneServers",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-instance-get",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_instances/{name}",
+        operation: "get",
+        domain: "nginx",
+        resource: "nginx-instance",
+        summary: "GET Request.",
+        description: "GET NGINX instance configuration.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                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.",
+                in: "query",
+                name: "response_format",
+                required: false,
+                schema: {
+                    default: "GET_RSP_FORMAT_DEFAULT",
+                    enum: [
+                        "GET_RSP_FORMAT_DEFAULT",
+                        "GET_RSP_FORMAT_READ",
+                        "GET_RSP_FORMAT_REFERRING_OBJECTS",
+                        "GET_RSP_FORMAT_BROKEN_REFERENCES",
+                    ],
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_instanceGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_instance.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-instance-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_instances",
+        operation: "list",
+        domain: "nginx",
+        resource: "nginx-instance",
+        summary: "List NGINX One Instance Object configuration.",
+        description: "List the set of nginx_instance in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of nginx_instance.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra status fields to return along with summary fields.',
+                in: "query",
+                name: "report_status_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_instanceListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_instance.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-server-get",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_servers/{name}",
+        operation: "get",
+        domain: "nginx",
+        resource: "nginx-server",
+        summary: "GET Request.",
+        description: "GET NGINX server block configuration.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "The format in which the configuration object is to be fetched. This could be for example\n - in GetSpec form for the contents of object\n - in CreateRequest form to create a new similar object\n - to ReplaceRequest form to replace changeable values\n\nDefault format of returned resource\nResponse should be in StatusObject(s) format\nResponse should be in format of GetSpecType\nResponse should have other objects referring to this object\nResponse should have deleted and disabled objects referrred by this object.",
+                in: "query",
+                name: "response_format",
+                required: false,
+                schema: {
+                    default: "GET_RSP_FORMAT_DEFAULT",
+                    enum: [
+                        "GET_RSP_FORMAT_DEFAULT",
+                        "GET_RSP_FORMAT_STATUS",
+                        "GET_RSP_FORMAT_READ",
+                        "GET_RSP_FORMAT_REFERRING_OBJECTS",
+                        "GET_RSP_FORMAT_BROKEN_REFERENCES",
+                    ],
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_serverGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_server.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-server-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_servers",
+        operation: "list",
+        domain: "nginx",
+        resource: "nginx-server",
+        summary: "List NGINX One Server APIs.",
+        description: "List the set of nginx_server in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of nginx_server.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra status fields to return along with summary fields.',
+                in: "query",
+                name: "report_status_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_serverListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_server.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-service-discovery-create",
+        method: "POST",
+        path: "/api/config/namespaces/{metadata.namespace}/nginx_service_discoverys",
+        operation: "create",
+        domain: "nginx",
+        resource: "nginx-service-discovery",
+        summary: "Create NGINX Service Discovery.",
+        description: "API to create NGINX Service Discovery object for a site or virtual site in system namespace.",
+        pathParameters: [
+            {
+                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 ""',
+                in: "path",
+                name: "metadata.namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryCreateRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryCreateResponse",
+        },
+        requiredParams: ["body", "metadata.namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_service_discovery.API.Create",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-service-discovery-delete",
+        method: "DELETE",
+        path: "/api/config/namespaces/{namespace}/nginx_service_discoverys/{name}",
+        operation: "delete",
+        domain: "nginx",
+        resource: "nginx-service-discovery",
+        summary: "DELETE NGINX Service Discovery.",
+        description: "DELETE the specified nginx_service_discovery.",
+        pathParameters: [
+            {
+                description: "Name\nName of the configuration object.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nNamespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryDeleteRequest",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_service_discovery.API.Delete",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-service-discovery-get",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_service_discoverys/{name}",
+        operation: "get",
+        domain: "nginx",
+        resource: "nginx-service-discovery",
+        summary: "GET NGINX Service Discovery.",
+        description: "API to GET NGINX Service Discovery object for a site or virtual site in system namespace.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                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.",
+                in: "query",
+                name: "response_format",
+                required: false,
+                schema: {
+                    default: "GET_RSP_FORMAT_DEFAULT",
+                    enum: [
+                        "GET_RSP_FORMAT_DEFAULT",
+                        "GET_RSP_FORMAT_FOR_CREATE",
+                        "GET_RSP_FORMAT_FOR_REPLACE",
+                        "GET_RSP_FORMAT_STATUS",
+                        "GET_RSP_FORMAT_READ",
+                        "GET_RSP_FORMAT_REFERRING_OBJECTS",
+                        "GET_RSP_FORMAT_BROKEN_REFERENCES",
+                    ],
+                    type: "string",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_service_discovery.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-service-discovery-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/nginx_service_discoverys",
+        operation: "list",
+        domain: "nginx",
+        resource: "nginx-service-discovery",
+        summary: "List NGINX Service Discovery.",
+        description: "List the set of nginx_service_discovery in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of nginx_service_discovery.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+            {
+                description: 'X-example: ""\nExtra status fields to return along with summary fields.',
+                in: "query",
+                name: "report_status_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_service_discovery.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-nginx-service-discovery-update",
+        method: "PUT",
+        path: "/api/config/namespaces/{metadata.namespace}/nginx_service_discoverys/{metadata.name}",
+        operation: "update",
+        domain: "nginx",
+        resource: "nginx-service-discovery",
+        summary: "Replace NGINX Service Discovery.",
+        description: "API to replace NGINX Service Discovery object for a site or virtual site in system namespace.",
+        pathParameters: [
+            {
+                description: "Name\nThe configuration object to be replaced will be looked up by name.",
+                in: "path",
+                name: "metadata.name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+            {
+                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 ""',
+                in: "path",
+                name: "metadata.namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryReplaceRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/nginx_service_discoveryReplaceResponse",
+        },
+        requiredParams: ["body", "metadata.name", "metadata.namespace"],
+        operationId: "ves.io.schema.nginx.one.nginx_service_discovery.API.Replace",
+        tags: ["Other"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-subscribe-create",
+        method: "POST",
+        path: "/api/nginx/one/namespaces/system/n1/subscribe",
+        operation: "create",
+        domain: "nginx",
+        resource: "subscribe",
+        summary: "Subscribe to NGINX One.",
+        description: "Subscribe to NGINX One.",
+        pathParameters: [],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/subscriptionSubscribeRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/subscriptionSubscribeResponse",
+        },
+        requiredParams: ["body"],
+        operationId: "ves.io.schema.nginx.one.subscription.CustomAPI.Subscribe",
+        tags: ["NGINX"],
+        sourceFile: "domains/nginx.json",
+    },
+    {
+        toolName: "f5xc-api-nginx-unsubscribe-create",
+        method: "POST",
+        path: "/api/nginx/one/namespaces/system/n1/unsubscribe",
+        operation: "create",
+        domain: "nginx",
+        resource: "unsubscribe",
+        summary: "Unsubscribe to NGINX One.",
+        description: "Unsubscribe to NGINX One.",
+        pathParameters: [],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/subscriptionUnsubscribeRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/subscriptionUnsubscribeResponse",
+        },
+        requiredParams: ["body"],
+        operationId: "ves.io.schema.nginx.one.subscription.CustomAPI.Unsubscribe",
+        tags: ["NGINX"],
+        sourceFile: "domains/nginx.json",
+    },
+];
+export default nginxTools;
+//# sourceMappingURL=index.js.map