# com.suibari.nagi.getChronicle

> Published by [suibari.com](https://lexicon.garden/identity/did:plc:uixgxpiqf4i63p6rgpu7ytmx)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:uixgxpiqf4i63p6rgpu7ytmx/com.suibari.nagi.getChronicle)
- [Documentation](https://lexicon.garden/lexicon/did:plc:uixgxpiqf4i63p6rgpu7ytmx/com.suibari.nagi.getChronicle/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:uixgxpiqf4i63p6rgpu7ytmx/com.suibari.nagi.getChronicle/examples)

## Definitions

### `com.suibari.nagi.getChronicle`

**Type**: `query`

自分年表。Nagi にやってきた日・botたんと出会った日・記念日カード・「はじめて」の記録・日記から抜いた出来事・そのころのニュースを、1本の時系列で返す。日記と同じく**本人だけが読む**ので、actor が認証した DID と一致しなければ 403（件数も日付も返さない）。

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `actor` | `string` (did) | Yes | 年表の持ち主。認証した DID と一致しなければならない。 |
| `cursor` | `string` | No | 次に返す年（"2025"）。年表は年見出しでまとまるので、ページ境界を見出し境界に一致させている。将来1年の件数が有界でなくなったら、日付とイベントIDの複合カーソルへ移すこと。 |
| `lang` | `string` | No | ニュースの表示言語。en は英訳が揃っているものだけ英語になる。 |
| `limit` | `integer` | No | 互換性のため受理するが適用しない。既読は年単位なので必ずその年の全項目を返す。 |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cursor` | `string` | No | 次の年。これ以上さかのぼれないときは省略する。 |
| `hasMore` | `boolean` | Yes |  |
| `items` | `array` | Yes | その年の節目。新しい順。同じ日に複数あるときは kind の固定優先度で決定論的に並ぶ。 |
| `revision` | `string` | Yes | その年の全内容のSHA-256。表示言語や取得順序には依存しない。 |
| `year` | `integer` | Yes |  |

### `com.suibari.nagi.getChronicle#readYear`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `revision` | `string` | Yes |  |
| `year` | `integer` | Yes |  |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "自分年表。Nagi にやってきた日・botたんと出会った日・記念日カード・「はじめて」の記録・日記から抜いた出来事・そのころのニュースを、1本の時系列で返す。日記と同じく**本人だけが読む**ので、actor が認証した DID と一致しなければ 403（件数も日付も返さない）。",
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "cursor": {
              "description": "次の年。これ以上さかのぼれないときは省略する。",
              "type": "string"
            },
            "hasMore": {
              "type": "boolean"
            },
            "items": {
              "description": "その年の節目。新しい順。同じ日に複数あるときは kind の固定優先度で決定論的に並ぶ。",
              "items": {
                "type": "unknown"
              },
              "type": "array"
            },
            "revision": {
              "description": "その年の全内容のSHA-256。表示言語や取得順序には依存しない。",
              "maxLength": 64,
              "type": "string"
            },
            "year": {
              "minimum": 2020,
              "type": "integer"
            }
          },
          "required": [
            "items",
            "hasMore",
            "year",
            "revision"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "actor": {
            "description": "年表の持ち主。認証した DID と一致しなければならない。",
            "format": "did",
            "type": "string"
          },
          "cursor": {
            "description": "次に返す年（\"2025\"）。年表は年見出しでまとまるので、ページ境界を見出し境界に一致させている。将来1年の件数が有界でなくなったら、日付とイベントIDの複合カーソルへ移すこと。",
            "type": "string"
          },
          "lang": {
            "default": "ja",
            "description": "ニュースの表示言語。en は英訳が揃っているものだけ英語になる。",
            "enum": [
              "ja",
              "en"
            ],
            "type": "string"
          },
          "limit": {
            "default": 50,
            "description": "互換性のため受理するが適用しない。既読は年単位なので必ずその年の全項目を返す。",
            "maximum": 100,
            "minimum": 1,
            "type": "integer"
          }
        },
        "required": [
          "actor"
        ],
        "type": "params"
      },
      "type": "query"
    },
    "readYear": {
      "properties": {
        "revision": {
          "maxLength": 64,
          "type": "string"
        },
        "year": {
          "minimum": 2020,
          "type": "integer"
        }
      },
      "required": [
        "year",
        "revision"
      ],
      "type": "object"
    }
  },
  "id": "com.suibari.nagi.getChronicle",
  "lexicon": 1
}
```