Skip to content
This repository has been archived by the owner on May 10, 2024. It is now read-only.

Give support for RAML 1.0 #369

Closed
rvegas opened this issue Nov 5, 2015 · 28 comments
Closed

Give support for RAML 1.0 #369

rvegas opened this issue Nov 5, 2015 · 28 comments

Comments

@rvegas
Copy link

rvegas commented Nov 5, 2015

Is there a milestone in the roadmap to support RAML 1.0?
Types and Examples are key improvements that would be very nice to have.

@dmartinezg
Copy link
Contributor

Hi @rvegas, we are currently spiking to calculate the effort needed, but I can assure you, we will be updating both, designer and console.

thanks

@tvervest
Copy link

tvervest commented Nov 7, 2015

+1 looking forward to 1.0 support 👍

@YvanDaSilva
Copy link

That would be really sweet.
Also to have a proper documentation & manual testing generation like raml2html, sadly the developer has no time to pursue his projects based on raml.

@h4t0n
Copy link

h4t0n commented Nov 13, 2015

+1 👍

@sichvoge
Copy link
Contributor

@YvanDaSilva Can you confirm, you want to have an option inside the designer to generate documentation such as raml2html?

@YvanDaSilva
Copy link

Well there is two ways to do this:

  • use an external product like "raml2html" that does extrac documentation from a RAML
  • directly be able to build & extract html documentation (preferably with testing integrated like the designer is able to do) from the designer.

@sichvoge
Copy link
Contributor

We could integrate with the PHP project for raml2html - https://github.com/mikestowe/php-raml2html. That is still in maintenance.

@davidmoss
Copy link

+1 👍

@sichvoge
Copy link
Contributor

I created a new issue for the documentation generation integration. #372

@dvic
Copy link

dvic commented Dec 2, 2015

Can you give an ball park estimate when 1.0 will be supported? Are there currently any other tools available that can generate docs for a 1.0 spec?

On a side note: I'm just starting out with RAML. After reading the 1.0 spec and playing with it in Atom, I noticed a few mistakes in the examples, probably outdated syntax; I will report these in another issue.

@sichvoge
Copy link
Contributor

sichvoge commented Dec 2, 2015

@DamirV are those mistakes on the RAML.org website?

Regarding any estimated date for the support, you might have seen that RAML 1.0 is in (RC) stage and there will be some changes to the spec based on couple of feedback from the community. We are currently testing the parsers by integrating them into the api-console. We will have an MVP soon, but plan to have the full tested support by late 2016Q1.

Regarding other tools, its the same state I guess - most tooling vendors are testing the current parsers and give a lot feedback. These parsers are completely new and rewritten from scratch to support 0.8 and 1.0.

@nash-ye
Copy link

nash-ye commented Feb 12, 2016

1+, I hope to see more support for RAML 1.0 very soon. :)

@stevenpollack
Copy link

+1 -- API Designer has one killer feature that Atom clearly does not: mocks. It'd be sweet if we could get RAML 1.0 support.

@sichvoge
Copy link
Contributor

Its in development; the first part here is the API Console that is embedded here in the designer. You already find couple of commits around the RAML 1.0 support in the console branch.

@neilhosey
Copy link

Was this ever released? Im really looking forward to a good RAML 1 editor.

I

@sichvoge
Copy link
Contributor

sichvoge commented Jun 4, 2016

It was indeed. The current master contains support for RAML 1.0 as well.

@beno
Copy link

beno commented Jun 7, 2016

Current master still reports 'Unsupported RAML version'.

I am a bit puzzled about the overall state of RAML 1.0 adoption. Lots of 'almost there' seemingly.

@sichvoge
Copy link
Contributor

sichvoge commented Jun 8, 2016

The spec has been closed 2 weeks ago. Obviously we need to give people the time in between needed to update their tools.

With regards to the master. I have it running fine locally.

image

What did you execute to run it? Maybe I can help to get you started.

@beno
Copy link

beno commented Jun 8, 2016

Hi, I think I may have been looking at the previous stable version earlier, but when I try to run the current master, the browser loads the api-designer javascript files and then errors out with

api-designer.js:9408 Uncaught ReferenceError: angular is not defined

@sichvoge
Copy link
Contributor

sichvoge commented Jun 8, 2016

Have you tried the following:

git clone https://github.com/mulesoft/api-designer.git
cd api-designer
npm install
bower install
grunt server

?

@beno
Copy link

beno commented Jun 8, 2016

Thanks for the help, we are getting closer, but still no cigar. I missed the bower and grunt steps, and I have done them now after a fresh reinstall. The application loads, but now gives me an 'undefined' error message, regardless of version specification.

screen shot 2016-06-08 at 12 19 48

screen shot 2016-06-08 at 12 20 04

@beno
Copy link

beno commented Jun 8, 2016

Succes! The error seemed to stem from unuploaded includes from the other RAML file. So I guess the issues here are

  • the error 'bleeds' from one API spec to the next
  • the error is not specific

But other than that, I can now work on 1.0! Yay! Thanks for your help.

@shadowhand
Copy link

There are still a number of errors present when pasting the example file from http://raml.org/developers/whats-new-raml-10 into API Designer.

@sichvoge
Copy link
Contributor

Which one in particular?

@sichvoge
Copy link
Contributor

@shadowhand its a mistake in how the example gets rendered on the webpage. I already raised an issue here.

@shadowhand
Copy link

@sichvoge thanks, that helps immensely!

@sichvoge
Copy link
Contributor

No problem. Hope to get that fixed soon.

@sichvoge
Copy link
Contributor

BTW, I am closing this issue as the current master supports 1.0. If there are any problems with that please file a new issue.

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

No branches or pull requests