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
<xs:element name="accountId" type="xs:string" minOccurs="0"/>After
<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.
| Change pattern | Direction | Classification | Client impact |
|---|---|---|---|
| Make an XML element required | Request | Breaking | Older requests can fail XSD validation. |
| Remove a WSDL operation | Service | Breaking | Generated stubs still call the missing operation. |
| Change the target namespace | Binding | Breaking | Existing envelopes can carry the old qualified names. |
| Add an optional response element | Response | Review consumers | Strict clients may validate against the old response schema. |
What should you check before deploying?
- Resolve the target WSDL operation and imports, including the XSD namespace and binding.
- Review element order, minOccurs and maxOccurs, nillability, SOAP action and fault shapes.
- 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
- GraphQL breaking changes in schemas and operations
- gRPC and Protobuf breaking changes
- AsyncAPI breaking changes in events and messages
- SOAP and WSDL breaking changes
- Self-healing API integrations with checked migration drafts
- How to detect API contract drift before it breaks consumers
- oasdiff and API code impact analysis answer different questions.
- Detect breaking API changes in a GitHub workflow.
- Why a TypeScript build can pass after an API changes.
- OpenAI OpenAPI breaking changes: a captured response change.
- Sentry OpenAPI breaking changes: removed replay query values.
- Inspect classification rules interactively
- Check captured OpenAPI changes
- Compare JSON Schemas
- Plan your business evaluation
Use public API change evidence in your IDE with MCP
Browse public API change history, including OpenAI and Sentry.
Rule reference
schema.request_acceptance_narrowed: Request schema accepts fewer valuesoperation.endpoint_removed: Endpoint removed from the contractrequest.content_removed: Request media type removedlevel.error: Detector error falls back to breakingrequest.enum_removed: Request enum value removedrequest.now_required: Request property becomes requiredresponse.removed: Response property removedresponse.now_optional_or_nullable: Response property becomes optional or nullablerequest.removed_unknown_strictness: Request property removed, server strictness unknown