DoSomethingArchive / quicksilver-api

:postbox: API gateway to Quicksilver (Message Broker) functionality.
MIT License
0 stars 3 forks source link

Extends campaign.signup.transactional doc with optional params. #16

Closed sergiitk closed 8 years ago

sergiitk commented 8 years ago

Adds optional overrides for MailChimp and MobileCommons.

deezone commented 8 years ago

Do you think there's a better way to note the need for one of a list of required parameters?

  /* Required: user_id or email or mobile. Northstar user ID. Example: "555b9225bffebc31068b4567". */
  user_id: String,

  /* Required: user_id or email or mobile. */
  email: String,

  /* Required: user_id or email or mobile. */
  mobile: String,

This seems a little vague. If the user doesn't notice the "or" in the comments it appears all three are required. Perhaps:

  /* Required: One of user_id or email or mobile.
     Examples: 
       - email: example@example.org

         Northstar user ID:
       - user_id: "555b9225bffebc31068b4567"

         mobile number that can include formatting, ex: 1 (123) 456-7890 and country code
       - mobile: "1234567890"
*/
  user_id: String,
  OR
  email: String,
  OR
  mobile: String,
sergiitk commented 8 years ago

I think the way we do it now is already clear enough.

deezone commented 8 years ago

:+1: