danielgtaylor / aglio

An API Blueprint renderer with theme support that outputs static HTML
4.75k stars 480 forks source link

Path variables not showing up in the generated output #327

Closed maingi4 closed 7 years ago

maingi4 commented 7 years ago

Posted this is in stackoverflow @ http://stackoverflow.com/questions/43084514/aglio-api-blueprint-path-variables-not-showing-up

I have an API blueprint which goes something like this:

## Organization Users [/organizations/{id}/Users]

         + Parameters

            + id (string, required) - path variable, id of the organization.

some text was here.

### Get Org Users [GET]

some text was here.

+ Request (application/json)

When I run Aglio with something akin to:

aglio --theme-variables streak  -i AppServices/Organizations.apib -o Build/AppServices.html

I get the output like: No path variable

Notice that the path variables are simply not present.

Other facts:

  1. No warning is shown by aglio while generating the output
  2. The API blueprint validates fine.
  3. I tried all the themes aglio has to offer, same result.
maingi4 commented 7 years ago

anybody? @danielgtaylor ?

kylef commented 7 years ago

@maingi4 The parameters section is incorrectly intended and thus showing up as raw markdown description.

I think you want something like:

## Organization Users [/organizations/{id}/Users]

some text was here.

+ Parameters
    + id (string, required) - path variable, id of the organization.

### Get Org Users [GET]

some text was here.

+ Request (application/json)
maingi4 commented 7 years ago

that worked (and was embarrassing)! Thanks @kylef , great work with the tool btw.