def test_field_description_and_default():
parameter = build_parameter(TestSchema().fields["foo"])
assert_that(parameter, is_(equal_to({
"type": "string",
"description": "Foo",
"default": "bar",
})))
def test_field_array():
parameter = build_parameter(TestSchema().fields["names"])
assert_that(parameter, is_(equal_to({
"type": "array",
"items": {
"type": "string",
}
})))
def test_field_enum():
parameter = build_parameter(TestSchema().fields["choice"])
assert_that(parameter, is_(equal_to({
"type": "string",
"enum": [
"Profit",
],
})))
def test_field_int_enum():
parameter = build_parameter(TestSchema().fields["value"])
assert_that(parameter, is_(equal_to({
"type": "integer",
"enum": [
1,
2
],
})))
def query_param(name, field, required=False):
"""
Build a query parameter definition.
"""
parameter = build_parameter(field)
parameter["name"] = name
parameter["in"] = "query"
parameter["required"] = False
return swagger.QueryParameterSubSchema(**parameter)
def test_field_format():
parameter = build_parameter(TestSchema().fields["id"])
assert_that(parameter, is_(equal_to({
"type": "string",
"format": "uuid",
})))
def test_field_nested():
parameter = build_parameter(TestSchema().fields["ref"])
assert_that(parameter, is_(equal_to({
"$ref": "#/definitions/NewPerson",
})))
def test_field_decimal_as_string():
parameter = build_parameter(TestSchema().fields["decimalString"])
assert_that(parameter, is_(equal_to({
"type": "string",
"format": "decimal",
})))
def test_field_dict():
parameter = build_parameter(TestSchema().fields["payload"])
assert_that(parameter, is_(equal_to({
"type": "object",
})))
def test_field_decimal():
parameter = build_parameter(TestSchema().fields["decimal"])
assert_that(parameter, is_(equal_to({
"type": "number",
})))
def test_field_one_of():
parameter = build_parameter(TestSchema().fields["mixed"])
assert_that(parameter, is_(equal_to({
})))
def test_field_iso_timestamp():
parameter = build_parameter(TestSchema().fields["iso_timestamp"])
assert_that(parameter, is_(equal_to({
"type": "string",
"format": "date-time",
})))
def test_field_unix_timestamp():
parameter = build_parameter(TestSchema().fields["unix_timestamp"])
assert_that(parameter, is_(equal_to({
"type": "float",
"format": "timestamp",
})))
def test_field_decorated_method():
parameter = build_parameter(TestSchema().fields["decorated"])
assert_that(parameter, is_(equal_to({
# NB: default for `fields.Method` is "object"
"type": "string",
})))
