Gitiles
Code Review Sign In
gerrit.opencord.org / composer / 1182ca818461e1f61909c49e233cfe743b321503
commit1182ca818461e1f61909c49e233cfe743b321503[log] [tgz]
authorPeter Lee <peter@corenova.com>Thu Jul 28 20:14:48 2016 -0700
committerPeter Lee <peter@corenova.com>Thu Jul 28 20:14:48 2016 -0700
tree5409338fa7bdf9f528d6bad4a2ce003f3bc43b2e
parent3a262ed86a8005d2ffb84d13cd23f07533824796 [diff]
updated documentation for main package README as well as schema Modeler's Guide
3 files changed
tree: 5409338fa7bdf9f528d6bad4a2ce003f3bc43b2e
  1. .gitignore
  2. LICENSE
  3. README.md
  4. package.json
  5. sample-data.json
  6. schema/
  7. src/
README.md

YANG model-driven CORD

This is a work-in-progress effort to create YANG data models for the CORD project and deliver flexible service compositions.

You may contact Larry Peterson llp@onlab.us and Peter Lee peter@corenova.com to learn more about this initiative and find out how you can help.

Installation

$ npm install yang-cord

Getting Started

Following the installation, you can start an instance of the YANG model-driven REST API web server. It utilizes yang-express middleware framework built on Express.js to provide dynamic YANG model-driven API routing capability.

$ npm start

> yang-cord@1.0.1 start /home/peter/yang-cord
> node lib/server.js

mounted 'cord-core' model
mounted 'xos-core' model
[cord-core] calling GET on /cord-core:subscriber

Reference Guides

  • API Overview - provides walkthrough on interacting with the REST API endpoints
  • Modeler's Guide - provides information on current YANG models for XOS and CORD and what's coming up next
  • Developer's Guide - provides technical detail on controller logic and dynamic interfaces and how to best leverage YANG model-driven developer tools for getting things done fast.

Tests

To run the test suite, first install the dependencies, then run npm test.

$ npm install
$ npm test

Mocha test suite is currently under development...

LICENSE

Apache 2.0