Bring swagger model schema in line with json-schema spec

[swagger-api]

Bring swagger model schema in line with json-schema spec

[fehguy]

it is impossible to use json schema for this from my research. There isn't enough type information for much of swagger, so we're "loosely based" on a json-schema draft.

[paulhill]

where did it fall short?

On Thu, Jun 27, 2013 at 5:09 PM, Tony Tam [email protected] wrote:

it is impossible to use json schema for this from my research. There isn't
enough type information for much of swagger, so we're "loosely based" on a
json-schema draft.

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/61#issuecomment-20163418
.

[paulhill]

if(param.allowableValues) {
      var avs = param.allowableValues.toString();
      var type = avs.split('[')[0];
      if(type == 'LIST'){
        var values = avs.match(/\[(.*)\]/g).toString().replace('\[','').replace('\]', '').split(',');
        param.allowableValues = {valueType: type, values: values};
      }
      else if (type == 'RANGE') {
        var values = avs.match(/\[(.*)\]/g).toString().replace('\[','').replace('\]', '').split(',');
        param.allowableValues = {valueType: type, min: values[0], max: values[1]};
      }
    }

this code above, seems like it would be supported by the following json-schema attributes:

5.9. minimum

This attribute defines the minimum value of the instance property
when the type of the instance value is a number.

5.10. maximum

This attribute defines the maximum value of the instance property
when the type of the instance value is a number.

5.11. exclusiveMinimum

This attribute indicates if the value of the instance (if the
instance is a number) can not equal the number defined by the
"minimum" attribute. This is false by default, meaning the instance
value can be greater then or equal to the minimum value.

5.12. exclusiveMaximum

This attribute indicates if the value of the instance (if the
instance is a number) can not equal the number defined by the
"maximum" attribute. This is false by default, meaning the instance
value can be less then or equal to the maximum value.

5.19. enum

This provides an enumeration of all possible values that are valid
for the instance property. This MUST be an array, and each item in
the array represents a possible value for the instance value. If
this attribute is defined, the instance value MUST be one of the
values in the array in order for the schema to be valid. Comparison
of enum values uses the same algorithm as defined in "uniqueItems"
(Section 5.15).

[paulhill]

Moving to a more compliant model would also have the advantage of allowing you to plug in validation as easily as this:

var jsonSchema  = require('json-schema');
var report = jsonSchema.validate(input, schema);
if (!report.valid) {
        var validationErrors = report.errors;
    ...
}

[fehguy]

should be done in 2.0.0