social.nstar.actor.declaration

nstar.social

Documentation

A declaration of NorthStar Social account.

main record

A declaration of NorthStar Social account.

Record Key literal:self Fixed literal value

Properties

allowConnect string Required

Whom may request to connect.

Known values: none, all, following
createdAt string datetime Required

An RFC 3339 formatted timestamp.

View raw schema 
{
  "key": "literal:self",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "service",
      "allowConnect",
      "createdAt"
    ],
    "properties": {
      "service": {
        "type": "array",
        "items": {
          "ref": "lex:social.nstar.actor.declaration#service",
          "type": "ref"
        },
        "maxLength": 10
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "allowConnect": {
        "type": "string",
        "description": "Whom may request to connect.",
        "knownValues": [
          "none",
          "all",
          "following"
        ]
      }
    }
  },
  "description": "A declaration of NorthStar Social account."
}
service object

List of NorthStar Social services

Properties

id string Required

A unique identifier for the service -- a string conforming to the rules of [RFC3986] for URIs.

maxLength: 2000 bytesminLength: 1 bytes
serviceEndpoint string Required

The URI where the service can be accessed -- a string conforming to the rules of [RFC3986] for URIs.

maxLength: 2000 bytesminLength: 1 bytes
type string Required

The type of service being defined.

maxLength: 2000 bytesminLength: 1 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "id",
    "type",
    "serviceEndpoint"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "A unique identifier for the service -- a string conforming to the rules of [RFC3986] for URIs."
    },
    "type": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "The type of service being defined."
    },
    "serviceEndpoint": {
      "type": "string",
      "maxLength": 2000,
      "minLength": 1,
      "description": "The URI where the service can be accessed -- a string conforming to the rules of [RFC3986] for URIs."
    }
  },
  "description": "List of NorthStar Social services"
}

Lexicon Garden

@