Summary
The GET requests to the NLU Domains API return NLU Domain objects that reference only the draft and latest published domain versions.
Previously, the return type in the API was defined as the full NLU Domain Version object, even though only partial data is returned. This change updates the return type reference to accurately reflect the actual response structure.
Effective Date
Monday, July 21, 2025
Details
Several tools rely on the return type definitions in the Public API to auto-generate data models that validate API inputs and outputs. The previous reference to the full NLU Domain Version object created a misleading expectation and could result in validation errors or failed integrations.
By correcting the reference to match the actual response (which includes only the draft and latest published versions), we improve clarity, prevent integration issues, and enhance overall API reliability.
Customer Impact
There is no change to the actual data returned by the NLU Domains endpoints, so no customer impact is expected.
Impacted Resources
GET /api/v2/languageunderstanding/domains
GET /api/v2/languageunderstanding/domains/<domain_id>
Issue References
[NLU-5192]
Contacts
@Kevin Walsh
Please reply to this announcement with any questions. This helps the wider developer community benefit from the discussion. We encourage you to use this thread before contacting the designated person directly. Thank you for your understanding.