mulesoft-labs / raml-object-to-raml Goto Github PK

Takes a RAML object in JavaScript, specifically having the same structure of the output of the RAML JavaScript parser, and emits properly-formatted RAML (text).

License: Other

JavaScript 100.00%

raml raml-tooling

raml-object-to-raml's Introduction

RAML Object To RAML

Takes a RAML object in JavaScript and emits properly-formatted RAML (text).

Installation

npm install raml-object-to-raml --save

Usage

CLI

Supports piping in JSON and printing the resulting RAML to stdout.

cat api.json | raml-object-to-raml > api.raml

JavaScript

The module can be required inside other projects for generating the RAML file directly from JavaScript objects.

var toRAML = require('raml-object-to-raml');

console.log(toRAML({ ... }));
// #%RAML 0.8
// title: Example API
// ...

License

Apache 2.0

raml-object-to-raml's People

Contributors

Stargazers

Watchers

Forkers

psotres eliasmamo

raml-object-to-raml's Issues

Add support for describedBy in securitySchemes as per RAML 0.8 SPEC

As per https://github.com/raml-org/raml-spec/blob/master/versions/raml-08/raml-08.md it should be possible to have describedBy section in security scheme with all the related headers, queryParams and responses.

is: [] not found in the *.raml file

Object:

resources: 
   [ { is: [Object],
       uriParameters: [Object],
       relativeUri: '/test/',
       methods: [Object],
       ...

In this case is: [blabla] will not appear in the *.raml file. Would you be so kind to fix it?

Cheers,

Luke

Inserting any kind of "!include" statemenets apear quoted

I am not sure if that's the issue or its meant to be so, but i need to make some include statements and they are quoted, like so:

example: "!include myTextFile.txt"

is there a standard way of avoiding that?

i found that inside stringify.js file there is a list of characters which flag string to be quoted if found inside and exclamation mark is one of those. So if i just comment out

QUOTED_CHARACTERS[0x21] = true;

then it parses include statement without quotes.

Thanks in advance

Addin Trait to method passing the parameters

I am trying to add an "is" statement with reference to a trait and pass parameters. Currently have no reference how to do that, the best result i was able to get is:

get:
    is:
      - 2222:
          VarName1: varParam1
          VarName2: varParam2

in RAML docs it should look like

get:
    is: [ 2222: { VarName1: varParam1,  VarName2: varParam2} ]

i didn't find any tests for this functionality, there is only one test where trait is simply referenced by name.

if (is.string(resource.description) || is.object(resource.description)) {
  child.description = resource.description;
}

Thanks!