Skip to content

Latest commit

 

History

History
566 lines (311 loc) · 13.7 KB

api.rst

File metadata and controls

566 lines (311 loc) · 13.7 KB
Raw

API Definition

ramlfications

Main functions

The following three functions are meant for you to use primarily when parsing a RAML file/string.

parse

load

loads

validate

Core

Note

The following documentation is meant for understanding the underlying ramlfications API. No need to interact directly with the modules, classes, & functions below.

parser

ramlfications.parser.parse_raml

ramlfications.parser.create_root

ramlfications.parser.create_traits

ramlfications.parser.create_resource_types

ramlfications.parser.create_resources

ramlfications.parser.create_node

raml

Note

:py.TraitNode, :py.ResourceTypeNode, and :py.ResourceNode all inherit the following :py.BaseNode attributes:

Parameters

Note

The :py.URIParameter, :py.QueryParameter, :py.FormParameter, and :py.Header objects all share the same attributes.

ramlfications.parameters.Content

Loader

ramlfications.loader

ramlfications.loader.RAMLLoader

Validate

Functions are used when instantiating the classes from ramlfications.raml.

ramlfications.validate

Tree

ramlfications.tree