api-console Allow seeing the RAML spec

It would be great to have the option to display the RAML spec currently loaded by the console. If this view could be nicely formatted and syntax coloured, it would be even better :wink:

Mar 10 '15 16:03 ddossot

Yes, this was actually in the plan from day 1 of the original console and designer, in the form of a readonly designer that slides out of the side of the console as a "shelf". We've not yet implemented it, though we have prototyped something similar. But we have not forgotten and it will happen at some point... ;-)

Mar 11 '15 06:03 usarid

+1 and additionally an option to propagate the RAML files to download it via the API Console

Mar 31 '15 06:03 sichvoge

+1 including the previous comment.

Apr 21 '15 12:04 MMore

+1

Mar 14 '16 21:03 robvanmieghem

+1

Mar 31 '16 13:03 tjsnell

I'm not convinced to the idea of having RAML source display / download option.

It might be OK for standalone API Console. But the console is also used in other products (like the designer) that may have some visual element for the RAML content. In this case it would be confusing for the user why this option is enabled.

As for Console v4 it doesn't even know anything about RAML because it accepts JavaScript object from parser and the enhancer. There's another problem of resolving the dependencies of RAML (fragments). It can be resolved from various sources (local or remote path). Is console should do this as well? That would be quite complex function in the console.

Jul 04 '17 21:07 jarrodek

The Console needs to have an option to download the source RAML file(s), which are the same ones the parser is given. It can be disabled by an embedder if needed. The Console is, in terms of packaging, responsible for accepting a RAML file(s) and doing what's needed to create itself, including invoking the parser. In any case, allowing the end user to access the source spec is necessary, as that's the source of truth, and we want to make sure spec-oriented approaches are promoted.

Jul 04 '17 21:07 usarid

I hear you and I understand the use case. Option to disable viewer is OK. Though, I see few technical challenges to actually do it right. I have to plan this.

Jul 04 '17 21:07 jarrodek

I'll have a backlog item for this.

Jul 05 '17 15:07 sichvoge

When can we get a date for delivery?

Jul 05 '17 15:07 usarid

We meet tomorrow to discuss the scope for the next releases and after that Pawel will look into the dates. Please bear with us.

Jul 05 '17 16:07 sichvoge