aglio icon indicating copy to clipboard operation
aglio copied to clipboard

<enumeration description n> not display

Open jk2K opened this issue 8 years ago • 3 comments

My doc

## get sms code [POST /common/sms]

+ Request (application/json)

    + Attributes
        + type: `sign_in` (enum[string], required) - for the purposes of identity verification code
            + Members
                + `sign_in` - login
                + `sign_up` - sign up
                + `lost_password` - retrieve password
        + mobile: 13266668888 (string, required) - send verification code to the mobile

generated JSON Schema

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "signin",
        "signup",
        "lost_password"
      ],
      "description": "for the purposes of identity verification code"
    },
    "mobile": {
      "type": "string",
      "description": "send verification code to the mobile"
    }
  },
  "required": [
    "type",
    "mobile"
  ],
  "$schema": "http://json-schema.org/draft-04/schema#"
}

Reference: URI parameters section

Why not show enumeration description?

jk2K avatar Jul 31 '15 02:07 jk2K

@jk2K thanks for reporting this issue. Currently, apiaryio/drafter.js is the tool used to generate JSON Schema from MSON attributes in a blueprint (through a library called apiaryio/boutique.js). This will soon be changing to the C++ implementation of apiaryio/drafter, and I'm hoping it will include this feature.

On a related note, Aglio does not yet display MSON attribute information, just the generated JSON and JSON Schema. In the near future I plan on displaying that information in a table/list as well.

danielgtaylor avatar Jul 31 '15 07:07 danielgtaylor

Thanks a lot

jk2K avatar Jul 31 '15 08:07 jk2K

Any news on this?

countless-integers avatar Jun 15 '16 10:06 countless-integers