Skip to content

Parameter Validation

saary edited this page Apr 15, 2012 · 3 revisions

Validations should be included with every parameter requiring validation.

Example

{
  "parameters": {
    "email": {
      "description": "A valid email address",
      "validations": [
        {
          "type": "match",
          "challenge": "/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,6}$/"
        },
        {
          "type": "exclude",
          "challenge": ["example@example.com"]
        }
      ]
    }
  }
}

[saary]

{
  "params": {
    "email": {
      "doc": "A valid email address",
      "style": "query",
      "type": "string",
      "required": true
      "validations": [
        {
          "type": "match",
          "value": "/^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,6}$/"
        },
        {
          "type": "exclude",
          "value": ["example@example.com"]
        }
      ]
    }
  },
  "age": {
    "doc": "the user's age",
    "style": "query",
    "required": false,
    "validations": [
      { 
        "type": "numeric"
      },
      {
        "type": "range",
        "value": "20.."
      }
    ]
  }
}

Clone this wiki locally