メインコンテンツまでスキップ
バージョン: 0.9.0 (最新)

🔍 アバタースキーマ

アバタースキーマは、ドメイン全体(例:ユーザープロフィール、組織)で使用されるアバターオブジェクトのJSON Schema定義を提供します。これらのスキーマは、クラウドストレージに保存されたファイル参照の一貫したオブジェクト構造を保証します。


🎯 概要

アバタースキーマは以下の目的で設計されています:

  • エンティティで使用されるアバターオブジェクトの形状を検証
  • 必須フィールドが常に存在することを保証
  • objectIdを使用してファイルストレージフローと統合

🔧 利用可能なアバタースキーマ

avatarSchema

基本アバターオブジェクトスキーマ。

目的: ストレージ参照とMIMEタイプを持つアバターオブジェクトを検証

スキーマ詳細:

  • Type: object
  • 必須フィールド: objectId, type
  • Additional Properties: false (厳密なバリデーション)
  • Properties:
    • objectId: string (UUID) — クラウドストレージオブジェクト識別子
    • type: string — 画像のMIMEタイプ(例:image/png

使用例:

import { schemas } from '@nodeblocks/backend-sdk';

const { avatarSchema } = schemas;

const validate = ajv.compile(avatarSchema as SchemaDefinition);
const isValid = validate({ objectId: 'b1f6c9b2-0a10-4c51-8b1f-1a9a2b1d8f90', type: 'image/png' });

🔗 関連ドキュメント