Skip to content

Commit

Permalink
Allow NetworkCollection to list any NetJSON object #8
Browse files Browse the repository at this point in the history
closes #8
  • Loading branch information
nemesifier committed Jun 27, 2015
1 parent 9b5313d commit 417179b
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.rst
Expand Up @@ -225,15 +225,18 @@ Each ``link`` object may also define a ``properties`` object to store additional
Network Collection
==================

**Definition**: a collection of ``NetworkGraph`` and / or ``NetworkRoutes`` object.
**Definition**: a collection of NetJSON objects.

**Goals**: allow listing different groups of topologies or routes, eg: multiple routing protocols running on the same device, a multitopology capable routing protocol
**Goals**: allow to list various netjson objects into a coherent group, eg:
* list graphs of different routing protocols running on the same device
* list all the routes of a multitopology capable routing protocol
* list devices of a network

**Example**: `network-collection.json <https://github.com/interop-dev/netjson/blob/master/examples/network-collection.json>`__

A ``Network Collection`` object must have a member with the name ``type`` and value ``NetworkCollection``.

It must define a ``collection`` member, which is a list of ``NetworkGraph`` and / or ``NetworkRoutes`` objects.
It must define a ``collection`` member, which can be any of the previously defined NetJSON objects.

Implementations
===============
Expand Down

0 comments on commit 417179b

Please sign in to comment.