parametersargumentsapiblueprintapiary.ioapiary

Apiary: Is there a way to define options for parameters?


I would like to define options for Apiary parameters, I'm currently listing them in the description:


Solution

  • You can enumerate the possible values of an URI query parameter and discuss it in the parameter discussion like so:

    + Parameters
        + measurement = `m` (optional, string) ... measurement units
    
            Any discussion here...
    
            e.g. explanation of **values** listed bellow are.
    
            + Values
                + `m`
                + `mi`
                + `yd`
    

    Also see the Documenting query parameters with API Blueprint question.