Skip to content

honour hiddenService in openapi spec and mcp catalog generation #1311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kali834x wants to merge 1 commit into
base: master
Choose a base branch
from
Open

honour hiddenService in openapi spec and mcp catalog generation #1311

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions modules/openapi/src/main/java/org/apache/axis2/openapi/OpenApiSpecGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,14 @@ private boolean shouldIncludeService(AxisService service) {
return false;
}

// hiddenService is the separate control that keeps a service out of the
// /services listing on both HTTP render paths. The spec and the MCP
// catalog enumerate deployed services the same way, so they honour it too.
if (org.apache.axis2.util.Utils.isHiddenService(service)) {
log.debug("Skipping service with hiddenService=true: " + serviceName);
return false;
}

String servicePackage = getServicePackage(service);

// If readAllResources is false, check specific resource classes/packages
Expand Down
20 changes: 20 additions & 0 deletions modules/openapi/src/test/java/org/apache/axis2/openapi/McpCatalogGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -986,6 +986,26 @@ public void testMcpResourcesExcludesSystemServices() throws Exception {
assertEquals("PortfolioService", resources.get(0).path("name").asText());
}

public void testHiddenServiceExcludedFromToolsAndResources() throws Exception {
addService("PortfolioService", "getPortfolio");
AxisService hidden = new AxisService("InternalOpsService");
hidden.addParameter(new org.apache.axis2.description.Parameter(
org.apache.axis2.Constants.HIDDEN_SERVICE_PARAM_NAME, "true"));
addOperation(hidden, "purgeAll");
axisConfig.addService(hidden);

String catalog = generator.generateMcpCatalogJson(mockRequest);
assertFalse("hidden service must not appear in the MCP catalog",
catalog.contains("InternalOpsService"));
assertFalse("hidden service operation must not appear in the MCP catalog",
catalog.contains("purgeAll"));

JsonNode resources = MAPPER.readTree(generator.generateMcpResourcesJson(mockRequest))
.path("resources");
assertEquals("only PortfolioService, not the hidden service", 1, resources.size());
assertEquals("PortfolioService", resources.get(0).path("name").asText());
}

public void testMcpResourcesIncludesOperationList() throws Exception {
AxisService svc = new AxisService("PortfolioService");
addOperation(svc, "getPortfolio");
Expand Down
32 changes: 32 additions & 0 deletions modules/openapi/src/test/java/org/apache/axis2/openapi/OpenApiSpecGeneratorTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,6 +278,38 @@ public void testIgnoredServiceIsExcluded() throws Exception {
openApi.getPaths().get("/services/InternalService/secretOp"));
}

/**
* Test that a service with hiddenService=true is omitted from the spec, as
* it is from the /services listing.
*/
public void testHiddenServiceIsExcluded() throws Exception {
// Arrange
AxisService visible = new AxisService("PublicService");
AxisOperation visibleOp = new org.apache.axis2.description.InOutAxisOperation();
visibleOp.setName(javax.xml.namespace.QName.valueOf("getData"));
visible.addOperation(visibleOp);

AxisService hidden = new AxisService("InternalService");
hidden.addParameter(new org.apache.axis2.description.Parameter(
org.apache.axis2.Constants.HIDDEN_SERVICE_PARAM_NAME, "true"));
AxisOperation hiddenOp = new org.apache.axis2.description.InOutAxisOperation();
hiddenOp.setName(javax.xml.namespace.QName.valueOf("secretOp"));
hidden.addOperation(hiddenOp);

axisConfiguration.addService(visible);
axisConfiguration.addService(hidden);

// Act
OpenAPI openApi = generator.generateOpenApiSpec(mockRequest);

// Assert
assertNotNull(openApi.getPaths());
assertNotNull("Public service path should be present",
openApi.getPaths().get("/services/PublicService/getData"));
assertNull("Hidden service path must be absent",
openApi.getPaths().get("/services/InternalService/secretOp"));
}

/**
* Test that a qualified "ServiceName/operationName" entry in ignoredOperations
* removes only that specific operation, leaving other operations on the same
Expand Down