📐 Organization スキーマ

Organization スキーマはソースの検証と OpenAPI リクエスト契約を定義します。合成とエンドポイント動作については、対応する機能およびルートを使用してください。

一覧

エクスポート	リクエスト位置	契約
organizationCommonSchema	該当なし	再利用可能なオブジェクト。additionalProperties: false。
organizationAdminApprovedSchema	該当なし	再利用可能な管理者オブジェクト。additionalProperties: false。
createOrganizationSchema	本文	JSON 本文が必要です。外側とネストしたオブジェクトは追加プロパティを拒否します。
organizationMembersSchema	該当なし	再利用可能な空でないメンバー配列。
upsertOrganizationMembersSchema	パス、本文	必須のパスおよび JSON メンバー配列本文。
updateOrganizationSchema	パス、本文	必須のパスおよび JSON 本文。必須本文フィールドなしで organizationCommonSchema を展開します。
updateOrganizationAsAdminSchema	パス、本文	必須のパスおよび JSON 本文。共通フィールドと管理者承認済みフィールドをマージします。
getOrganizationSchema	パス	必須の Organization パスパラメーター。
deleteOrganizationSchema	パス	必須の Organization パスパラメーター。
getOrganizationMemberRoleSchema	パス	必須の Organization およびアイデンティティのパスパラメーター。
checkOrganizationMemberExistenceSchema	パス、クエリ	必須の Organization パスパラメーターとアイデンティティクエリパラメーター。
findOrganizationMembersSchema	パス	必須の Organization パスパラメーター。
deleteOrganizationMemberSchema	パス	必須の Organization およびアイデンティティのパスパラメーター。
findOrganizationsForMemberSchema	パス、クエリ	任意のロールおよび継承フィルターを伴うメンバー検索。
findOrganizationsSchema	クエリ	任意のフィルターと共有ページネーションパラメーター。
findOrganizationDescendantsSchema	パス、クエリ	任意の深さを伴う Organization の子孫。
getCertificateUploadUrlSchema	パス、クエリ	証明書アップロード URL の入力。
createChangeRequestSchema	パス、本文	必須のパスおよび空でない JSON 変更リクエスト本文。
findChangeRequestsForOrganizationSchema	パス、クエリ	Organization パスと共有ページネーション。ソースはアイデンティティフィルターを定義しません。
findByOrganizationIdSchema	パス、クエリ	再利用可能なクロスドメイン Organization スコープとページネーション。
getOrganizationFollowersSchema	パス	必須の Organization パスパラメーター。

詳細

organizationCommonSchema

定義

再利用可能なオブジェクト。additionalProperties: false。

位置	フィールド	型	必須	制約
該当なし	branchName, contact_email, contact_phone, description	文字列	いいえ	contact_email has email format.

使用ルート: 直接の Organization ルートはありません。 使用機能: 再利用可能なスキーマ。合成されたリクエストスキーマを通じて使用されます。

完全なソースを表示

export const organizationCommonSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    branchName: { type: 'string' },
    contact_email: { format: 'email', type: 'string' },
    contact_phone: { type: 'string' },
    description: { type: 'string' },
  },
  type: 'object',
};

---

organizationAdminApprovedSchema

定義

再利用可能な管理者オブジェクト。additionalProperties: false。

位置	フィールド	型	必須	制約
該当なし	address	オブジェクト	いいえ	追加プロパティを許可します。
該当なし	certificateImage	オブジェクト	いいえ	{objectId: uuid string, type: string}; 両方のネストしたフィールドが必須です。
該当なし	certifiedQualifications	配列	いいえ	項目には文字列の name、status、value が必要です。
該当なし	logo	object or null	いいえ	アップロード済みファイルオブジェクト、または null。
該当なし	name, typeId	文字列	いいえ	name の最小長は 1。

使用ルート: 直接の Organization ルートはありません。 使用機能: 再利用可能なスキーマ。合成されたリクエストスキーマを通じて使用されます。

完全なソースを表示

export const organizationAdminApprovedSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  additionalProperties: false,
  properties: {
    address: { additionalProperties: true, type: 'object' },
    certificateImage: { ...uploadedFileSchema },
    certifiedQualifications: { ...qualificationSchema },
    logo: {
      oneOf: [uploadedFileSchema, { type: 'null' }],
    },
    name: { minLength: 1, type: 'string' },
    typeId: { type: 'string' },
  },
  type: 'object',
};

---

createOrganizationSchema

定義

JSON 本文が必要です。外側とネストしたオブジェクトは追加プロパティを拒否します。

位置	フィールド	型	必須	制約
本文	organization	オブジェクト	はい	共通および管理者承認済みプロパティをマージし、name、description、contact_email を必須とします。
本文	ownerId	文字列	はい	—
本文	parentId	文字列	いいえ	—

使用ルート: createOrganizationRoute. 使用機能: createOrganizationFeature.

完全なソースを表示

export const createOrganizationSchema = withSchema({
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          additionalProperties: false,
          properties: {
            organization: {
              ...organizationAdminApprovedSchema,
              properties: {
                ...organizationCommonSchema.properties,
                ...organizationAdminApprovedSchema.properties,
              },
              required: ['name', 'description', 'contact_email'],
            },
            ownerId: { type: 'string' },
            parentId: { type: 'string' },
          },
          required: ['organization', 'ownerId'],
          type: 'object',
        },
      },
    },
    required: true,
  },
});

---

organizationMembersSchema

定義

再利用可能な空でないメンバー配列。

位置	フィールド	型	必須	制約
該当なし	item.identityId, item.role	文字列	はい	項目オブジェクトは追加プロパティを拒否します。

使用ルート: 直接の Organization ルートはありません。 使用機能: 再利用可能なスキーマ。合成されたリクエストスキーマを通じて使用されます。

完全なソースを表示

export const organizationMembersSchema: SchemaDefinition = {
  $schema: 'http://json-schema.org/draft-07/schema#',
  items: {
    additionalProperties: false,
    properties: {
      identityId: { type: 'string' },
      role: { type: 'string' },
    },
    required: ['identityId', 'role'],
    type: 'object',
  },
  minItems: 1,
  type: 'array',
};

---

upsertOrganizationMembersSchema

定義

必須のパスおよび JSON メンバー配列本文。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
本文	members 配列	配列	はい	organizationMembersSchema。最小 1 項目。

使用ルート: upsertOrganizationMembersRoute. 使用機能: editOrganizationMembersFeatures.

完全なソースを表示

export const upsertOrganizationMembersSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...organizationMembersSchema,
        },
      },
    },
    required: true,
  },
});

---

updateOrganizationSchema

定義

必須のパスおよび JSON 本文。必須本文フィールドなしで organizationCommonSchema を展開します。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
本文	branchName, contact_email, contact_phone, description	文字列	いいえ	contact_email has email format; body rejects additional properties.

使用ルート: updateOrganizationRoute. 使用機能: editOrganizationFeatures.

完全なソースを表示

export const updateOrganizationSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...organizationCommonSchema,
          required: [],
        },
      },
    },
    required: true,
  },
});

---

updateOrganizationAsAdminSchema

定義

必須のパスおよび JSON 本文。共通フィールドと管理者承認済みフィールドをマージします。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
本文	common fields, name, typeId, auditStatus	文字列	いいえ	name minimum length 1; body rejects additional properties.
本文	address, certificateImage, certifiedQualifications, logo	object/array/object-or-null	いいえ	Same nested contracts as organizationAdminApprovedSchema.

使用ルート: updateOrganizationAsAdminRoute. 使用機能: updateOrganizationAsAdminFeature.

完全なソースを表示

export const updateOrganizationAsAdminSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          ...organizationAdminApprovedSchema,
          properties: {
            ...organizationCommonSchema.properties,
            ...organizationAdminApprovedSchema.properties,
            auditStatus: { type: 'string' },
          },
          required: [],
        },
      },
    },
    required: true,
  },
});

---

getOrganizationSchema

定義

必須の Organization パスパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—

使用ルート: getOrganizationRoute. 使用機能: getOrganizationFeatures.

完全なソースを表示

export const getOrganizationSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
});

---

deleteOrganizationSchema

定義

必須の Organization パスパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—

使用ルート: deleteOrganizationRoute. 使用機能: deleteOrganizationFeatures.

完全なソースを表示

export const deleteOrganizationSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
});

---

getOrganizationMemberRoleSchema

定義

必須の Organization およびアイデンティティのパスパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId, identityId	文字列	はい	—

使用ルート: getOrganizationMemberRoleRoute. 使用機能: getOrganizationMemberFeatures.

完全なソースを表示

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

---

checkOrganizationMemberExistenceSchema

定義

必須の Organization パスパラメーターとアイデンティティクエリパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
クエリ	identityId	文字列	はい	—

使用ルート: checkOrganizationMemberExistenceRoute. 使用機能: checkOrganizationMemberExistenceFeatures.

完全なソースを表示

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

---

findOrganizationMembersSchema

定義

必須の Organization パスパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—

使用ルート: findOrganizationMembersRoute. 使用機能: findOrganizationMembersFeatures.

完全なソースを表示

export const findOrganizationMembersSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
});

---

deleteOrganizationMemberSchema

定義

必須の Organization およびアイデンティティのパスパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId, identityId	文字列	はい	—

使用ルート: deleteOrganizationMemberRoute. 使用機能: deleteOrganizationMemberFeatures.

完全なソースを表示

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

---

findOrganizationsForMemberSchema

定義

任意のロールおよび継承フィルターを伴うメンバー検索。

位置	フィールド	型	必須	制約
パス	identityId	文字列	はい	—
クエリ	roles	文字列	いいえ	Exact source name is plural.
クエリ	includeInherited	ブール値	いいえ	—

使用ルート: findOrganizationsForMemberRoute. 使用機能: findOrganizationsForMemberFeatures.

完全なソースを表示

export const findOrganizationsForMemberSchema = withSchema({
  parameters: [
    { ...identityIdPathParameter },
    {
      in: 'query',
      name: 'roles',
      required: false,
      schema: {
        type: 'string',
      },
    },
    {
      in: 'query',
      name: 'includeInherited',
      required: false,
      schema: { type: 'boolean' },
    },
  ],
});

---

findOrganizationsSchema

定義

任意のフィルターと共有ページネーションパラメーター。

位置	フィールド	型	必須	制約
クエリ	contact_email	文字列	いいえ	email format.
クエリ	contact_phone, description	文字列	いいえ	—
クエリ	name	文字列	いいえ	minimum length 1.
クエリ	page, limit	共有ページネーション	いいえ	paginationQueryParametersSchema から取得。

使用ルート: findOrganizationsRoute. 使用機能: findOrganizationsFeatures.

完全なソースを表示

export const findOrganizationsSchema = withSchema({
  parameters: [
    {
      in: 'query',
      name: 'contact_email',
      required: false,
      schema: {
        format: 'email',
        type: 'string',
      },
    },
    {
      in: 'query',
      name: 'contact_phone',
      required: false,
      schema: {
        type: 'string',
      },
    },
    {
      in: 'query',
      name: 'description',
      required: false,
      schema: {
        type: 'string',
      },
    },
    {
      in: 'query',
      name: 'name',
      required: false,
      schema: {
        minLength: 1,
        type: 'string',
      },
    },
    ...paginationQueryParametersSchema,
  ],
});

---

findOrganizationDescendantsSchema

定義

任意の深さを伴う Organization の子孫。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
クエリ	depth	数値	いいえ	minimum 1.

使用ルート: findOrganizationDescendantsRoute. 使用機能: findOrganizationDescendantsFeatures.

完全なソースを表示

export const findOrganizationDescendantsSchema = withSchema({
  parameters: [
    { ...organizationIdPathParameter },
    {
      in: 'query',
      name: 'depth',
      required: false,
      schema: {
        minimum: 1,
        type: 'number',
      },
    },
  ],
});

---

getCertificateUploadUrlSchema

定義

証明書アップロード URL の入力。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
クエリ	contentType	文字列	はい	application/pdf, image/gif, image/jpeg, or image/png.
クエリ	contentLength	共有パラメーター	はい	contentLengthQueryParameter から取得。

使用ルート: getCertificateUploadUrlRoute. 使用機能: getCertificateUploadUrlFeature.

完全なソースを表示

export const getCertificateUploadUrlSchema = withSchema({
  parameters: [
    { ...organizationIdPathParameter },
    {
      in: 'query',
      name: 'contentType',
      required: true,
      schema: { enum: CERTIFICATE_MIME_TYPES, type: 'string' },
    },
    { ...contentLengthQueryParameter },
  ],
});

---

createChangeRequestSchema

定義

必須のパスおよび空でない JSON 変更リクエスト本文。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
本文	addressLine1, addressLine2, addressLine3, branchName, postalCode, typeId	文字列	いいえ	—
本文	name	文字列	いいえ	minimum length 1.
本文	certificateImage, certifiedQualifications	object/配列	いいえ	Uploaded-file and qualification reusable shapes; body rejects additional properties.

使用ルート: createChangeRequestRoute. 使用機能: createChangeRequestFeature.

完全なソースを表示

export const createChangeRequestSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
  requestBody: {
    content: {
      'application/json': {
        schema: {
          $schema: 'http://json-schema.org/draft-07/schema#',
          additionalProperties: false,
          minProperties: 1,
          properties: {
            addressLine1: { type: 'string' },
            addressLine2: { type: 'string' },
            addressLine3: { type: 'string' },
            branchName: { type: 'string' },
            certificateImage: { ...uploadedFileSchema },
            certifiedQualifications: { ...qualificationSchema },
            name: { minLength: 1, type: 'string' },
            postalCode: { type: 'string' },
            typeId: { type: 'string' },
          },
          required: [],
          type: 'object',
        },
      },
    },
    required: true,
  },
});

---

findChangeRequestsForOrganizationSchema

定義

Organization パスと共有ページネーション。ソースはアイデンティティフィルターを定義しません。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
クエリ	page, limit	共有ページネーション	いいえ	paginationQueryParametersSchema から取得。

使用ルート: findChangeRequestsForOrganizationRoute. 使用機能: findChangeRequestsForOrganizationFeature.

完全なソースを表示

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

---

findByOrganizationIdSchema

定義

再利用可能なクロスドメイン Organization スコープとページネーション。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—
クエリ	page, limit	共有ページネーション	いいえ	paginationQueryParametersSchema から取得。

使用ルート: Cross-domain: Order and Product organization-scoped routes.. 使用機能: Cross-domain feature composition..

完全なソースを表示

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

---

getOrganizationFollowersSchema

定義

必須の Organization パスパラメーター。

位置	フィールド	型	必須	制約
パス	organizationId	文字列	はい	—

使用ルート: getOrganizationFollowersRoute. 使用機能: getOrganizationFollowersFeature.

完全なソースを表示

export const getOrganizationFollowersSchema = withSchema({
  parameters: [{ ...organizationIdPathParameter }],
});

---