JSON format definition - Githubissues

wis3guy commented 7 years ago

Is the format of the JSON that is generated documented somewhere? Also, is the format specific to the API Console or a complete JSOn representation of the RAML document?

jarrodek commented 6 years ago

Hi,

Really sorry for late response. For some reason I had notifications turned off for this repo.

On a basic level this is JSON output from the RAML JavaScript parser. Then it is processed by my fork of the raml2obj library that makes output more consistent. Also, internally this library uses our expansion library to expand types.

I tried to document how the properties changes here:

https://github.com/advanced-rest-client/raml-json-enhance#affected-properties

The library that performs transformation is here: https://github.com/advanced-rest-client/raml2obj Though, it's not yet very well documented. This library (node module, but can be run in a browser) is used by all tools that generates JSON object for the console.

jarrodek commented 5 years ago

Closing as resolved

mulesoft-labs / api-console-cli

JSON format definition #2