# work.mattriley.ghrepo

> Published by [mattriley.work](https://lexicon.garden/identity/did:plc:g5frjlzwnpjtxlc6chaqbl4o)

## Description

A public GitHub repository mirrored from the GitHub API.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:g5frjlzwnpjtxlc6chaqbl4o/work.mattriley.ghrepo)
- [Documentation](https://lexicon.garden/lexicon/did:plc:g5frjlzwnpjtxlc6chaqbl4o/work.mattriley.ghrepo/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:g5frjlzwnpjtxlc6chaqbl4o/work.mattriley.ghrepo/examples)

## Definitions

### `work.mattriley.ghrepo`

**Type**: `record`

One record per public repository, rkey = repo name.

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `url` | `string` (uri) | Yes | Repository HTML URL on GitHub. |
| `name` | `string` | Yes | Repository name as it appears on GitHub. |
| `stars` | `integer` | No | Star count at sync time. |
| `source` | `string` | No | Upstream source of the repo data (e.g. github). |
| `topics` | `array` | No | Repository topics. |
| `archived` | `boolean` | No | True when the repository is archived on GitHub. |
| `syncedAt` | `string` (datetime) | Yes | When this record was last synced from GitHub. |
| `description` | `string` | No | Repository description, if set on GitHub. |
| `licenseName` | `string` | No | Full license name, if a license is detected. |
| `primaryLanguage` | `string` | No | The single language GitHub attributes to the repository, if any. |

## Raw Schema

```json
{
  "id": "work.mattriley.ghrepo",
  "defs": {
    "main": {
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "name",
          "url",
          "syncedAt"
        ],
        "properties": {
          "url": {
            "type": "string",
            "format": "uri",
            "description": "Repository HTML URL on GitHub."
          },
          "name": {
            "type": "string",
            "description": "Repository name as it appears on GitHub."
          },
          "stars": {
            "type": "integer",
            "description": "Star count at sync time."
          },
          "source": {
            "type": "string",
            "description": "Upstream source of the repo data (e.g. github)."
          },
          "topics": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "Repository topics."
          },
          "archived": {
            "type": "boolean",
            "description": "True when the repository is archived on GitHub."
          },
          "syncedAt": {
            "type": "string",
            "format": "datetime",
            "description": "When this record was last synced from GitHub."
          },
          "description": {
            "type": "string",
            "description": "Repository description, if set on GitHub."
          },
          "licenseName": {
            "type": "string",
            "description": "Full license name, if a license is detected."
          },
          "primaryLanguage": {
            "type": "string",
            "description": "The single language GitHub attributes to the repository, if any."
          }
        }
      },
      "description": "One record per public repository, rkey = repo name."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "A public GitHub repository mirrored from the GitHub API."
}
```