Define API spec

Description

diff of the changes to the phone_numbers api.yml spec:

Zendesk Ticket IDs

None

Activity

Show:

Charles Langlois October 15, 2024 at 3:54 PM

Updated the spec after revision:

  • range spec now only contains start_number and end_number; no caller_id_name or shared options supported for range, as it’s unlikely it would make sense to set those options to the same value in bulk

Charles Langlois October 11, 2024 at 8:13 PM

Since we now want an idempotent transactional API, we could use

Or

Charles Langlois October 11, 2024 at 8:05 PM
Edited

Also need to add trunks field to input now( )

Charles Langlois October 10, 2024 at 3:39 PM
Edited

After discussion we decided that the API should behave idempotently with respect to duplicates. i.e. elements of the range that already exist identically(same shared value and non-null caller_id_name specified by the range) will be silently skipped, allowing only missing entries to be created.
This should imply a response format that can provide links to all phone number objects matching all entries in the range, with information to know which were newly created.

However, if fields like shared , caller_id_name , trunks differs from existing entries(defined but different), we must abort with an error as we don’t want the user to mistakenly overwrite large number of entries

Done

Details

Priority

Assignee

Reporter

Fix versions

Sprint

Zendesk Support

Created September 26, 2024 at 2:23 PM
Updated October 24, 2024 at 5:18 PM
Resolved October 21, 2024 at 7:24 PM