net.atview.project

atview.net

Documentation

Reference to a project. Identified by a handle and enriched with optional human-friendly metadata, links and visuals.

main record

Reference to a project. Identified by a handle and enriched with optional human-friendly metadata, links and visuals.

Record Key tid Timestamp-based ID

Properties

avatar blob Optional

Avatar image representing the project. Less than 1MB in size.

maxSize: 1.0 MB
banner blob Optional

Banner image used as the project's cover. Less than 1MB in size.

maxSize: 1.0 MB
createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

Short description of the project.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
displayName string Required

Display name of the project as shown in user interfaces.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes
docs string uri Optional

URL of the project's documentation.

github string uri Optional

URL of the project's GitHub repository.

handle string handle Required

Canonical handle identifying the project (e.g. `myproject.example.com`).

href string uri Optional

Primary external URL for the project (e.g. project homepage).

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "createdAt",
      "handle",
      "displayName"
    ],
    "properties": {
      "docs": {
        "type": "string",
        "format": "uri",
        "description": "URL of the project's documentation."
      },
      "href": {
        "type": "string",
        "format": "uri",
        "description": "Primary external URL for the project (e.g. project homepage)."
      },
      "avatar": {
        "type": "blob",
        "accept": [
          "image/*"
        ],
        "maxSize": 1000000,
        "description": "Avatar image representing the project. Less than 1MB in size."
      },
      "banner": {
        "type": "blob",
        "accept": [
          "image/*"
        ],
        "maxSize": 1000000,
        "description": "Banner image used as the project's cover. Less than 1MB in size."
      },
      "github": {
        "type": "string",
        "format": "uri",
        "description": "URL of the project's GitHub repository."
      },
      "handle": {
        "type": "string",
        "format": "handle",
        "description": "Canonical handle identifying the project (e.g. `myproject.example.com`)."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "description": {
        "type": "string",
        "maxLength": 10000,
        "description": "Short description of the project.",
        "maxGraphemes": 1000
      },
      "displayName": {
        "type": "string",
        "maxLength": 1000,
        "description": "Display name of the project as shown in user interfaces.",
        "maxGraphemes": 100
      }
    }
  },
  "description": "Reference to a project. Identified by a handle and enriched with optional human-friendly metadata, links and visuals."
}

Lexicon Garden

@