Oracle Radio API Versioning and Compatibility
Match REST, WebSocket, and any published SDK contracts to the Public Safety and Security release used by the client.
Track the Contract Set
The Public Safety and Security control-plane API and instance-hosted Radio contracts can use different version schemes. Do not derive a Radio message or client version from the control-plane API date.
For each client release, record the Public Safety and Security release and the REST and WebSocket contract versions that the client implements. If an SDK is published for the release, record its version separately. Accept additive response properties when the contract permits them, and do not send undocumented properties as a compatibility strategy.
Resolve a Contract Conflict
- Identify the Public Safety and Security instance, API surface, operation, and customer-visible error or WebSocket result. Don't record credentials, registration values, or message content that isn't required for diagnosis.
- Confirm that the client uses the
serviceEndpointreturned for the active Public Safety and Security instance and the supported operation path for the release. - Compare the request method, message
type, required properties, value constraints, and authentication placement with the current published operation topic. - Remove undocumented request properties and legacy path or message assumptions. Preserve additive response properties that the current contract tells clients to ignore.
- Reauthenticate by using the supported authentication path. If authentication succeeds but the operation is denied, verify the user's permissions and applicable channel access separately.
- Retry only when the operation's error guidance says that retry is safe. For a state-changing operation with an indeterminate result, obtain current state before deciding whether to repeat it.
- If the conflict remains, preserve the contract versions, operation name, request ID when returned, and sanitized customer-visible response for support.
Before Upgrading a Client
Review the release documentation for changed operation paths, message types, required properties, authentication requirements, permissions, and audio or message schemas. Test the upgraded client against the target Public Safety and Security release before broad deployment.
More Help
Use troubleshooting for request, connection, and message failures. See the FAQ for common authentication, retry, and WebSocket-state questions.