riboseinc / ribose-api

API for Ribose
0 stars 0 forks source link

No value specified validation errors #35

Closed skalee closed 6 years ago

skalee commented 6 years ago

Validator says:

 warning code 6 in line 2667 - no value(s) specified:
    `body`:  (string) - Body of invitation message to the invitees
  warning code 6 in line 2705 - no value(s) specified:
    `s`:  (string) - pagination synchronization string
  warning code 6 in line 2800 - no value(s) specified:
    `s`:  (string) - pagination synchronization string
  warning code 6 in line 2843 - no value(s) specified:
    `body`:  (string) - Body of invitation message to the invitees
  warning code 6 in line 2941 - no value(s) specified:
    `s`:  (string) - pagination synchronization string
  warning code 6 in line 3067 - no value(s) specified:
    `s`:  (string) - pagination synchronization string

According to @ribose-jeffreylau, he had problems with representing empty strings in APIB: https://github.com/riboseinc/ribose-api/pull/34#issuecomment-343020319.

But why not:

+ `s`: `""` (string) - pagination synchronization string

or

+ `s` (string) - pagination synchronization string

instead of:

+ `s`:  (string) - pagination synchronization string

Both do pass in my validator.

ribose-jeffreylau commented 6 years ago

Actually @skalee you're right.

My intention was to make Apiary's console give me a default empty string for the s parameter (and also body in another request). I might not have tried the simplest case of:

+ `s` (string) - pagination synchronization string

which does exactly what we need.