Open kamilzasada opened 8 years ago
i'm taking care of 'baseUriParameters'
added baseUriParameters below the Title, i'm not sure if it should be position there & the styling I guess must be improved
I'll check this: "Check if ramlo can be installed locally in a project's node_module directory."
Hi, wow this is awesome! Let me know if you need any help to understand couple of things or need something from the js parser. We can also bring you up on the projects page if you finished, and I am also planning to give you a shout on twitter. But obviously only if you want me too :)
Is there any updated list where you are etc.?
@sichvoge I've send you an email. Let's stay in touch :-)
General
ramlo --help
is complete.Code structure & layout
Basic Information
baseUri
has aversion
URI parameter, replace it and version should be presented as a part of API URI (optional).baseUriParameters
(optional).<span class="label">
(optional).uriParameters
used insidebaseUri
parameter (optional).Named Parameters
User Documentation
documentation
property at the beginning of the middle column documentation. Documentation can be written using Markdown. It can havetitle
andcontent
(optional).Resources
displayName
property or if not, it should be generated from resource's URI (required).description
property which can be used for describing resource. Description should be presented only in the middle section of documentation - below resource's name (optional).enum
parameter should be presented in the column with description (optional).Methods
description
which can be written in Markdown (optional).Methods' responses
schema
andexample
defined.Data Types
Traits
Resource Type
Security Schemas
RAML 1.0 Annotations