📐 Profile スキーマ

Profile スキーマは、保存するプロフィール断片と、Profile 機能およびルートが使用する HTTP リクエスト契約を定義します。

一覧

エクスポート	リクエスト位置	契約
ProfileFollow	該当なし	{ followProfileId: string } を保存する。
OrganizationFollow	該当なし	{ followOrganizationId: string } を保存する。
ProductLike	該当なし	{ likeProductId: string } を保存する。
profileSchema	該当なし	identityId、name、任意の avatar/null を持つ保存プロフィール。
createProfileSchema	本文	必須の JSON identityId、name、任意の avatar/null。
updateProfileSchema	パス、本文	必須のパス ID。JSON は name と avatar/null を含められる。
getProfileSchema	パス	必須の profileId。
deleteProfileSchema	パス	必須の profileId。
findProfilesSchema	クエリ	任意の identityId、name、共有ページネーション。
createProfileFollowSchema	パス	必須のプロフィール ID とフォロー先プロフィール ID。
deleteProfileFollowSchema	パス	必須のプロフィール ID とフォロー先プロフィール ID。
getProfileFollowersSchema	パス	必須のプロフィール ID。
createOrganizationFollowSchema	パス	必須のプロフィール ID と組織 ID。
deleteOrganizationFollowSchema	パス	必須のプロフィール ID と組織 ID。
createProductLikeSchema	パス	必須のプロフィール ID と商品 ID。
deleteProductLikeSchema	パス	必須のプロフィール ID と商品 ID。

詳細

ProfileFollow

定義

保存するリレーションの形式は followProfileId: string です。プロフィールブロックのフォロー操作で使用します。

完全なソースを表示

export type ProfileFollow = {
  followProfileId: string;
};

---

OrganizationFollow

定義

保存するリレーションの形式は followOrganizationId: string です。プロフィールブロックの組織フォロー操作で使用します。

完全なソースを表示

export type OrganizationFollow = {
  followOrganizationId: string;
};

---

ProductLike

定義

保存するリレーションの形式は likeProductId: string です。プロフィールブロックの商品「いいね」操作で使用します。

完全なソースを表示

export type ProductLike = {
  likeProductId: string;
};

---

profileSchema

定義

再利用可能な保存プロフィールの形式です。additionalProperties: false により、定義されていないプロパティは許可されません。

場所	フィールド	型	必須	制約
該当なし	avatar	Avatar または null	いいえ	共有の avatarSchema と null の oneOf
該当なし	identityId	string	いいえ	作成スキーマでは必須
該当なし	name	string	いいえ	作成スキーマでは必須

使用するルート: createProfileRoute. 使用する機能: createProfileFeature.

完全なソースを表示

export const profileSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    avatar: {
      oneOf: [avatarSchema, { type: 'null' }],
    },
    identityId: { type: 'string' },
    name: { type: 'string' },
  },
  type: 'object',
};

---

createProfileSchema

定義

application/json のリクエスト本文が必要です。profileSchema を展開し、identityId と name を必須にします。追加フィールドは拒否されます。

場所	フィールド	型	必須	制約
本文	identityId	string	はい	—
本文	name	string	はい	—
本文	avatar	Avatar または null	いいえ	共有 avatar スキーマ

使用するルート: createProfileRoute. 使用する機能: createProfileFeature.

完全なソースを表示

export const createProfileSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...profileSchema,
          required: ['identityId', 'name'],
        },
      },
    },
    required: true,
  },
});

---

updateProfileSchema

定義

パスのプロフィール ID と application/json のリクエスト本文が必要です。本文は追加フィールドを許可せず、ソースの required フィールド一覧が空であるため空にできます。ただし、レガシーハンドラーは空の本文を別途拒否します。

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
本文	name	string	いいえ	—
本文	avatar	Avatar または null	いいえ	共有 avatar スキーマ

使用するルート: updateProfileRoute. 使用する機能: editProfileFeature.

完全なソースを表示

export const updateProfileSchema = withSchema({
  parameters: [{ ...profileIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          additionalProperties: false,
          properties: {
            avatar: {
              oneOf: [avatarSchema, { type: 'null' }],
            },
            name: { type: 'string' },
          },
          required: [],
          type: 'object',
        },
      },
    },
    required: true,
  },
});

---

getProfileSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—

使用するルート: getProfileRoute. 使用する機能: getProfileFeature.

完全なソースを表示

export const getProfileSchema = withSchema({
  parameters: [{ ...profileIdPathParameter }],
});

---

deleteProfileSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—

使用するルート: deleteProfileRoute. 使用する機能: deleteProfileFeature.

完全なソースを表示

export const deleteProfileSchema = withSchema({
  parameters: [{ ...profileIdPathParameter }],
});

---

findProfilesSchema

定義

場所	フィールド	型	必須	制約
クエリ	identityId	string	いいえ	—
クエリ	name	string	いいえ	—
クエリ	ページネーションフィールド	共有	いいえ	paginationQueryParametersSchema

使用するルート: findProfilesRoute. 使用する機能: findProfilesFeature.

完全なソースを表示

export const findProfilesSchema = withSchema({
  parameters: [
    {
      in: 'query',
      name: 'identityId',
      required: false,
      schema: {
        type: 'string',
      },
    },
    {
      in: 'query',
      name: 'name',
      required: false,
      schema: {
        type: 'string',
      },
    },
    ...paginationQueryParametersSchema,
  ],
});

---

createProfileFollowSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
パス	followProfileId	string	はい	—

使用するルート: createProfileFollowRoute. 使用する機能: createProfileFollowFeature.

完全なソースを表示

export const createProfileFollowSchema = withSchema({
  parameters: [profileIdPathParameter, followProfileIdPathParameter],
});

---

deleteProfileFollowSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
パス	followProfileId	string	はい	—

使用するルート: deleteProfileFollowRoute. 使用する機能: deleteProfileFollowFeature.

完全なソースを表示

export const deleteProfileFollowSchema = withSchema({
  parameters: [profileIdPathParameter, followProfileIdPathParameter],
});

---

getProfileFollowersSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—

使用するルート: getProfileFollowersRoute. 使用する機能: getProfileFollowersFeature.

完全なソースを表示

export const getProfileFollowersSchema = withSchema({
  parameters: [profileIdPathParameter],
});

---

createOrganizationFollowSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
パス	followOrganizationId	string	はい	—

使用するルート: createOrganizationFollowRoute. 使用する機能: createOrganizationFollowFeature.

完全なソースを表示

export const createOrganizationFollowSchema = withSchema({
  parameters: [profileIdPathParameter, followOrganizationIdPathParameter],
});

---

deleteOrganizationFollowSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
パス	followOrganizationId	string	はい	—

使用するルート: deleteOrganizationFollowRoute. 使用する機能: deleteOrganizationFollowFeature.

完全なソースを表示

export const deleteOrganizationFollowSchema = withSchema({
  parameters: [profileIdPathParameter, followOrganizationIdPathParameter],
});

---

createProductLikeSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
パス	likeProductId	string	はい	—

使用するルート: createProductLikeRoute. 使用する機能: createProductLikeFeature.

完全なソースを表示

export const createProductLikeSchema = withSchema({
  parameters: [profileIdPathParameter, likeProductIdPathParameter],
});

---

deleteProductLikeSchema

定義

場所	フィールド	型	必須	制約
パス	profileId	string	はい	—
パス	likeProductId	string	はい	—

使用するルート: deleteProductLikeRoute. 使用する機能: deleteProductLikeFeature.

完全なソースを表示

export const deleteProductLikeSchema = withSchema({
  parameters: [profileIdPathParameter, likeProductIdPathParameter],
});

---