DOCUMENTATION / API COMPATIBILITY

SOAP and WSDL breaking changes

By Soumik Ghosh ยท Published

Check changes to SOAP operations, WSDL bindings, XSD cardinality and namespaces before regenerating or migrating client stubs.

Make an XML request element required

Before

XML
<xs:element name="accountId" type="xs:string" minOccurs="0"/>

After

XML
<xs:element name="accountId" type="xs:string" minOccurs="1"/>

A request without accountId can validate against the first schema and fail against the second. Existing stubs may still serialize requests that omit the element.

Compatibility patterns to review
Change patternDirectionClassificationClient impact
Make an XML element requiredRequestBreakingOlder requests can fail XSD validation.
Remove a WSDL operationServiceBreakingGenerated stubs still call the missing operation.
Change the target namespaceBindingBreakingExisting envelopes can carry the old qualified names.
Add an optional response elementResponseReview consumersStrict clients may validate against the old response schema.

What should you check before deploying?

  1. Resolve the target WSDL operation and imports, including the XSD namespace and binding.
  2. Review element order, minOccurs and maxOccurs, nillability, SOAP action and fault shapes.
  3. Validate representative XML envelopes and exercise the actual client serializer with the configured binding.

What can ParityDiff verify?

WSDL/XSD intake records service and operation bindings with XML schema context. Code and runtime readiness depend on the actual imports, encoding and client serialization.

W3C WSDL specification and the contract support matrix.

API compatibility guides and tools

Use public API change evidence in your IDE with MCP

Browse public API change history, including OpenAI and Sentry.

Rule reference