alibaba--nacos/test/openapi-test/CONSOLE_API_TEST_SCENARIOS.md

Console API IT Scenario Index

This document records which console API operations are covered by the standalone-server IT classes under src/test/java/com/alibaba/nacos/test/consoleapi.

Source API surface: console swagger at https://nacos.io/swagger/console/zh/api.json. The branch-level coverage target is API scenario coverage: expected capability, boundary/validation behavior, and controlled exception/error handling.

Status Legend

Status	Meaning
Covered	The current IT verifies the expected behavior and its important result shape.
Partial	The current IT verifies representative behavior, but important public API scenarios remain.
Pending	No IT currently verifies this public API scenario.

Core, Health, Plugin, And Server

API surface / IT class	Covered API operations	Current status	Current / missing coverage
HealthConsoleApiOpenApiITCase	GET /v3/console/health/liveness GET /v3/console/health/readiness	Covered	Verifies health endpoints return wrapped success bodies with ok; validates the console port/base path contract. These APIs have no request parameters, so boundary coverage is limited to response contract shape.
NamespaceConsoleApiOpenApiITCase	GET,PUT,POST,DELETE /v3/console/core/namespace GET /v3/console/core/namespace/exist GET /v3/console/core/namespace/list	Covered	Creates, queries, updates, lists, checks existence, and deletes a namespace; validates missing required fields, invalid or overlong namespace IDs/names, duplicate create, and absent namespace behavior.
ClusterConsoleApiOpenApiITCase	GET /v3/console/core/cluster/nodes	Covered	Verifies standalone cluster node list shape, node identity fields, and wrapped response contract. The endpoint has no request parameters in the swagger surface.
ServerStateConsoleApiOpenApiITCase	GET /v3/console/server/state GET /v3/console/server/announcement GET /v3/console/server/guide	Covered	Verifies server state exposes expected state keys and announcement/guide endpoints return controlled wrapped data in the default standalone environment. These APIs do not mutate state.
PluginConsoleApiOpenApiITCase	GET /v3/console/plugin GET /v3/console/plugin/list GET /v3/console/plugin/availability GET /v3/console/plugin/config PUT /v3/console/plugin/config PUT /v3/console/plugin/status	Partial	Verifies plugin list/detail/availability response shapes, including the configValueMetas map shape, controlled validation/not-found errors, and rejection of config updates for non-configurable plugins. Full-map replacement/removal, key normalization, runtime/restart checks, same-source sensitive value preservation, persistence failure isolation, and retained-source apply failure/retry are covered by core unit tests because no built-in standalone plugin currently implements PluginConfigSpec.

Config

API surface / IT class	Covered API operations	Current status	Current / missing coverage
ConfigConsoleApiOpenApiITCase	GET,POST,DELETE /v3/console/cs/config	Covered	Publishes, queries, updates, and deletes config; verifies content, md5, type, description, config tags, namespace/group defaults into current public storage, missing required fields, invalid type, and absent config behavior. Removed empty-tenant migration and dual-write behavior is outside the 3.3 console API contract.
ConfigListConsoleApiOpenApiITCase	GET /v3/console/cs/config/list GET /v3/console/cs/config/searchDetail	Covered	Verifies list/search pagination shape, accurate and blur search behavior, dataId/group/content filters, empty pages, page validation, and required search parameters.
ConfigListenerConsoleApiOpenApiITCase	GET /v3/console/cs/config/listener GET /v3/console/cs/config/listener/ip	Covered	Verifies listener status response shape for config and IP scoped queries, missing dataId/group validation, query type fields, and controlled empty listener state.
ConfigHistoryConsoleApiOpenApiITCase	GET /v3/console/cs/history GET /v3/console/cs/history/list GET /v3/console/cs/history/previous GET /v3/console/cs/history/configs	Covered	Publishes versioned config changes and verifies history list/detail/previous/config snapshots; validates missing identifiers, pagination, and absent history/config behavior.
ConfigBetaConsoleApiOpenApiITCase	GET,DELETE /v3/console/cs/config/beta	Covered	Publishes current gray-backed beta config through console headers, queries and deletes beta content, and verifies missing/absent beta responses stay wrapped and non-500. Removed config_info_beta old-table migration is not an expected scenario.
ConfigBatchDeleteConsoleApiOpenApiITCase	DELETE /v3/console/cs/config/batchDelete	Covered	Creates multiple configs, deletes them through the batch API, verifies absence, and validates missing/empty IDs and malformed batch input.
ConfigExportConsoleApiOpenApiITCase	GET /v3/console/cs/config/export2	Covered	Exports existing config data, verifies file response and exported content, and validates empty export, missing namespace/group filters, and controlled bad request cases.
ConfigImportConsoleApiOpenApiITCase	POST /v3/console/cs/config/import	Covered	Imports zipped config payloads, verifies persisted imported data, overwrite behavior, malformed archive handling, and import result structure for success and failure cases.
ConfigCloneConsoleApiOpenApiITCase	POST /v3/console/cs/config/clone	Covered	Clones config to target dataId/group/namespace, verifies target content and metadata, and validates missing clone source/target fields and absent source config behavior.

Naming

API surface / IT class	Covered API operations	Current status	Current / missing coverage
ServiceConsoleApiOpenApiITCase	GET,PUT,POST,DELETE /v3/console/ns/service GET /v3/console/ns/service/list GET /v3/console/ns/service/selector/types GET /v3/console/ns/service/subscribers	Covered	Creates, queries, updates, lists, and deletes services; verifies selector type list, empty subscriber page shape, namespace/group defaults, duplicate create, invalid service/group/page fields, and absent service errors.
ServiceClusterConsoleApiOpenApiITCase	PUT /v3/console/ns/service/cluster	Covered	Creates service cluster metadata, verifies cluster-specific service detail/list behavior, updates health checker/protect threshold style fields, and validates missing service/cluster fields plus absent service behavior.
InstanceConsoleApiOpenApiITCase	PUT,DELETE /v3/console/ns/instance GET /v3/console/ns/instance/list	Covered	Registers setup service/instance, updates instance metadata/weight/enabled fields, lists instance state, deletes the instance, and validates missing IP/port/service, invalid port/weight, absent service, and controlled not-found behavior.

AI Registry And Copilot

API surface / IT class	Covered API operations	Current status	Current / missing coverage
A2aConsoleApiOpenApiITCase	GET,PUT,POST,DELETE /v3/console/ai/a2a GET /v3/console/ai/a2a/list GET /v3/console/ai/a2a/version/list	Covered	Registers legacy and v1 AgentCards, verifies normalized fields and latest/version queries, updates a new version, lists by accurate/blur search, deletes resources, and validates missing names, bad search, invalid registration type, malformed JSON, incomplete endpoint definitions, and absent agents.
McpConsoleApiOpenApiITCase	GET,PUT,POST,DELETE /v3/console/ai/mcp GET /v3/console/ai/mcp/list GET /v3/console/ai/mcp/importToolsFromMcp POST /v3/console/ai/mcp/import/validate POST /v3/console/ai/mcp/import/execute	Covered	Creates, queries, updates, lists, and deletes MCP servers; verifies generated ID, latest/allVersions, tool spec, accurate/blur list, duplicate conflict, missing identity/spec/version, invalid ID, malformed JSON, absent server, unsupported tool import transport, and import request validation. Console currently accepts resourceSpecification but does not persist it because the controller does not parse resources; the IT records that observable behavior.
PromptConsoleApiOpenApiITCase	DELETE /v3/console/ai/prompt GET /v3/console/ai/prompt/list GET /v3/console/ai/prompt/versions GET /v3/console/ai/prompt/governance GET /v3/console/ai/prompt/version GET /v3/console/ai/prompt/version/download POST,PUT,DELETE /v3/console/ai/prompt/draft POST /v3/console/ai/prompt/submit POST /v3/console/ai/prompt/publish POST /v3/console/ai/prompt/force-publish POST /v3/console/ai/prompt/redraft POST /v3/console/ai/prompt/online POST /v3/console/ai/prompt/offline PUT /v3/console/ai/prompt/labels PUT /v3/console/ai/prompt/description PUT /v3/console/ai/prompt/biz-tags	Covered	Verifies prompt draft/update/delete, submit, force publish, version detail, governance metadata, version list, list filters, Markdown download, labels, server-managed latest label preservation, publish-parameter compatibility, description/bizTags, online/offline latest maintenance, delete, and absent resource/version errors. Validates missing promptKey/template/version/labels/description, invalid search, publish/redraft state errors, and controlled non-500 failures. Runtime-only legacy prompt endpoints are intentionally not covered because they are not exposed by the console controller.
SkillConsoleApiOpenApiITCase	GET,DELETE /v3/console/ai/skills GET /v3/console/ai/skills/list GET /v3/console/ai/skills/version GET /v3/console/ai/skills/version/download POST,PUT,DELETE /v3/console/ai/skills/draft POST /v3/console/ai/skills/submit POST /v3/console/ai/skills/publish POST /v3/console/ai/skills/force-publish POST /v3/console/ai/skills/redraft POST /v3/console/ai/skills/online POST /v3/console/ai/skills/offline PUT /v3/console/ai/skills/labels PUT /v3/console/ai/skills/biz-tags PUT /v3/console/ai/skills/scope	Covered	Verifies skill draft/update/fork/delete, submit, force publish, detail, version detail, list filters, ZIP download, labels, server-managed latest label preservation, publish-parameter compatibility, bizTags, PUBLIC/PRIVATE scope, version-level and skill-level online/offline latest maintenance, delete, and absent resource/version errors. Validates missing skillName/skillCard/targetVersion/version/labels/scope, name mismatch, invalid version/search/scope/page, and invalid lifecycle transitions.
SkillUploadConsoleApiOpenApiITCase	POST /v3/console/ai/skills/upload POST /v3/console/ai/skills/upload/batch/precheck POST /v3/console/ai/skills/upload/batch	Covered	Verifies single ZIP upload from SKILL.md plus resources, lightweight JSON metadata precheck action reporting for an existing editing draft, overwrite of an editing draft, next draft version after publish, short uploaded version normalization and invalid uploaded version fallback for precheck/upload/batch upload, batch upload success, partial batch failure reporting, duplicate working draft conflict, empty/malformed ZIP, and archive parsing failures.
AgentSpecConsoleApiOpenApiITCase	GET,DELETE /v3/console/ai/agentspecs GET /v3/console/ai/agentspecs/list GET /v3/console/ai/agentspecs/version POST,PUT,DELETE /v3/console/ai/agentspecs/draft POST /v3/console/ai/agentspecs/submit POST /v3/console/ai/agentspecs/publish POST /v3/console/ai/agentspecs/force-publish POST /v3/console/ai/agentspecs/redraft POST /v3/console/ai/agentspecs/online POST /v3/console/ai/agentspecs/offline PUT /v3/console/ai/agentspecs/labels PUT /v3/console/ai/agentspecs/biz-tags PUT /v3/console/ai/agentspecs/scope	Covered	Verifies AgentSpec draft/update/auto-create/fork/delete, submit, force publish, detail, version detail, list filters, labels, server-managed latest label preservation, publish-parameter compatibility, bizTags, scope, version-level and resource-level online/offline latest maintenance, delete, and absent resource/version errors. Validates missing agentSpecName/agentSpecCard/targetVersion/version/labels/scope, invalid version/search/scope/page, and invalid lifecycle transitions. The shared bizTag filter is accepted but not applied by the AgentSpec service; the IT records that behavior.
AgentSpecUploadConsoleApiOpenApiITCase	POST /v3/console/ai/agentspecs/upload	Covered	Verifies single AgentSpec ZIP upload from manifest.json plus resources, overwrite of an editing draft, next draft version after publish, seed archives importing multiple AgentSpecs, empty file, malformed ZIP, and missing manifest errors.
AiResourceImportConsoleApiOpenApiITCase	GET /v3/console/ai/import/sources POST /v3/console/ai/import/search POST /v3/console/ai/import/validate POST /v3/console/ai/import/execute	Covered	Verifies configured import source list, resourceType filters, sanitized source info, unsupported resource type empty result, missing resourceType/sourceId/selectedItems, malformed JSON options/selectedItems, empty selected items, unknown source not-found, unsupported source/resourceType combinations, and controlled error bodies without performing external network import.
PipelineConsoleApiOpenApiITCase	GET /v3/console/ai/pipelines GET /v3/console/ai/pipelines/list GET /v3/console/ai/pipelines/detail GET /v3/console/ai/pipelines/{pipelineId}	Partial	Verifies current and legacy list page contracts for resourceType/resourceName/namespaceId/version filters, required resourceType, page validation, required pipelineId, and absent pipeline not-found errors. Successful detail creation is not covered in the default standalone IT environment because pipeline rows require configured publish-pipeline plugins.
CopilotConsoleApiOpenApiITCase	GET,POST /v3/console/copilot/config POST /v3/console/copilot/skill/optimize POST /v3/console/copilot/skill/generate POST /v3/console/copilot/prompt/optimize POST /v3/console/copilot/prompt/debug	Partial	Verifies config save/read for API key, model, studio URL, and studio project; records that non-editable config fields are accepted but ignored by the save path. Verifies malformed JSON config error and SSE validation error events for empty bodies and missing required skill/background/prompt/userInput fields without invoking an external LLM provider.

Validation Snapshot

The console API IT set was validated with:

• mvn -pl test/openapi-test spotless:apply
• mvn -pl test/openapi-test spotless:check
• mvn -pl test/openapi-test -DskipTests test-compile
• mvn -pl test/openapi-test -Pintegration-test -DskipTests=false -Dit.test='*ConsoleApiOpenApiITCase' verify

The full console IT verification ran 75 tests with no failures.