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

only one example supported, but not multiple examples #8

Open
tkaefer opened this issue Jun 7, 2016 · 3 comments
Open

only one example supported, but not multiple examples #8

tkaefer opened this issue Jun 7, 2016 · 3 comments

Comments

@tkaefer
Copy link

tkaefer commented Jun 7, 2016

I think your documentation tool for RAML is currently the best one for RAML 1.0.

Unfortunately I came across one issue with examples::
Instead of providing just one example, I need to have more than one provided and RAML 1.0 gives to opportunity for that (see https://github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md#multiple-examples). But the html from ramlo just does not display anything when I use multiple examples.

Multiple examples (which does not show anything):

          examples:
            jsonAsset: !include examples/createBodyJsonAsset.json
            pngAsset: !include examples/createBodyPngFile.json

One example (which works):

            example: !include examples/listResponseBody.json

I am not sure if there is something wrong here in my Spec. Atom "API Workbench" doesn't complain at least.
Do you have any hints?

@kamilzasada
Copy link
Contributor

@tkaefer thanks for a comment. Currently this tool is under development and we are preparing to big release planned before 19. June. We will add support for multiple examples. We will try to cover all RAML 1.0 specification in Release Candidate version and we are open for ideas how to improve documentations.

@tkaefer
Copy link
Author

tkaefer commented Jun 8, 2016

@kamilzasada Thanks for the update. Is there a early-access-version of the code? I already started to work on this topic, but it seems (having the 19.6. in mind) you are more progressed. I'd love to contribute, either by testing or by coding.

@kamilzasada
Copy link
Contributor

@tkaefer Couple days ago I've merged into develop branch what guys did during last weeks. But there are still a lot of styling and testing. So if you wanted to look at it (and create pull request maybe ;)), feel free...but we still have a lot of work...

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

No branches or pull requests

2 participants