SDMP

specification

version 0.12

schema


node

Published information about a node, such as name and IP address.


Nodes are an application-level identity, authorized by a user to host or publish resources on behalf of the user. A node might be an application running on a server, or running on a phone. This resource contains the information necessary to connect two nodes together.


Description

Information about the node is not published in the identity resource, it is published in this object. Primarily, this object holds the IP and port used to connect to the node.

This object contains the following properties:

information (object)

Object containing information about the node.

information.type (string, required)

Must be the exact string: node

information.name (string, optional)

A human-readable description of the node.

information.ips (array of strings, required)

Each array element is a string representation of the IP address and port at which the node is reachable.

This address may be IPv4 or IPv6, and the port is required.


Schema

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "node": {
      "type": "object",
      "properties": {
        "name": { "type": "string" },
        "ips": {
          "type": "array",
          "items": { "type": "string" }
        }
      },
      "required": [ "name", "ips" ]
    }
  },
  "required": [ "node" ]
}