Swagger docs inaccurate / outdated

[kitajchuk]

Something the webapp refresh has illuminated is that the Swagger docs for the API server have quite a bit of inaccuracies compared to actual DTO responses received on the client as well as at least one endpoint missing from the documentation entirely. It would be worth combing over the Swagger yaml and getting the documentation up to date. This issue may overlap with this one: #13 and we might be able to consolidate and close the older issue 🤔.

Todo for this issue:

• Create a "completed", comprehensive list of what is known to be missing or inaccurate in the Swagger docs

Comprehensive (incomplete) list of what is missing/inaccurate in Swagger docs:

• The API for Accounts/:account_sid/Applications is in use for the webapp but missing entirely from the docs
• The SmppGateways/SipGateways show inbound/outbound as boolean but they are actually binary: 1/0
• The SpeechCredential shows use_for_tts/use_for_stt as boolean but they are also binary: 1/0
• The RecentCalls shows the field as sip_call_id but it is actually sip_callid as returned from the API
• The :GET RecentCall and RecentCall pcap toggles have the same ID and both toggle open at the same time
• The paged responses for CDRs (RecentCalls, Alerts) have a different response schema where the docs claim a field called batch but instead the api returns a page_size field. Also the page and page_size fields are strings whereas the total field is a number and ideally they would all 3 be numbers 🤔
• ...

[rjp44]

Please add PhoneNumbers which is at present undocumented to that list.