Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

trailing curly-brace param disappears in markup #232

Open
nguyen-brian opened this issue Feb 5, 2016 · 4 comments
Open

trailing curly-brace param disappears in markup #232

nguyen-brian opened this issue Feb 5, 2016 · 4 comments

Comments

@nguyen-brian
Copy link

I have a section in my code that looks like this:

## Dog [/api/dogs/{dog_id}]

### Show dog [GET]

I was running a previous version of aglio (2.0.0-beta2), and it rendered fine.

screen shot 2016-02-04 at 6 19 39 pm

Upgrading to 2.0.2 makes the {dog_id} disappear.

screen shot 2016-02-04 at 6 19 40 pm

Am I doing something wrong here?

@nguyen-brian
Copy link
Author

Ok, I figured out a workaround to get the dog_id to show up again. I had to add the parameter into the Parameters section, like this:

## Dog [/api/dogs/{dog_id}]
+ Parameters
    + dog_id

### Show dog [GET]

Despite now having a workaround, I still would consider this a bug since according to the API blueprint specification for this section: "NOTE: This section should only contain parameters that are specified in the parent's resource URI template, and does not have to list every URI parameter."

@cjwilburn
Copy link

I'm also seeing this on version 2.1.1

@Astrac
Copy link

Astrac commented Apr 29, 2016

Same problem on version 2.2.0 and not just for the trailing parameters but also for the middle ones.

In the following:

### Article updates [/articles/{articleId}/updates/{updateNumber}]

This resource is used to perform updates on an article resource.

+ Parameters
  + articleId
  + updateNumber

The output markup will present the URI as /articles/updates.

@jackbentley
Copy link

You should really be specifying the parameters and their types/samples/etc anyway 😉 Aglio wont be able to generate a good example URL else!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants