How can I denote decimal floating point in swagger specs?

Question

I would like to denote decimal with 2 places and decimal with 1 place in my api documentation. I'm using swagger 2.0, Is there inbuilt defined type or any other 'round' parameter in the specs, or my only option is to use 'x-' extension?

Helen · Accepted Answer · 2019-06-11T20:09:23.210

31

OpenAPI (fka Swagger) Specification uses a subset of JSON Schema to describe the data types.

If the parameter is passed as a number, you can try using multipleOf as suggested in this Q&A:

type: number
multipleOf: 0.1     # up to 1 decimal place,  e.g. 4.2
# multipleOf: 0.01  # up to 2 decimal places, e.g. 4.25

Hovewer, multipleOf validation against floating-point numbers can be unreliable due to floating-point math specifics.

If your number if passed as a string, you can specify a regex pattern for the desired number format:

type: string
pattern: your_regex

In any case, you can also document any restrictions verbally in the description.

edited Jun 11 '19 at 20:09

answered Jul 07 '17 at 11:08

Helen

87,344
17
243
314

1

in java, `type: number` will convert to `BigDecimal` – Hariom Yadav Mar 25 '22 at 13:32
@Hariom Yadav , which Java library are you referring to? – John Vandenberg Feb 14 '23 at 04:29

How can I denote decimal floating point in swagger specs?

1 Answers1

Linked