feat: display `multipleOf` constrains #1065

nanov · 2019-10-12T14:13:54Z

src/utils/__tests__/openapi.test.ts

nanov · 2019-10-13T04:30:44Z

Typo is fixed, to the new tests as well as to the non-empty test.

RomanHotsiy · 2019-10-16T13:01:17Z

src/utils/openapi.ts

+  if (!/^0\.0*1$/.test(strigifiedMultipleOf)) {
+    return `multiple of ${multipleOf}`;
+  }
+  return `decimals <= ${strigifiedMultipleOf.split('.')[1].length} digits`;


@nanov @adamaltman What do you think if we change it to n decimals max instead of decimals <= n?

Well, I have nothing against it.

The only thing i might thing of is that we may provide those hardcoded strings as configurations options to allow internationalisation.

having this in mind having strings as decimals <= {{x}} are some how easier to manage, translation wise speaking without introduction of (simple) templating system or a i18n solution.

These are both wrong actually. I'm glad that you brought it up.

Decimals is the concept. Decimal, from the dictionary:

a fraction whose denominator is a power of ten and whose numerator is expressed by figures placed to the right of a decimal point.

What we're talking about here specifically is called decimal places.

So it should be like this:

decimal places <= n

n decimal places max

However, in the second phrase, n decimal places max the places must turn singular if n == 1.

If we decide to go with the second option we could go with the good old:

n decimal place(s) max

As some languages have also a double form ( ie. singular, double, and plural ) i think it is better to use simpler descriptions in order to make internationalization simpler, with minimal overhead when the time comes.

I've taken your first suggestion and implemented it, I took the time to see how much effort would it be to implement mini translating system, and it seems as a straight forward task ( can work similar to the theme option ) and for our use case it can be done with zero-dependencies.

The question here is should i implement it here, or do a new PR for it?

nanov · 2019-10-23T11:07:57Z

Can we somehow proceed with this, rather simple, PR?

I would like to (try) and implement a internationalisation system, but as this PR is tightly connected to it I would prefer it gets merged first.

nanov · 2019-12-04T09:56:50Z

Any updates on this one?

RomanHotsiy · 2019-12-08T09:54:20Z

@nanov thanks a lot and sorry for the delay.

* feat(cli): added support for JSON string value for --options CLI argument (Redocly#1047) closes Redocly#797 * docs: expandDefaultServerVariables * fix: do not crash on empty scopes fixes Redocly#1044 * fix: auth section appears twice fixes Redocly#818 * fix: left menu item before group is not highligted fixes Redocly#1033 * fix: clicking on group title breaks first tag fixes Redocly#1034 * fix: false-positive recursive detection with allOf at the same level * fix: remove excessive whitespace between md sections on small screens fixes Redocly#874 * chore: Release 2.0.0-rc.15 🔖 * chore(cli): redoc-cli v0.9.0 * chore(cli): update yarn.lock * chore(cli): redoc-cli@0.9.1 * fix: fix scrollYOffset when SSR * chore: Release 2.0.0-rc.16 🔖 * chore(cli): redoc-cli@0.9.2 * docs: fix typo (Redocly#1062) * feat: added support for file paths as --options cli argument (Redocly#1049) * fix: types over-pluralization (Redocly#1057) fixes Redocly#1053 * docs: improve options documentation (Redocly#1071) * Sort by name * Document `hideSingleRequestSampleTab` * End option description with `.` * fix: no quotes for default values in header fields. (Redocly#1059) * fix: changed several components style font-family to monospace (Redocly#1063) fixes Redocly#909 * fix: active menu item scroll into view * chore: Release 2.0.0-rc.17 🔖 * fix: improve mime-type dropdown font * fix: add oneOf buttons vertical space when wrapped to new line * hore: Release 2.0.0-rc.18 🔖 * fix: wrap json examples in code tag (Redocly#1064) * feat: display `multipleOf` constrains (Redocly#1065) * docs: fix link to x-nullable docs from README (Redocly#1135) * fix: change the title of "Security Scheme Type" to match "HTTP Authorization Scheme" (Redocly#1126) * docs: fixed example slack api url (Redocly#1077) * doc: fix some typos (Redocly#1117) * feat(cli): Fallback on the spec's title before falling back on… (Redocly#1073) * fix: do not URI-encode parameter values for better readability fixes Redocly#1138 * chore: upgrade deps * feat: enable menuToggle by default * chore: remove react-hot-loader from deps fixes Redocly#1133 * fix: support discriminator mapping 1-n fixes Redocly#1111 * fix: remove hardcoded fontFamily for oneOf labels fixes Redocly#1120 * fix: h2 padding on mobile fixes Redocly#1118 * fix: python comment stripped in headings fixes Redocly#1116 * feat: new option hideSchemaTitles * fix: remove implicit discriminator mapping when explicit is present * chore: refactor request samples * feat: new option payloadSampleIdx * fix: search-box use theme * fix: fix sortByRequired (stabilise sort) (Redocly#1136) fixes Redocly#1104 fixes Redocly#1121 fixes Redocly#1061 * chore: Release 2.0.0-rc.19 🔖 * chore: update npm token for travis deploy * chore(cli): redoc-cli@0.9.3 * fix: fix missing parameters fixes Redocly#1142 * chore: Release 2.0.0-rc.20 🔖 * chore(cli): redoc-cli@0.9.4 * fix: use mobile menu background color value from theme (Redocly#1144) * chore(cli): Lint and prettify cli/index.ts (Redocly#1074) * fix: fix duplicated content in tags when using md headings fixes Redocly#1150, fixes Redocly#1152 * fix: empty servers behaviour per OAS spec fixes Redocly#1151 * chore: fix travis export vars * tests: fix tests for empty servers * chore: Release 2.0.0-rc.21 🔖 * chore(cli): upgrade handlebars in yarn.lock * chore(cli): update redoc * chore(cli): redoc-cli@0.9.5 * feat: add HTTP syntax highlighting (Redocly#1157) * fix: do not process oneOf if inherited from parent with discriminator * chore: minor perf optimizations * chore: Release 2.0.0-rc.22 🔖 * fix: fix broken sticky sidebar in Chrome 80 fixes Redocly#1167 * chore: Release 2.0.0-rc.23 🔖 * chore(cli): redoc-cli@0.9.6 Co-authored-by: Sergey Dubovyk <knidarkness@gmail.com> Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com> Co-authored-by: Anastasiya Mashoshyna <a.mashoshyna@gmail.com> Co-authored-by: Michael Huynh <43751307+miqh@users.noreply.github.com> Co-authored-by: Alex <alexgmin@gmail.com> Co-authored-by: russellrobinson <russellrobinson@users.noreply.github.com> Co-authored-by: Andrew Zhukevych <34597767+Hollister009@users.noreply.github.com> Co-authored-by: Andrii Tykhan <andriytixan@gmail.com> Co-authored-by: Dimitar Nanov <mitko.n@gmail.com> Co-authored-by: bwjohnson-ss <41123899+bwjohnson-ss@users.noreply.github.com> Co-authored-by: torbenw <torbenw@users.noreply.github.com> Co-authored-by: Chris Faulkner <thefaulkner@gmail.com> Co-authored-by: Zakary Kamal Ismail <zakary.kamal.fs@outlook.com> Co-authored-by: Nan Yan <625518543@qq.com> Co-authored-by: Anna Stasiuk <stasiukanya@gmail.com> Co-authored-by: Kryštof Korb <krystof@korb.cz>

nanov added 4 commits October 12, 2019 17:10

feat: visualise 'multipleOf' property

689fe64

add 'multipleOf' to honeyPerDay

b9b07cd

write tests for 'multipleOf' constrain

2855fca

refactor contrats check

383a41d

adamaltman reviewed Oct 12, 2019

View reviewed changes

src/utils/__tests__/openapi.test.ts Outdated Show resolved Hide resolved

adamaltman reviewed Oct 12, 2019

View reviewed changes

src/utils/__tests__/openapi.test.ts Outdated Show resolved Hide resolved

fix typo in tests dscriptions

d761b8f

RomanHotsiy reviewed Oct 16, 2019

View reviewed changes

nanov added 2 commits October 21, 2019 10:29

change decimal places description

b83a972

remove 'digits' from description

eadf65f

RomanHotsiy merged commit 3e90133 into Redocly:master Dec 8, 2019

rafalolszewski94 mentioned this pull request Feb 11, 2020

Bumped redoc version to 2.0.0-rc.23 axnsan12/drf-yasg#543

Closed

gui-camargo mentioned this pull request Feb 9, 2022

Atributos latitude e longitude: documentação conflita com a especificação de precisão Abrasel-Nacional/docs#85

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: display `multipleOf` constrains #1065

feat: display `multipleOf` constrains #1065

nanov commented Oct 12, 2019

nanov commented Oct 13, 2019

RomanHotsiy Oct 16, 2019

nanov Oct 17, 2019

nanov Oct 17, 2019

adamaltman Oct 17, 2019

nanov Oct 18, 2019

nanov Oct 21, 2019

nanov commented Oct 23, 2019 •

edited

Loading

nanov commented Dec 4, 2019

RomanHotsiy commented Dec 8, 2019 •

edited

Loading

feat: display multipleOf constrains #1065

feat: display multipleOf constrains #1065

Conversation

nanov commented Oct 12, 2019

nanov commented Oct 13, 2019

RomanHotsiy Oct 16, 2019

Choose a reason for hiding this comment

nanov Oct 17, 2019

Choose a reason for hiding this comment

nanov Oct 17, 2019

Choose a reason for hiding this comment

adamaltman Oct 17, 2019

Choose a reason for hiding this comment

nanov Oct 18, 2019

Choose a reason for hiding this comment

nanov Oct 21, 2019

Choose a reason for hiding this comment

nanov commented Oct 23, 2019 • edited Loading

nanov commented Dec 4, 2019

RomanHotsiy commented Dec 8, 2019 • edited Loading

feat: display `multipleOf` constrains #1065

feat: display `multipleOf` constrains #1065

nanov commented Oct 23, 2019 •

edited

Loading

RomanHotsiy commented Dec 8, 2019 •

edited

Loading