tent.io/content/docs/profile.md
Jonathan Rudenberg 68ce1aeaff Add docs
2012-08-22 14:04:09 -04:00

2.1 KiB

title
Tent Profile

Tent Profile

This is where you define what version(s) of Tent you're using, what urls act as Tent API endpoints for your content, what licences you support, your entity name (can be any URI with a Tent-Server header, and any other information about you (e.g. Your real name, email, interest, etc.)

A very basic profile might look like this:

[
  {
    "type": {
      "url": "https://tent.io",
      "version": "0.2.0"
    },
    "licenses": [
      {
        "url": "https://tent.io/types/licenses/creative-commons",
        "version": "3.0.0"
      }
    ],
    "entity": "johnsmith.io",
    "servers": [
      "https://tent.johnsmith.io"
    ]
  }
]

The JSON is an array of objects complying with an info-type schema (See info types). You may have multiple objects of the same type in order to support multiple versions.

You could add support for another Tent version like this:

[
  {
    "type": {
      "url": "https://tent.io",
      "version": "0.2.0"
    },
    "licenses": [
      {
        "url": "https://tent.io/types/licenses/creative-commons",
        "version": "3.0.0"
      }
    ],
    "entity": "johnsmith.io",
    "servers": [
      "https://tent.johnsmith.io"
    ]
  },
  {
    "type": {
      "url": "https://tent.io",
      "version": "0.1.0"
    },
    "licenses": [
      {
        "url": "https://tent.io/types/licenses/creative-commons",
        "version": "3.0.0"
      }
    ],
    "entity": "johnsmith.io",
    "servers": [
      "https://tent.johnsmith.io"
    ]
  }
]

You could add your basic information:

[
  {
    "type": {
      "url": "https://tent.io",
      "version": "0.2.0"
    },
    "licenses": [
      {
        "url": "https://tent.io/types/licenses/creative-commons",
        "version": "3.0.0"
      }
    ],
    "entity": "johnsmith.io",
    "servers": [
      "https://tent.johnsmith.io"
    ]
  },
  {
    "type": {
      "url": "https://tent.io/types/info-types/basic-info",
      "version": "0.1.0"
    },
    "name": "John Smith",
    "age": 25
  }
]