# net.atview.project

> Published by [atview.net](https://lexicon.garden/identity/did:plc:ycd3zyxa6iru5fiplr3un6nr)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:ycd3zyxa6iru5fiplr3un6nr/net.atview.project)
- [Documentation](https://lexicon.garden/lexicon/did:plc:ycd3zyxa6iru5fiplr3un6nr/net.atview.project/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:ycd3zyxa6iru5fiplr3un6nr/net.atview.project/examples)

## Definitions

### `net.atview.project`

**Type**: `record`

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

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `docs` | `string` (uri) | No | URL of the project's documentation. |
| `href` | `string` (uri) | No | Primary external URL for the project (e.g. project homepage). |
| `avatar` | `blob` | No | Avatar image representing the project. Less than 1MB in size. |
| `banner` | `blob` | No | Banner image used as the project's cover. Less than 1MB in size. |
| `github` | `string` (uri) | No | URL of the project's GitHub repository. |
| `handle` | `string` (handle) | Yes | Canonical handle identifying the project (e.g. `myproject.example.com`). |
| `createdAt` | `string` (datetime) | Yes |  |
| `description` | `string` | No | Short description of the project. |
| `displayName` | `string` | Yes | Display name of the project as shown in user interfaces. |

## Raw Schema

```json
{
  "id": "net.atview.project",
  "defs": {
    "main": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```