📐 ID スキーマ

identityIdPathParameter は再利用可能な OpenAPIParameter で、他の 7 つのエクスポートは withSchema(...) SDK コンポーザーです。ID 機能およびルート、ならびに Profile の ID プロファイル検索のリクエスト契約を定義します。

一覧

エクスポート	リクエストの場所	契約
identityIdPathParameter	パス	必須の文字列 identityId を再利用可能なパラメーターとして定義します。
getIdentitySchema	パス	必須の identityId。
findIdentitySchema	クエリ	省略可能な name、page、limit。
updateIdentitySchema	パス、本文	必須の identityId と、省略可能な更新フィールドを持つ必須の厳格な JSON オブジェクト。
deleteIdentitySchema	パス	必須の identityId。
lockIdentitySchema	パス	必須の identityId。
unlockIdentitySchema	パス	必須の identityId。
findByIdentityIdSchema	パス、クエリ	必須の identityId と、省略可能なページネーションクエリフィールド。

詳細

identityIdPathParameter

定義

ID の再利用可能なパスパラメーター定義。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	形式またはパターンの制限は宣言されていません。

Used by getIdentitySchema, updateIdentitySchema, deleteIdentitySchema, lockIdentitySchema, unlockIdentitySchema, and findByIdentityIdSchema. いいえtification also spreads it into updateNotificationToReadBatchSchema.

完全なソースを表示

export const identityIdPathParameter: OpenAPIParameter = {
  in: 'path',
  name: 'identityId',
  required: true,
  schema: {
    type: 'string',
  },
};

---

getIdentitySchema

定義

ID 取得用のパス ID を検証します。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	次から展開: identityIdPathParameter.

ルートでの使用: getIdentityRoute. 機能での使用: getIdentityFeature.

完全なソースを表示

export const getIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

findIdentitySchema

定義

ID 一覧クエリを検証します。page と limit は共通の paginationQueryParametersSchema から展開されます。

場所	フィールド	型	必須	制約
クエリ	name	文字列	いいえ	省略可能な ID 名フィルター。
クエリ	page	整数	いいえ	最小 1; 最大 1000.
クエリ	limit	整数	いいえ	最小 1; 最大 50.

ルートでの使用: findIdentitiesRoute. 機能での使用: findIdentitiesFeature.

完全なソースを表示

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

---

updateIdentitySchema

定義

ID 更新を検証します。リクエスト本文は必須で、列挙された JSON プロパティのみを受け付けます。本文の各プロパティは個別には必須ではありません。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	次から展開: identityIdPathParameter.
本文	body	オブジェクト	はい	Content type application/json; additionalProperties: false.
本文	email	文字列	いいえ	許可される JSON プロパティ。
本文	emailVerified	真偽値	いいえ	許可される JSON プロパティ。
本文	typeId	文字列	いいえ	許可される JSON プロパティ。

ルートでの使用: updateIdentityRoute. 機能での使用: updateIdentityFeature.

完全なソースを表示

export const updateIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          additionalProperties: false,
          properties: {
            email: {type: 'string'},
            emailVerified: {type: 'boolean'},
            typeId: {type: 'string'},
          },
          type: 'object',
        },
      },
    },
    required: true,
  },
});

---

deleteIdentitySchema

定義

ID 削除用のパス ID を検証します。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	次から展開: identityIdPathParameter.

ルートでの使用: deleteIdentityRoute. 機能での使用: deleteIdentityFeature.

完全なソースを表示

export const deleteIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

lockIdentitySchema

定義

ID ロック用のパス ID を検証します。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	次から展開: identityIdPathParameter.

ルートでの使用: lockIdentityRoute. 機能での使用: lockIdentityFeature.

完全なソースを表示

export const lockIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

unlockIdentitySchema

定義

ID ロック解除用のパス ID を検証します。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	次から展開: identityIdPathParameter.

ルートでの使用: unlockIdentityRoute. 機能での使用: unlockIdentityFeature.

完全なソースを表示

export const unlockIdentitySchema = withSchema({
  parameters: [{...identityIdPathParameter}],
});

---

findByIdentityIdSchema

定義

Profile の ID プロファイル検索を検証します。ページネーションフィールドは共通の paginationQueryParametersSchema から展開されます。

場所	フィールド	型	必須	制約
パス	identityId	文字列	はい	次から展開: identityIdPathParameter.
クエリ	page	整数	いいえ	最小 1; 最大 1000.
クエリ	limit	整数	いいえ	最小 1; 最大 50.

ルートでの使用: findProfilesByIdentityIdRoute. 機能での使用: findProfilesByIdentityIdFeature.

完全なソースを表示

export const findByIdentityIdSchema = withSchema({
  parameters: [{...identityIdPathParameter}, ...paginationQueryParametersSchema],
});

---