json-graph-specification

.. image:: https://travis-ci.org/jsongraph/json-graph-specification.svg?branch=master :target: https://travis-ci.org/jsongraph/json-graph-specification

A proposal for representing graph structures in JSON.

Design principles

• Use meaningful property names that reflect the semantic type of the value.
• Property names should not be excessively long.
• Property names should be plural when value is an array.
• Properties that allow a null value can be omitted.
• Define a JSON graph schema_ for content validation purposes.

.. _objects:

Objects

.. _node object:

node object

A node object represents a node in a graph.

node properties

• An id property is a primary key for an object (see Objects_) that is unique for the object type. Its value is defined as a JSON string for flexibility.
• A label property provides a text display for an object. Its value is defined as a JSON string.
• A type property provides a classification for an object. Its value is defined as a JSON string.
• A metadata property allows for custom data on an object. Its values is defined as a JSON object.

.. _edge object:

edge object

An edge object represents an edge in a graph.

edge properties

• A source property provides the id value of the source node object_. Its value is defined as a JSON string.
• A relation property provides the interaction between source and target nodes. Its value is defined as a JSON string.
• A target property provides the id value of the target node object_. Its value is defined as a JSON string.
• A directed property provides the edge mode (e.g. directed or undirected). Its value is JSON true for directed and JSON false for undirected. The edge direction is determined by graph.directed property if not present.
• A metadata property allows for custom data on an object. Its values is defined as a JSON object.

.. _graph object:

graph object

A graph object represents a single conceptual graph.

graph properties

• A type property provides a classification for an object. Its value is defined as a JSON string.
• A label property provides a text display for an object. Its value is defined as a JSON string.
• A directed property provides the graph mode (e.g. directed or undirected). Its value is JSON true for directed and JSON false for undirected. This property default to JSON true indicating a directed graph.
• A nodes property provides the nodes in the graph. Its value is an array of node object_.
• An edges property provides the edges in the graph. Its value is an array of edge object_.
• A metadata property allows for custom data on an object. Its values is defined as a JSON object.

.. _graphs object:

graphs object

A graphs object groups zero or more graph object_ into one JSON document.

• The graphs object_ is defined as a JSON array.

graphs properties

• A type property provides a classification for an object. Its value is defined as a JSON string.
• A label property provides a text display for an object. Its value is defined as a JSON string.
• A metadata property allows for custom data on an object. Its values is defined as a JSON object.

.. _examples:

Examples

.. _empty single graph:

empty single graph

.. code-block:: json

{
    "graph": {}
}

.. _empty multi graph:

empty multi graph

.. code-block:: json

{
    "graphs": []
}

.. _nodes-only single graph:

nodes-only single graph

.. code-block:: json

{
    "graph": {
        "nodes": [
            {
                "id": "A",
            },
            {
                "id": "B",
            }
        ]
    }
}

.. _nodes/edges single graph:

nodes/edges single graph

.. code-block:: json

{
    "graph": {
        "nodes": [
            {
                "id": "A",
            },
            {
                "id": "B",
            }
        ],
        "edges": [
            {
                "source": "A",
                "target": "B"
            }
        ]
    }
}

.. _complete single graph:

complete single graph

.. code-block:: json

{
    "graph": {
        "directed": false,
        "type": "graph type",
        "label": "graph label",
        "metadata": {
            "user-defined": "values"
        },
        "nodes": [
            {
                "id": "0",
                "type": "node type",
                "label": "node label(0)",
                "metadata": {
                    "user-defined": "values"
                }
            },
            {
                "id": "1",
                "type": "node type",
                "label": "node label(1)",
                "metadata": {
                    "user-defined": "values"
                }
            }
        ],
        "edges": [
            {
                "source": "0",
                "relation": "edge relationship",
                "target": "1",
                "directed": false,
                "label": "edge label",
                "metadata": {
                    "user-defined": "values"
                }
            }
        ]
    }
}

.. _complete multiple graph:

complete multi graph

.. code-block:: json

{
    "graphs": [
        {
            "directed": true,
            "type": "graph type",
            "label": "graph label",
            "metadata": {
                "user-defined": "values"
            },
            "nodes": [
                {
                    "id": "0",
                    "type": "node type",
                    "label": "node label(0)",
                    "metadata": {
                        "user-defined": "values"
                    }
                },
                {
                    "id": "1",
                    "type": "node type",
                    "label": "node label(1)",
                    "metadata": {
                        "user-defined": "values"
                    }
                }
            ],
            "edges": [
                {
                    "source": "0",
                    "relation": "edge relationship",
                    "target": "1",
                    "directed": true,
                    "label": "edge label",
                    "metadata": {
                        "user-defined": "values"
                    }
                }
            ]
        },
        {
            "directed": true,
            "type": "graph type",
            "label": "graph label",
            "metadata": {
                "user-defined": "values"
            },
            "nodes": [
                {
                    "id": "0",
                    "type": "node type",
                    "label": "node label(0)",
                    "metadata": {
                        "user-defined": "values"
                    }
                },
                {
                    "id": "1",
                    "type": "node type",
                    "label": "node label(1)",
                    "metadata": {
                        "user-defined": "values"
                    }
                }
            ],
            "edges": [
                {
                    "source": "1",
                    "relation": "edge relationship",
                    "target": "0",
                    "directed": true,
                    "label": "edge label",
                    "metadata": {
                        "user-defined": "values"
                    }
                }
            ]
        }
    ]
}

More real world examples_.

Schema

.. _schema:

The JSON graph schema_ (version 3) is provided for the json graph format.

Media Type

The media type to describe JSON Graph Format is application/vnd.jgf+json. The approach to use a media type suffix like +json is described by RFC 6839_.

In addition to the media type a profile media type parameter MUST be set to a URL that dereferences to the JSON schema for JSON Graph Format. The expected usage of the profile media type parameter is defined by RFC 6906_. For example to communicate plain JSON Graph Format content the Content-Type header could be set as:

.. code-block:: http

Content-Type: application/vnd.jgf+json

A child schema of JSON Graph Format can communicate its JSON schema using additional profile media type parameters. Each profile media type parameter MUST dereference a JSON schema. For example the BEL JSON Graph Format could be communicated as:

.. code-block:: http

Content-Type: application/vnd.jgf+json;
          profile=http://jsongraphformat.info/schema.json;
          profile=http://jsongraphformat.info/child-schemas/bel-json-graph.schema.json

NPM support

You can import the schema into your JS projects by installing it via NPM and requiring it.

.. code-block:: shell

npm install --save json-graph-specification

.. code-block:: javascript

var JSONGraph = require("json-graph-specification");

Project Tests

See TESTING_.

.. _links:

Links

• JSON schema_

.. _JSON graph schema: https://github.com/jsongraph/json-graph-specification/blob/master/json-graph-schema.json .. _JSON schema: http://json-schema.org .. _real world examples: https://github.com/jsongraph/json-graph-specification/tree/master/examples .. _TESTING: https://github.com/jsongraph/json-graph-specification/blob/master/TESTING.rst .. _RFC 6839: https://tools.ietf.org/html/rfc6839 .. _RFC 6906: https://tools.ietf.org/html/rfc6906