Skip to content

fix: validate metadata in api catalog too #4922

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

Merged
pablocarle merged 9 commits into from
Aug 27, 2026
Merged

fix: validate metadata in api catalog too #4922

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c6da551
validate metadata in api catalog too
Aug 26, 2026
7cd70e7
checkstyle
Aug 26, 2026
dcda713
Merge branch 'v3.x.x' into reboot/fix/validate-metadata-catalog
pablocarle Aug 27, 2026
ab3f1a5
Merge branch 'v3.x.x' into reboot/fix/validate-metadata-catalog
pablocarle Aug 27, 2026
7ea1abb
remove old exception
Aug 27, 2026
2aac36b
Merge branch 'reboot/fix/validate-metadata-catalog' of https://github…
Aug 27, 2026
d36e325
fix api catalog tests
Aug 27, 2026
aad40ab
allowed domains setting in api catalog service
Aug 27, 2026
8455eb4
fix message
Aug 27, 2026
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
75 changes: 38 additions & 37 deletions api-catalog-package/src/main/resources/bin/start.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,64 +115,65 @@ _BPX_JOBNAME=${ZWE_zowe_job_prefix}${CATALOG_CODE} ${JAVA_BIN_DIR}java \
${EXTERNAL_URL} \
${EUREKA_IP_ADDRESS} \
${CUSTOM_JVM_OPTS} \
-Dibm.serversocket.recover=true \
-Dfile.encoding=UTF-8 \
-Djava.io.tmpdir=${TMPDIR:-/tmp} \
-Dspring.profiles.active=${ZWE_configs_spring_profiles_active:-} \
-Dapiml.service.hostname=${ZWE_haInstance_hostname:-localhost} \
-Dapiml.service.port=${ZWE_configs_port:-7552} \
-Dapiml.service.discoveryServiceUrls=${ZWE_DISCOVERY_SERVICES_LIST} \
-Dapiml.service.gatewayHostname=${ZWE_GATEWAY_HOST:-${ZWE_haInstance_hostname:-localhost}} \
-Dapiml.discovery.userid=${discoveryUserid} \
-Dapiml.catalog.customStyle.backgroundColor=${ZWE_configs_apiml_catalog_customStyle_backgroundColor:-} \
-Dapiml.catalog.customStyle.docLink=${ZWE_configs_apiml_catalog_customStyle_docLink:-} \
-Dapiml.catalog.customStyle.fontFamily=${ZWE_configs_apiml_catalog_customStyle_fontFamily:-} \
-Dapiml.catalog.customStyle.headerColor=${ZWE_configs_apiml_catalog_customStyle_headerColor:-} \
-Dapiml.catalog.customStyle.logo=${ZWE_configs_apiml_catalog_customStyle_logo:-} \
-Dapiml.catalog.customStyle.textColor=${ZWE_configs_apiml_catalog_customStyle_textColor:-} \
-Dapiml.catalog.customStyle.titlesColor=${ZWE_configs_apiml_catalog_customStyle_titlesColor:-} \
-Dapiml.catalog.hide.serviceInfo=${ZWE_configs_apiml_catalog_hide_serviceInfo:-false} \
-Dapiml.discovery.password=${discoveryPassword} \
-Dapiml.logs.location=${ZWE_zowe_logDirectory} \
-Dapiml.health.protected=${ZWE_configs_apiml_health_protected:-true} \
-Dapiml.discovery.staticApiDefinitionsDirectories=${ZWE_STATIC_DEFINITIONS_DIR} \
-Dapiml.security.ssl.verifySslCertificatesOfServices=${verifySslCertificatesOfServices:-false} \
-Dapiml.security.ssl.nonStrictVerifySslCertificatesOfServices=${nonStrictVerifySslCertificatesOfServices:-false} \
-Dapiml.security.authorization.provider=${ZWE_configs_apiml_security_authorization_provider:-${ZWE_components_gateway_apiml_security_authorization_provider:-"native"}} \
-Dapiml.discovery.userid=${discoveryUserid} \
-Dapiml.health.protected=${ZWE_configs_apiml_health_protected:-true} \
-Dapiml.logs.location=${ZWE_zowe_logDirectory} \
-Dapiml.security.allowedDomains=${ZWE_ALLOWED_DOMAINS} \
-Dapiml.security.auth.cookieProperties.cookieName=${cookieName:-apimlAuthenticationToken} \
-Dapiml.security.authorization.endpoint.enabled=${ZWE_components_gateway_apiml_security_authorization_endpoint_enabled:-false} \
-Dapiml.security.authorization.endpoint.url=${ZWE_components_gateway_apiml_security_authorization_endpoint_url:-"${internalProtocol:-https}://${ZWE_haInstance_hostname:-localhost}:${ZWE_components_gateway_port}/zss/api/v1/saf-auth"} \
-Dapiml.security.authorization.provider=${ZWE_configs_apiml_security_authorization_provider:-${ZWE_components_gateway_apiml_security_authorization_provider:-"native"}} \
-Dapiml.security.authorization.resourceClass=${ZWE_components_gateway_apiml_security_authorization_resourceClass:-ZOWE} \
-Dapiml.security.auth.cookieProperties.cookieName=${cookieName:-apimlAuthenticationToken} \
-Dapiml.catalog.hide.serviceInfo=${ZWE_configs_apiml_catalog_hide_serviceInfo:-false} \
-Dapiml.catalog.customStyle.logo=${ZWE_configs_apiml_catalog_customStyle_logo:-} \
-Dapiml.catalog.customStyle.fontFamily=${ZWE_configs_apiml_catalog_customStyle_fontFamily:-} \
-Dapiml.catalog.customStyle.backgroundColor=${ZWE_configs_apiml_catalog_customStyle_backgroundColor:-} \
-Dapiml.catalog.customStyle.titlesColor=${ZWE_configs_apiml_catalog_customStyle_titlesColor:-} \
-Dapiml.catalog.customStyle.headerColor=${ZWE_configs_apiml_catalog_customStyle_headerColor:-} \
-Dapiml.catalog.customStyle.textColor=${ZWE_configs_apiml_catalog_customStyle_textColor:-} \
-Dapiml.catalog.customStyle.docLink=${ZWE_configs_apiml_catalog_customStyle_docLink:-} \
-Dapiml.service.ssl.enabled-protocols=${ZWE_configs_apiml_service_ssl_enabled_protocols:-${client_enabled_protocols}} \
-Dapiml.security.ssl.nonStrictVerifySslCertificatesOfServices=${nonStrictVerifySslCertificatesOfServices:-false} \
-Dapiml.security.ssl.verifySslCertificatesOfServices=${verifySslCertificatesOfServices:-false} \
-Dapiml.service.discoveryServiceUrls=${ZWE_DISCOVERY_SERVICES_LIST} \
-Dapiml.service.gatewayHostname=${ZWE_GATEWAY_HOST:-${ZWE_haInstance_hostname:-localhost}} \
-Dapiml.service.hostname=${ZWE_haInstance_hostname:-localhost} \
-Dapiml.service.port=${ZWE_configs_port:-7552} \
-Dapiml.service.ssl.ciphers=${ZWE_configs_apiml_service_ssl_ciphers:-${client_ciphers}} \
-Dapiml.service.ssl.enabled-protocols=${ZWE_configs_apiml_service_ssl_enabled_protocols:-${client_enabled_protocols}} \
-Dapiml.service.ssl.key-alias="${client_key_alias}" \
-Dapiml.service.ssl.key-password="${client_key_pass}" \
-Dapiml.service.ssl.key-store="${client_keystore_location}" \
-Dapiml.service.ssl.key-store-password="${client_keystore_pass}" \
-Dapiml.service.ssl.key-store-type="${client_keystore_type}" \
-Dapiml.service.ssl.key-store="${client_keystore_location}" \
-Dapiml.service.ssl.protocol=${ZWE_configs_apiml_service_ssl_protocol:-${server_protocol}} \
-Dapiml.service.ssl.trust-store="${client_truststore_location}" \
-Dapiml.service.ssl.trust-store-password="${client_truststore_pass}" \
-Dapiml.service.ssl.trust-store-type="${client_truststore_type}" \
-Dapiml.service.ssl.trust-store="${client_truststore_location}" \
-Dfile.encoding=UTF-8 \
-Dibm.serversocket.recover=true \
-Djava.io.tmpdir=${TMPDIR:-/tmp} \
-Djava.library.path=${LIBPATH} \
-Djava.protocol.handler.pkgs=com.ibm.crypto.provider \
-Djavax.net.debug=${ZWE_configs_sslDebug:-""} \
-Djdk.tls.client.cipherSuites=${client_ciphers} \
-Dloader.path=${COMMON_LIB} \
-Dotel.sdk.disabled=true \
-Dserver.address=${ZWE_configs_zowe_network_server_listenAddresses:-${ZWE_zowe_network_server_listenAddresses:-"0.0.0.0"}} \
-Dserver.ssl.ciphers=${server_ciphers} \
-Dserver.ssl.protocol=${server_protocol} \
-Dserver.ssl.enabled-protocols=${server_enabled_protocols} \
-Dserver.address=${ZWE_configs_zowe_network_server_listenAddresses:-${ZWE_zowe_network_server_listenAddresses:-"0.0.0.0"}} \
-Dserver.ssl.enabled=${ZWE_configs_server_ssl_enabled:-true} \
-Dserver.ssl.keyStore="${keystore_location}" \
-Dserver.ssl.keyStoreType="${keystore_type}" \
-Dserver.ssl.keyStorePassword="${keystore_pass}" \
-Dserver.ssl.keyAlias="${key_alias}" \
-Dserver.ssl.keyPassword="${key_pass}" \
-Dserver.ssl.keyStore="${keystore_location}" \
-Dserver.ssl.keyStorePassword="${keystore_pass}" \
-Dserver.ssl.keyStoreType="${keystore_type}" \
-Dserver.ssl.protocol=${server_protocol} \
-Dserver.ssl.trustStore="${truststore_location}" \
-Dserver.ssl.trustStoreType="${truststore_type}" \
-Dserver.ssl.trustStorePassword="${truststore_pass}" \
-Djava.protocol.handler.pkgs=com.ibm.crypto.provider \
-Dloader.path=${COMMON_LIB} \
-Djava.library.path=${LIBPATH} \
-Djavax.net.debug=${ZWE_configs_sslDebug:-""} \
-Dotel.sdk.disabled=true \
-Dserver.ssl.trustStoreType="${truststore_type}" \
-Dspring.profiles.active=${ZWE_configs_spring_profiles_active:-} \
-jar "${JAR_FILE}" &
pid=$!
echo "pid=${pid}"
Expand Down
26 changes: 22 additions & 4 deletions api-catalog-services/src/main/java/org/zowe/apiml/apicatalog/swagger/ApiDocService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import org.apache.commons.lang3.StringUtils;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.cloud.client.discovery.DiscoveryClient;
import org.springframework.cloud.netflix.eureka.EurekaServiceInstance;
import org.springframework.stereotype.Service;
import org.springframework.web.util.UriComponents;
import org.springframework.web.util.UriComponentsBuilder;
Expand All @@ -24,6 +25,8 @@
import org.zowe.apiml.apicatalog.model.ApiDocInfo;
import org.zowe.apiml.config.ApiInfo;
import org.zowe.apiml.eurekaservice.client.util.EurekaMetadataParser;
import org.zowe.apiml.exception.MetadataValidationException;
import org.zowe.apiml.product.eureka.web.MetadataFilterService;
import org.zowe.apiml.product.gateway.GatewayClient;
import org.zowe.apiml.product.instance.ServiceAddress;
import org.zowe.apiml.product.routing.RoutedService;
Expand All @@ -48,6 +51,7 @@ public class ApiDocService {
private final TransformApiDocService transformApiDocService;
private final ApiDocRetrievalServiceLocal apiDocRetrievalServiceLocal;
private final ApiDocRetrievalServiceRest apiDocRetrievalServiceRest;
private final MetadataFilterService metadataFilterService;

ServiceInstance getInstanceInfo(String serviceId) {
return EurekaUtils.getInstanceInfo(discoveryClient, serviceId)
Expand Down Expand Up @@ -329,8 +333,15 @@ private ApiInfo findApi(List<ApiInfo> apiInfos, String apiVersion) {
* @throws ApiDocNotFoundException if the response is error
*/
public Mono<String> retrieveApiDoc(@NonNull String serviceId, String apiVersion) {
ServiceInstance serviceInstance = getInstanceInfo(serviceId);
List<ApiInfo> apiInfoList = metadataParser.parseApiInfo(serviceInstance.getMetadata());
EurekaServiceInstance serviceInstance = (EurekaServiceInstance) getInstanceInfo(serviceId);
try {
serviceInstance = new EurekaServiceInstance(metadataFilterService.verifyAllowedDomains(serviceInstance.getInstanceInfo()));
} catch (MetadataValidationException e) {
log.debug("Failure validating metadata against allowed domains", e);
throw new ApiDocNotFoundException(e.getMessage());
}

var apiInfoList = metadataParser.parseApiInfo(serviceInstance.getMetadata());
var apiInfo = findApi(apiInfoList, apiVersion);
return retrieveApiDoc(serviceInstance, apiInfo);
}
Expand All @@ -348,8 +359,15 @@ public Mono<String> retrieveApiDoc(@NonNull String serviceId, String apiVersion)
* @throws ApiDocNotFoundException if the response is error
*/
public Mono<String> retrieveDefaultApiDoc(@NonNull String serviceId) {
ServiceInstance serviceInstance = getInstanceInfo(serviceId);
List<ApiInfo> apiInfoList = metadataParser.parseApiInfo(serviceInstance.getMetadata());
EurekaServiceInstance serviceInstance = (EurekaServiceInstance) getInstanceInfo(serviceId);
try {
serviceInstance = new EurekaServiceInstance(metadataFilterService.verifyAllowedDomains(serviceInstance.getInstanceInfo()));
} catch (MetadataValidationException e) {
log.debug("Failure validating metadata against allowed domains", e);
throw new ApiDocNotFoundException(e.getMessage());
}

var apiInfoList = metadataParser.parseApiInfo(serviceInstance.getMetadata());
var apiInfo = getDefaultApiInfo(apiInfoList);
return retrieveApiDoc(serviceInstance, apiInfo);
}
Expand Down
Loading
Loading