[DOC] - Missing CXML Error Codes/Messages #401
Description
Describe the requested update
We recently audited LaML error codes and discovered several that are missing from the current documentation. Many of these error codes also return multiple message variations depending on context or type.
The current mappings can be found in this CSV: signalwire_laml_error_code_mapping.csv.
We definitely want to align these, but there are a few considerations to keep in mind:
- We’ve opened several Prime tasks to improve this area. These include investigating error code 10000, extracting all error codes to a centralized source for better consistency, and auditing each code for accuracy. With this in progress, some codes may change - most, especially the ones in the CSV with single error messages, will stay the same.
- The current documentation seems more structured for a single message/type per error code. However, many codes return multiple message or type variations. I'm not sure if it can be easily modified to cleanly support multiples, but wanted to give a heads up in case your team would like to consider alternative designs to better support this structure.
Reason for the request
Evaluating findings from the audit
Sections to be updated
https://developer.signalwire.com/rest/compatibility-api/overview/error-codes/
Additional context
We completed an audit of the LaML API error codes - both across our codebase, and in comparison to the documentation as well. We found a number of discrepancies, and created several Prime tickets for improving consistency, investigating the conflicting codes, and ensuring accuracy.
However, separately from the Prime updates, there are some issues we may want to address in the docs too. I am opening subtasks for these so that Devex can assess and determine the best way to handle each issue.
Related Issues or PRs
references prime audit
findings here