garden.lexicon.documentation Documentation (JA)

main record

1 example

多言語サポートを備えたレキシコンドキュメントを保存するための主要なレコードタイプです。

Record Key nsid

Properties

createdAt string datetime Required

このドキュメントレコードが作成されたタイムスタンプです。ISO 8601の日時形式を使用します。

definitions array of ref #definitionDoc Optional

「main」、名前付き型、またはその他のスキーマコンポーネントなど、レキシコン内の特定の定義に関するドキュメントです。

description array of ref #localizedString Optional

レキシコン全体のローカライズされた説明です。各エントリは特定の言語での説明を提供します。

lexicon string nsid Required

ドキュメント化されるレキシコンのNSIDです。有効な名前空間識別子である必要があります。

View raw schema

{
  "key": "nsid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "lexicon",
      "createdAt"
    ],
    "properties": {
      "lexicon": {
        "type": "string",
        "format": "nsid",
        "description": "The NSID of the lexicon being documented."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when this documentation was created."
      },
      "definitions": {
        "type": "array",
        "items": {
          "ref": "#definitionDoc",
          "type": "ref"
        },
        "description": "Documentation for specific definitions within the lexicon (e.g., main, replyRef)."
      },
      "description": {
        "type": "array",
        "items": {
          "ref": "#localizedString",
          "type": "ref"
        },
        "description": "Localized descriptions for the lexicon."
      }
    }
  },
  "description": "Auxiliary documentation for a lexicon schema, supporting localized descriptions for the lexicon and its properties."
}

definitionDoc object

レキシコンスキーマ内の特定の定義に関するドキュメントです。

Properties

description array of ref#localizedString Optional

この定義の目的と使用法を説明するローカライズされた説明です。

name string Required

ドキュメント化される定義の名前です（例：'main'、'replyRef'）。最大長は512文字です。

maxLength: 512 bytes

properties array of ref#propertyDoc Optional

この定義内の個々のプロパティに関するドキュメントです。

View raw schema

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 512,
      "description": "The name of the definition being documented (e.g., 'main', 'replyRef')."
    },
    "properties": {
      "type": "array",
      "items": {
        "ref": "#propertyDoc",
        "type": "ref"
      },
      "description": "Documentation for properties within this definition."
    },
    "description": {
      "type": "array",
      "items": {
        "ref": "#localizedString",
        "type": "ref"
      },
      "description": "Localized descriptions for this definition."
    }
  },
  "description": "Documentation for a definition within a lexicon."
}

localizedString object

国際化サポートのための言語コードが関連付けられた文字列値です。

Properties

lang string language Required

値の言語を識別するISO 639言語コードです（例：'en'、'es'、'ja'）。

value string Required

ローカライズされた文字列の内容です。最大長は10,000文字です。

maxLength: 10000 bytes

View raw schema

{
  "type": "object",
  "required": [
    "lang",
    "value"
  ],
  "properties": {
    "lang": {
      "type": "string",
      "format": "language",
      "description": "ISO 639 language code (e.g., 'en', 'es', 'ja')."
    },
    "value": {
      "type": "string",
      "maxLength": 10000,
      "description": "The localized string value."
    }
  },
  "description": "A string with an associated language code."
}

propertyDoc object

定義内の特定のプロパティに関するドキュメントです。

Properties

description array of ref#localizedString Optional

このプロパティの目的、形式、および制約を説明するローカライズされた説明です。

name string Required

ドキュメント化されるプロパティの名前です。最大長は256文字です。

maxLength: 256 bytes

View raw schema

{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256,
      "description": "The property name being documented."
    },
    "description": {
      "type": "array",
      "items": {
        "ref": "#localizedString",
        "type": "ref"
      },
      "description": "Localized descriptions for this property."
    }
  },
  "description": "Documentation for a specific property within a definition."
}