WSDL Replacement Draft Result Data Model

Overview

The WsdlReplacementDraftResult is a data structure that represents the outcome of creating a new draft service version by replacing an existing Web Services Description Language (WSDL) file.

When an API publisher updates a SOAP-based service by providing a new WSDL, the platform generates a new draft version of the service. This data model is returned upon the successful creation of that draft. It provides a comprehensive summary of the changes between the original service version and the new draft, including a breakdown of new, removed, and preserved operations. It also includes unique identifiers for the new version and its artifacts, details about the backend configuration, and a collection of any non-blocking warnings discovered during WSDL processing.

This object serves as the primary output for the WSDL replacement workflow, giving the API publisher immediate feedback on the impact of their changes.

Data Model Reference

WsdlReplacementDraftResult is a data object containing the following fields.

Field	Type	Description
serviceId	UUID	The unique identifier for the service being updated.
versionId	UUID	The unique identifier for the new draft service version that was created.
versionNo	int	The version number assigned to the new draft.
sourceVersionId	UUID	The unique identifier of the service version that was used as the basis for the replacement.
sourceArtifactId	UUID	The unique identifier of the original WSDL artifact that was replaced.
latestArtifactId	UUID	The unique identifier for the new WSDL artifact associated with the draft version.
generatedOperationCount	int	The total number of operations defined in the new service version based on the new WSDL.
preservedOperationCount	int	The number of operations that exist in both the source version and the new draft version. These operations were carried over.
newOperationCount	int	The number of operations that were introduced in the new draft version and did not exist in the source version.
removedOperationCount	int	The number of operations that existed in the source version but are not present in the new draft version.
backendProfileId	UUID	The unique identifier of the backend profile associated with the new service version.
backendEndpointUrl	String	The backend endpoint URL configured for the new service version.
backendAutoConfigured	boolean	A flag indicating whether the backend configuration was automatically determined and applied.
contractWarnings	Map<String, Object>	A map of non-blocking contract validation findings. If no warnings are present, this field will be null. See the Troubleshooting section for more details. The structure is the same as in GeneratedServiceResult.

Troubleshooting

Contract Warnings

The contractWarnings field contains a map of non-blocking issues found during the processing of the new WSDL. These are not errors that prevent the creation of the draft service version, but are potential problems that an API publisher should review.

• Warning Code: The source indicates these warnings are associated with the finding code S2R-ADM-0612.
• Impact: The presence of warnings means the draft was created successfully, but the service contract may have ambiguities or inconsistencies that could affect runtime behavior.
• Action: API publishers should inspect the contents of the contractWarnings map to understand the specific issues and determine if the source WSDL needs to be corrected.
• Absence of Warnings: If the contractWarnings field is null, it signifies that no non-blocking issues were detected during the WSDL analysis.

See Also

• GeneratedServiceResult: The contractWarnings field in this model shares the same structure as the one found in the GeneratedServiceResult data model.

---

All SOAP-to-REST docs