📐 Organization schemas

Organization schemas define source validation and OpenAPI request contracts. Use the matching feature and route for composition and endpoint behavior.

Inventory

Export	Request location	Contract
organizationCommonSchema	N/A	Reusable object; additionalProperties: false.
organizationAdminApprovedSchema	N/A	Reusable admin object; additionalProperties: false.
createOrganizationSchema	Body	JSON body required; outer and nested objects reject additional properties.
organizationMembersSchema	N/A	Reusable non-empty members array.
upsertOrganizationMembersSchema	Path, body	Required path and JSON members-array body.
updateOrganizationSchema	Path, body	Required path and JSON body; spreads organizationCommonSchema with no required body fields.
updateOrganizationAsAdminSchema	Path, body	Required path and JSON body; merges common and admin-approved fields.
getOrganizationSchema	Path	Required organization path parameter.
deleteOrganizationSchema	Path	Required organization path parameter.
getOrganizationMemberRoleSchema	Path	Required organization and identity path parameters.
checkOrganizationMemberExistenceSchema	Path, Query	Required organization path and identity query parameter.
findOrganizationMembersSchema	Path	Required organization path parameter.
deleteOrganizationMemberSchema	Path	Required organization and identity path parameters.
findOrganizationsForMemberSchema	Path, Query	Member lookup with optional role and inheritance filters.
findOrganizationsSchema	Query	Optional filters plus shared pagination parameters.
findOrganizationDescendantsSchema	Path, Query	Organization descendants with optional depth.
getCertificateUploadUrlSchema	Path, Query	Certificate upload URL inputs.
createChangeRequestSchema	Path, body	Required path and non-empty JSON change-request body.
findChangeRequestsForOrganizationSchema	Path, Query	Organization path plus shared pagination; source does not define an identity filter.
findByOrganizationIdSchema	Path, Query	Reusable cross-domain organization scope plus pagination.
getOrganizationFollowersSchema	Path	Required organization path parameter.

Details

organizationCommonSchema

Definition

Reusable object; additionalProperties: false.

Location	Field	Type	Required	Constraints
N/A	branchName, contact_email, contact_phone, description	string	No	contact_email has email format.

Used by route: No direct Organization route. Used by feature: Reusable schema; consumed through composed request schemas..

View complete source

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

Definition

Reusable admin object; additionalProperties: false.

Location	Field	Type	Required	Constraints
N/A	address	object	No	Allows additional properties.
N/A	certificateImage	object	No	{objectId: uuid string, type: string}; both nested fields required.
N/A	certifiedQualifications	array	No	Items require string name, status, value.
N/A	logo	object or null	No	Uploaded-file object or null.
N/A	name, typeId	string	No	name minimum length 1.

Used by route: No direct Organization route. Used by feature: Reusable schema; consumed through composed request schemas..

View complete source

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

Definition

JSON body required; outer and nested objects reject additional properties.

Location	Field	Type	Required	Constraints
Body	organization	object	Yes	Merges common and admin-approved properties; requires name, description, contact_email.
Body	ownerId	string	Yes	—
Body	parentId	string	No	—

Used by route: createOrganizationRoute. Used by feature: createOrganizationFeature.

View complete source

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

Definition

Reusable non-empty members array.

Location	Field	Type	Required	Constraints
N/A	item.identityId, item.role	string	Yes	Item object rejects additional properties.

Used by route: No direct Organization route. Used by feature: Reusable schema; consumed through composed request schemas..

View complete source

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

Definition

Required path and JSON members-array body.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Body	members array	array	Yes	organizationMembersSchema; minimum one item.

Used by route: upsertOrganizationMembersRoute. Used by feature: editOrganizationMembersFeatures.

View complete source

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

---

updateOrganizationSchema

Definition

Required path and JSON body; spreads organizationCommonSchema with no required body fields.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Body	branchName, contact_email, contact_phone, description	string	No	contact_email has email format; body rejects additional properties.

Used by route: updateOrganizationRoute. Used by feature: editOrganizationFeatures.

View complete source

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

---

updateOrganizationAsAdminSchema

Definition

Required path and JSON body; merges common and admin-approved fields.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Body	common fields, name, typeId, auditStatus	string	No	name minimum length 1; body rejects additional properties.
Body	address, certificateImage, certifiedQualifications, logo	object/array/object-or-null	No	Same nested contracts as organizationAdminApprovedSchema.

Used by route: updateOrganizationAsAdminRoute. Used by feature: updateOrganizationAsAdminFeature.

View complete source

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

---

getOrganizationSchema

Definition

Required organization path parameter.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—

Used by route: getOrganizationRoute. Used by feature: getOrganizationFeatures.

View complete source

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

---

deleteOrganizationSchema

Definition

Required organization path parameter.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—

Used by route: deleteOrganizationRoute. Used by feature: deleteOrganizationFeatures.

View complete source

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

---

getOrganizationMemberRoleSchema

Definition

Required organization and identity path parameters.

Location	Field	Type	Required	Constraints
Path	organizationId, identityId	string	Yes	—

Used by route: getOrganizationMemberRoleRoute. Used by feature: getOrganizationMemberFeatures.

View complete source

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

---

checkOrganizationMemberExistenceSchema

Definition

Required organization path and identity query parameter.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Query	identityId	string	Yes	—

Used by route: checkOrganizationMemberExistenceRoute. Used by feature: checkOrganizationMemberExistenceFeatures.

View complete source

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

---

findOrganizationMembersSchema

Definition

Required organization path parameter.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—

Used by route: findOrganizationMembersRoute. Used by feature: findOrganizationMembersFeatures.

View complete source

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

---

deleteOrganizationMemberSchema

Definition

Required organization and identity path parameters.

Location	Field	Type	Required	Constraints
Path	organizationId, identityId	string	Yes	—

Used by route: deleteOrganizationMemberRoute. Used by feature: deleteOrganizationMemberFeatures.

View complete source

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

---

findOrganizationsForMemberSchema

Definition

Member lookup with optional role and inheritance filters.

Location	Field	Type	Required	Constraints
Path	identityId	string	Yes	—
Query	roles	string	No	Exact source name is plural.
Query	includeInherited	boolean	No	—

Used by route: findOrganizationsForMemberRoute. Used by feature: findOrganizationsForMemberFeatures.

View complete source

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

Definition

Optional filters plus shared pagination parameters.

Location	Field	Type	Required	Constraints
Query	contact_email	string	No	email format.
Query	contact_phone, description	string	No	—
Query	name	string	No	minimum length 1.
Query	page, limit	shared pagination	No	From paginationQueryParametersSchema.

Used by route: findOrganizationsRoute. Used by feature: findOrganizationsFeatures.

View complete source

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

Definition

Organization descendants with optional depth.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Query	depth	number	No	minimum 1.

Used by route: findOrganizationDescendantsRoute. Used by feature: findOrganizationDescendantsFeatures.

View complete source

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

---

getCertificateUploadUrlSchema

Definition

Certificate upload URL inputs.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Query	contentType	string	Yes	application/pdf, image/gif, image/jpeg, or image/png.
Query	contentLength	shared parameter	Yes	From contentLengthQueryParameter.

Used by route: getCertificateUploadUrlRoute. Used by feature: getCertificateUploadUrlFeature.

View complete source

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

---

createChangeRequestSchema

Definition

Required path and non-empty JSON change-request body.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Body	addressLine1, addressLine2, addressLine3, branchName, postalCode, typeId	string	No	—
Body	name	string	No	minimum length 1.
Body	certificateImage, certifiedQualifications	object/array	No	Uploaded-file and qualification reusable shapes; body rejects additional properties.

Used by route: createChangeRequestRoute. Used by feature: createChangeRequestFeature.

View complete source

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

Definition

Organization path plus shared pagination; source does not define an identity filter.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Query	page, limit	shared pagination	No	From paginationQueryParametersSchema.

Used by route: findChangeRequestsForOrganizationRoute. Used by feature: findChangeRequestsForOrganizationFeature.

View complete source

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

---

findByOrganizationIdSchema

Definition

Reusable cross-domain organization scope plus pagination.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—
Query	page, limit	shared pagination	No	From paginationQueryParametersSchema.

Used by route: Cross-domain: Order and Product organization-scoped routes.. Used by feature: Cross-domain feature composition..

View complete source

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

---

getOrganizationFollowersSchema

Definition

Required organization path parameter.

Location	Field	Type	Required	Constraints
Path	organizationId	string	Yes	—

Used by route: getOrganizationFollowersRoute. Used by feature: getOrganizationFollowersFeature.

View complete source

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

---