@robinmordasiewicz/f5xc-api-mcp 3.3.1 → 3.4.0

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

@@ -0,0 +1,1572 @@
+/**
+ * Generated tool definitions for users domain
+ * DO NOT EDIT - This file is auto-generated by scripts/generate.ts
+ */
+export const usersTools = [
+    {
+        toolName: "f5xc-api-users-create-create",
+        method: "POST",
+        path: "/api/config/namespaces/{namespace}/known_label/create",
+        operation: "create",
+        domain: "users",
+        resource: "create",
+        summary: "Create",
+        description: "Create creates a new label in shared namespace. Any other namespace requested will return error.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace in which to create the label.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/known_labelCreateRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/known_labelCreateResponse",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.known_label.CustomAPI.Create",
+        tags: ["Configuration"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["create"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl config create create {name} --namespace {namespace}",
+                description: "Create create",
+                use_case: "basic_create",
+            },
+            {
+                command: "f5xcctl config create create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            namespace: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Create resource created", "Resource assigned unique identifier"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl config create create {name} --namespace {namespace}",
+                    description: "Create create",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl config create create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Create new create",
+            required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
+            side_effects: {
+                creates: ["create"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-users-delete-create",
+        method: "POST",
+        path: "/api/config/namespaces/{namespace}/known_label/delete",
+        operation: "create",
+        domain: "users",
+        resource: "delete",
+        summary: "DELETE",
+        description: "DELETE will DELETE a given label label key = label value from current tenants shared namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace of the label to be deleted.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/known_labelDeleteRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/known_labelDeleteResponse",
+        },
+        requiredParams: ["body", "namespace"],
+        operationId: "ves.io.schema.known_label.CustomAPI.Delete",
+        tags: ["Configuration"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["delete"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl config delete create {name} --namespace {namespace}",
+                description: "Create delete",
+                use_case: "basic_create",
+            },
+            {
+                command: "f5xcctl config delete create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            namespace: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Delete resource created", "Resource assigned unique identifier"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl config delete create {name} --namespace {namespace}",
+                    description: "Create delete",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl config delete create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Create new delete",
+            required_fields: ["metadata.name", "metadata.namespace", "path.namespace"],
+            side_effects: {
+                creates: ["delete"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-users-get-cloud-init-config-list",
+        method: "GET",
+        path: "/api/register/namespaces/system/get-cloud-init-config",
+        operation: "list",
+        domain: "users",
+        resource: "get-cloud-init-config",
+        summary: "GET Cloud Init Config.",
+        description: "Returns cloud-init counfig for kvm provider with JWT token.",
+        pathParameters: [],
+        queryParameters: [
+            {
+                description: "Provider for that cloud-init config.",
+                in: "query",
+                name: "provider",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Provider",
+                "x-ves-example": "Kvm",
+            },
+            {
+                description: "Site name for this cloud-init config.",
+                in: "query",
+                name: "site_name",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Site Name",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/tokenGetCloudInitConfigResp",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.token.CustomAPI.GetCloudInitConfig",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: [],
+        cliExamples: [
+            {
+                command: "f5xcctl register get-cloud-init-config list --namespace {namespace}",
+                description: "List all get-cloud-init-configs",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            provider: "Kvm",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl register get-cloud-init-config list --namespace {namespace}",
+                    description: "List all get-cloud-init-configs",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all get-cloud-init-configs",
+            required_fields: [],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-users-implicit-label-list",
+        method: "GET",
+        path: "/api/config/namespaces/system/implicit_labels",
+        operation: "list",
+        domain: "users",
+        resource: "implicit-label",
+        summary: "GET Implicit Labels.",
+        description: "GET is generic label query. Two types of queries are supported\n* Return label with exact matching entry label key = label value.\n* Return list of labels that have prefix of label key = label value.\nReturns list of labels. Query will look into current tenants shared namespace and VES-I/O shared.",
+        pathParameters: [],
+        queryParameters: [
+            {
+                description: "Key string in Query parameters.",
+                in: "query",
+                name: "key",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Key",
+                "x-ves-example": "Value",
+            },
+            {
+                description: 'Key classes\n\nIncludes label keys with generic names such as "example-key", "foobar-key" etc.\nKeys that are obtained using GET on /API/config/configconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfigconfignamespaces/shared/known_label_keys\nIncludes F5 Distributed Cloud-defined known label keys such as "F5 XC/app_type", "F5 XC/app" and "F5 XC/siteType" as well as tenant-defined known keys such as\n"example-key", "acme-key-foo" and "acme-key-bar". Note that tenant-defined known keys don\'t have any standard name format - they are known keys because they\nhave been explicitly created as known keys by the tenant and are stored in the configuration as known_label_keys.\nIncludes implicit geoip label keys "geoip.F5 XC/city", "geoip.F5 XC/region" and "geoip.F5 XC/country"\nIncludes implicit label keys associated with packets/requests by the infrastructure e.g. "implicit.F5 XC/namespace"\nInclude IP reputation label keys "ipreputation.F5 XC/threattype", "ipreputation.F5 XC/threatlevel"\nInclude URL reputation label keys "urlreputation.F5 XC/category", "urlreputation.F5 XC/reputationlevel"\nIncludes implicit geoip label keys "geoip.F5 XC/continent"\nIncludes implicit geoip label keys "geoip.F5 XC/region", "geoip.F5 XC/country" and "geoip.F5 XC/continent"\nImplicit AWS resource labels (dynamically queried). This may be VPC level tags and/or subnet level tags.',
+                in: "query",
+                name: "key_classes",
+                required: false,
+                schema: {
+                    items: {
+                        enum: [
+                            "KEY_CLASS_GENERIC",
+                            "KEY_CLASS_KNOWN",
+                            "KEY_CLASS_GEOIP",
+                            "KEY_CLASS_IMPLICIT",
+                            "KEY_CLASS_IP_REPUTATION",
+                            "KEY_CLASS_URL_REPUTATION",
+                            "KEY_CLASS_GEOIP_EXTENDED",
+                            "KEY_CLASS_DNS_GEOIP",
+                            "KEY_CLASS_AWS",
+                        ],
+                        type: "string",
+                    },
+                    type: "array",
+                },
+                "x-displayname": "Key Class AWS.",
+                "x-ves-example": "Key classes.",
+            },
+            {
+                description: "Type of Query\n\nGET all available implicit labels\nGET exact match of label.key = label.value Or label.key(label.value)\nGET prefix match of label.key = label.value\nGET list of all keys\nGET list of all labels that exactly match the given key and substring match either 'value' or description provided in 'value' field\nGET list of all keys matching a substring.",
+                in: "query",
+                name: "query",
+                required: false,
+                schema: {
+                    default: "QUERY_ALL_LABELS",
+                    enum: [
+                        "QUERY_ALL_LABELS",
+                        "QUERY_EXACT_LABEL",
+                        "QUERY_VALUE_PREFIX_LABELS",
+                        "QUERY_KEYS_ONLY",
+                        "QUERY_VALUE_OR_DESCRIPTION_SUBSTRING",
+                        "QUERY_KEY_SUBSTRING",
+                    ],
+                    type: "string",
+                },
+                "x-displayname": "Key Substring.",
+            },
+            {
+                description: "Value string in Query parameters.",
+                in: "query",
+                name: "value",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Value",
+                "x-ves-example": "Value",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/implicit_labelGetResponse",
+        },
+        requiredParams: [],
+        operationId: "ves.io.schema.implicit_label.CustomAPI.Get",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: [],
+        cliExamples: [
+            {
+                command: "f5xcctl config implicit-label list --namespace {namespace}",
+                description: "List all implicit-labels",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            key: "Value",
+            key_classes: "Key classes.",
+            value: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl config implicit-label list --namespace {namespace}",
+                    description: "List all implicit-labels",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all implicit-labels",
+            required_fields: [],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-users-known-label-key-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/known_label_keys",
+        operation: "list",
+        domain: "users",
+        resource: "known-label-key",
+        summary: "GET",
+        description: "GET is generic label key query. Two types of queries are supported\nReturn label with exact matching entry label key.\nReturn list of labels that have prefix of label key .\nReturns list of label keys. Query will look into current tenants shared namespace and VES-I/O shared.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace in which to retrieve the label key.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [
+            {
+                description: "Key to retrieve.",
+                in: "query",
+                name: "key",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Key",
+                "x-ves-example": "Value",
+            },
+            {
+                description: "Query Type\n\nGeneric GET of all available labels for a given tenant\nGET exact match of label.key = label.value Or label.key(label.value)\nGET prefix match of label.key.",
+                in: "query",
+                name: "query",
+                required: false,
+                schema: {
+                    default: "QUERY_ALL_LABEL_KEYS",
+                    enum: ["QUERY_ALL_LABEL_KEYS", "QUERY_EXACT_LABEL_KEY", "QUERY_PREFIX_LABEL_KEYS"],
+                    type: "string",
+                },
+                "x-displayname": "Label Key Prefix.",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/known_label_keyGetResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.known_label_key.CustomAPI.Get",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl config known-label-key list --namespace {namespace}",
+                description: "List all known-label-keys",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            key: "Value",
+            namespace: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl config known-label-key list --namespace {namespace}",
+                    description: "List all known-label-keys",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all known-label-keys",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-users-known-label-list",
+        method: "GET",
+        path: "/api/config/namespaces/{namespace}/known_labels",
+        operation: "list",
+        domain: "users",
+        resource: "known-label",
+        summary: "GET",
+        description: "GET is generic label query. Two types of queries are supported\nReturn label with exact matching entry label key = label value.\nReturn list of labels that have prefix of label key = label value.\nReturns list of labels. Query will look into current tenants shared namespace and VES-I/O shared.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace for the label to be retrieved.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [
+            {
+                description: "Key of the label to be retrieved.",
+                in: "query",
+                name: "key",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Key",
+                "x-ves-example": "F5 XC/region.",
+            },
+            {
+                description: "Query type\n\nGeneric GET of all available labels for a given tenant\nGET exact match of label.key = label.value Or label.key(label.value)\nGET prefix match of label.key = label.value\nGET prefix match of label.key.",
+                in: "query",
+                name: "query",
+                required: false,
+                schema: {
+                    default: "QUERY_ALL_LABELS",
+                    enum: [
+                        "QUERY_ALL_LABELS",
+                        "QUERY_EXACT_LABEL",
+                        "QUERY_VALUE_PREFIX_LABELS",
+                        "QUERY_KEY_PREFIX_LABELS",
+                    ],
+                    type: "string",
+                },
+                "x-displayname": "Label Key Prefix.",
+            },
+            {
+                description: "Value of the label to be retrieved.",
+                in: "query",
+                name: "value",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Value",
+                "x-ves-example": "VES-I/O-par.",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/known_labelGetResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.known_label.CustomAPI.Get",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl config known-label list --namespace {namespace}",
+                description: "List all known-labels",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            key: "F5 XC/region.",
+            namespace: "Value",
+            value: "VES-I/O-par.",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl config known-label list --namespace {namespace}",
+                    description: "List all known-labels",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all known-labels",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-users-state-create",
+        method: "POST",
+        path: "/api/register/namespaces/{namespace}/tokens/{name}/state",
+        operation: "create",
+        domain: "users",
+        resource: "state",
+        summary: "Set Token State.",
+        description: "TokenState changes token status, it can be used to disable token.",
+        pathParameters: [
+            {
+                description: "Token name\nToken object name to change, it's usually same as metadata.uid.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Value",
+            },
+            {
+                description: "Token namespace\nNamespace where token is residing.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Value",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/tokenStateReq",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/tokenObjectChangeResp",
+        },
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.token.CustomAPI.TokenState",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["state"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl register state create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+            {
+                command: "f5xcctl register state create {name} --namespace {namespace}",
+                description: "Create state",
+                use_case: "basic_create",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            name: "Value",
+            namespace: "Value",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["State resource created", "Resource assigned unique identifier"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl register state create {name} --namespace {namespace}",
+                    description: "Create state",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl register state create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Create new state",
+            required_fields: ["metadata.name", "metadata.namespace", "path.name", "path.namespace"],
+            side_effects: {
+                creates: ["state"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-users-token-create",
+        method: "POST",
+        path: "/api/register/namespaces/{metadata.namespace}/tokens",
+        operation: "create",
+        domain: "users",
+        resource: "token",
+        summary: "Create Token.",
+        description: "Creates new token. Token object is used to manage site admission. User must generate token before provisioning and pass this\ntoken to site during it's registration.",
+        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",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Staging",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/tokenCreateRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/tokenCreateResponse",
+        },
+        requiredParams: ["body", "metadata.namespace"],
+        operationId: "ves.io.schema.token.API.Create",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            creates: ["token"],
+        },
+        requiredFields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl register token create -f {file}.yaml",
+                description: "Create from YAML file",
+                use_case: "file_based",
+            },
+            {
+                command: "f5xcctl register token create {name} --namespace {namespace}",
+                description: "Create token",
+                use_case: "basic_create",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            "metadata.namespace": "Staging",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Token resource created", "Resource assigned unique identifier"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl register token create {name} --namespace {namespace}",
+                    description: "Create token",
+                    use_case: "basic_create",
+                },
+                {
+                    command: "f5xcctl register token create -f {file}.yaml",
+                    description: "Create from YAML file",
+                    use_case: "file_based",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Create new token",
+            required_fields: ["metadata.name", "metadata.namespace", "path.metadata.namespace"],
+            side_effects: {
+                creates: ["token"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-users-token-delete",
+        method: "DELETE",
+        path: "/api/register/namespaces/{namespace}/tokens/{name}",
+        operation: "delete",
+        domain: "users",
+        resource: "token",
+        summary: "DELETE Token.",
+        description: "DELETE the specified token.",
+        pathParameters: [
+            {
+                description: "Name\nName of the configuration object.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Name",
+            },
+            {
+                description: "Namespace\nNamespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Ns1",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/tokenDeleteRequest",
+        },
+        responseSchema: {},
+        requiredParams: ["body", "name", "namespace"],
+        operationId: "ves.io.schema.token.API.Delete",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "high",
+        sideEffects: {
+            deletes: ["token", "contained_resources"],
+        },
+        requiredFields: ["path.name", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl register token delete {name} --namespace {namespace}",
+                description: "Delete token",
+                use_case: "delete",
+            },
+        ],
+        confirmationRequired: true,
+        parameterExamples: {
+            name: "Name",
+            namespace: "Ns1",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Resource removed from system", "Associated resources may be affected"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: true,
+            danger_level: "high",
+            examples: [
+                {
+                    command: "f5xcctl register token delete {name} --namespace {namespace}",
+                    description: "Delete token",
+                    use_case: "delete",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "high",
+                resource_usage: "moderate",
+            },
+            purpose: "Delete token",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {
+                deletes: ["token", "contained_resources"],
+            },
+        },
+    },
+    {
+        toolName: "f5xc-api-users-token-get",
+        method: "GET",
+        path: "/api/register/namespaces/{namespace}/tokens/{name}",
+        operation: "get",
+        domain: "users",
+        resource: "token",
+        summary: "GET Token",
+        description: "GET token. Token object is used to manage site admission. User must generate token before provisioning and pass this\ntoken to site during it's registration.",
+        pathParameters: [
+            {
+                description: "Name\nThe name of the configuration object to be fetched.",
+                in: "path",
+                name: "name",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Name",
+            },
+            {
+                description: "Namespace\nThe namespace in which the configuration object is present.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Ns1",
+            },
+        ],
+        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",
+                },
+                "x-displayname": "Broken Referred Objects.",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/tokenGetResponse",
+        },
+        requiredParams: ["name", "namespace"],
+        operationId: "ves.io.schema.token.API.Get",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.name", "path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl register token get {name} --namespace {namespace}",
+                description: "Get specific token",
+                use_case: "get_specific",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            name: "Name",
+            namespace: "Ns1",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl register token get {name} --namespace {namespace}",
+                    description: "Get specific token",
+                    use_case: "get_specific",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Retrieve specific token",
+            required_fields: ["path.name", "path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-users-token-list",
+        method: "GET",
+        path: "/api/register/namespaces/{namespace}/tokens",
+        operation: "list",
+        domain: "users",
+        resource: "token",
+        summary: "List Token.",
+        description: "List the set of token in a namespace.",
+        pathParameters: [
+            {
+                description: "Namespace\nNamespace to scope the listing of token.",
+                in: "path",
+                name: "namespace",
+                required: true,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Ns1",
+            },
+        ],
+        queryParameters: [
+            {
+                description: "A LabelSelectorType expression that every item in list response will satisfy.",
+                in: "query",
+                name: "label_filter",
+                required: false,
+                schema: {
+                    type: "string",
+                },
+                "x-displayname": "Label Filter.",
+                "x-ves-example": "Env in (staging, testing), tier in (web, db)",
+            },
+            {
+                description: 'X-example: ""\nExtra fields to return along with summary fields.',
+                in: "query",
+                name: "report_fields",
+                required: false,
+                schema: {
+                    items: {
+                        type: "string",
+                    },
+                    type: "array",
+                },
+                "x-displayname": "Report Fields.",
+            },
+            {
+                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",
+                },
+                "x-displayname": "Report Status Fields.",
+            },
+        ],
+        requestBodySchema: null,
+        responseSchema: {
+            $ref: "#/components/schemas/tokenListResponse",
+        },
+        requiredParams: ["namespace"],
+        operationId: "ves.io.schema.token.API.List",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "low",
+        sideEffects: null,
+        requiredFields: ["path.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl register token list --namespace {namespace}",
+                description: "List all tokens",
+                use_case: "list_all",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            label_filter: "Env in (staging, testing), tier in (web, db)",
+            namespace: "Ns1",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: [],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "low",
+            examples: [
+                {
+                    command: "f5xcctl register token list --namespace {namespace}",
+                    description: "List all tokens",
+                    use_case: "list_all",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "moderate",
+                resource_usage: "moderate",
+            },
+            purpose: "List all tokens",
+            required_fields: ["path.namespace"],
+            side_effects: {},
+        },
+    },
+    {
+        toolName: "f5xc-api-users-token-update",
+        method: "PUT",
+        path: "/api/register/namespaces/{metadata.namespace}/tokens/{metadata.name}",
+        operation: "update",
+        domain: "users",
+        resource: "token",
+        summary: "Replace Token.",
+        description: "Replaces token. Token object is used to manage site admission. User must generate token before provisioning and pass this\ntoken to site during it's registration.",
+        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",
+                },
+                "x-displayname": "Name",
+                "x-ves-example": "Example-corp-web.",
+            },
+            {
+                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",
+                },
+                "x-displayname": "Namespace",
+                "x-ves-example": "Staging",
+            },
+        ],
+        queryParameters: [],
+        requestBodySchema: {
+            $ref: "#/components/schemas/tokenReplaceRequest",
+        },
+        responseSchema: {
+            $ref: "#/components/schemas/tokenReplaceResponse",
+        },
+        requiredParams: ["body", "metadata.name", "metadata.namespace"],
+        operationId: "ves.io.schema.token.API.Replace",
+        tags: ["Other"],
+        sourceFile: "domains/users.json",
+        displayName: null,
+        dangerLevel: "medium",
+        sideEffects: {
+            modifies: ["token"],
+        },
+        requiredFields: ["path.metadata.name", "path.metadata.namespace"],
+        cliExamples: [
+            {
+                command: "f5xcctl register token update {name} --namespace {namespace} -f {file}.yaml",
+                description: "Update token",
+                use_case: "update",
+            },
+        ],
+        confirmationRequired: false,
+        parameterExamples: {
+            "metadata.name": "Example-corp-web.",
+            "metadata.namespace": "Staging",
+        },
+        validationRules: {},
+        operationMetadata: {
+            common_errors: [
+                {
+                    code: 401,
+                    message: "Authentication required",
+                    solution: "Provide valid API credentials",
+                },
+                {
+                    code: 403,
+                    message: "Permission denied",
+                    solution: "Check access permissions for this operation",
+                },
+                {
+                    code: 404,
+                    message: "Resource not found",
+                    solution: "Verify resource name, namespace, and path",
+                },
+                {
+                    code: 409,
+                    message: "Resource already exists",
+                    solution: "Use different name or update existing resource",
+                },
+                {
+                    code: 429,
+                    message: "Rate limit exceeded",
+                    solution: "Wait before retrying the operation",
+                },
+                {
+                    code: 500,
+                    message: "Server error",
+                    solution: "Retry operation or contact support",
+                },
+            ],
+            conditions: {
+                postconditions: ["Resource updated with new values"],
+                prerequisites: ["Active namespace"],
+            },
+            confirmation_required: false,
+            danger_level: "medium",
+            examples: [
+                {
+                    command: "f5xcctl register token update {name} --namespace {namespace} -f {file}.yaml",
+                    description: "Update token",
+                    use_case: "update",
+                },
+            ],
+            field_docs: {},
+            optional_fields: [],
+            performance_impact: {
+                latency: "low",
+                resource_usage: "low",
+            },
+            purpose: "Replace existing token",
+            required_fields: ["path.metadata.name", "path.metadata.namespace"],
+            side_effects: {
+                modifies: ["token"],
+            },
+        },
+    },
+];
+export default usersTools;
+//# sourceMappingURL=index.js.map