📐 Profile schemas

Profile schemas define the stored profile fragments and the HTTP request contracts used by Profile features and routes.

Inventory

Export	Request location	Contract
ProfileFollow	N/A	Stored { followProfileId: string }.
OrganizationFollow	N/A	Stored { followOrganizationId: string }.
ProductLike	N/A	Stored { likeProductId: string }.
profileSchema	N/A	Stored profile object: identityId, name, optional avatar/null.
createProfileSchema	Body	Required JSON identityId, name; optional avatar/null.
updateProfileSchema	Path, body	Required path ID; JSON may contain name and avatar/null.
getProfileSchema	Path	Required profileId.
deleteProfileSchema	Path	Required profileId.
findProfilesSchema	Query	Optional identityId, name, shared pagination.
createProfileFollowSchema	Path	Required profile and followed-profile IDs.
deleteProfileFollowSchema	Path	Required profile and followed-profile IDs.
getProfileFollowersSchema	Path	Required profile ID.
createOrganizationFollowSchema	Path	Required profile and organization IDs.
deleteOrganizationFollowSchema	Path	Required profile and organization IDs.
createProductLikeSchema	Path	Required profile and product IDs.
deleteProductLikeSchema	Path	Required profile and product IDs.

Details

ProfileFollow

Definition

Stored relation shape: followProfileId: string. Used by Profile block follow operations.

View complete source

export type ProfileFollow = {
  followProfileId: string;
};

---

OrganizationFollow

Definition

Stored relation shape: followOrganizationId: string. Used by Profile block organization-follow operations.

View complete source

export type OrganizationFollow = {
  followOrganizationId: string;
};

---

ProductLike

Definition

Stored relation shape: likeProductId: string. Used by Profile block product-like operations.

View complete source

export type ProductLike = {
  likeProductId: string;
};

---

profileSchema

Definition

The reusable stored profile shape has additionalProperties: false.

Location	Field	Type	Required	Constraints
N/A	avatar	Avatar or null	No	oneOf shared avatarSchema and null
N/A	identityId	string	No	Required by creation schema
N/A	name	string	No	Required by creation schema

Used by route: createProfileRoute. Used by feature: createProfileFeature.

View complete source

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

Definition

Requires application/json body and spreads profileSchema with required identityId and name; extra fields are rejected.

Location	Field	Type	Required	Constraints
Body	identityId	string	Yes	—
Body	name	string	Yes	—
Body	avatar	Avatar or null	No	shared avatar schema

Used by route: createProfileRoute. Used by feature: createProfileFeature.

View complete source

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

---

updateProfileSchema

Definition

Requires the path profile ID and an application/json body. The body permits no extra fields and may be empty because its source required field list is empty; the legacy handler separately rejects an empty body.

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Body	name	string	No	—
Body	avatar	Avatar or null	No	shared avatar schema

Used by route: updateProfileRoute. Used by feature: editProfileFeature.

View complete source

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

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—

Used by route: getProfileRoute. Used by feature: getProfileFeature.

View complete source

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

---

deleteProfileSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—

Used by route: deleteProfileRoute. Used by feature: deleteProfileFeature.

View complete source

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

---

findProfilesSchema

Definition

Location	Field	Type	Required	Constraints
Query	identityId	string	No	—
Query	name	string	No	—
Query	pagination fields	shared	No	paginationQueryParametersSchema

Used by route: findProfilesRoute. Used by feature: findProfilesFeature.

View complete source

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

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Path	followProfileId	string	Yes	—

Used by route: createProfileFollowRoute. Used by feature: createProfileFollowFeature.

View complete source

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

---

deleteProfileFollowSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Path	followProfileId	string	Yes	—

Used by route: deleteProfileFollowRoute. Used by feature: deleteProfileFollowFeature.

View complete source

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

---

getProfileFollowersSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—

Used by route: getProfileFollowersRoute. Used by feature: getProfileFollowersFeature.

View complete source

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

---

createOrganizationFollowSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Path	followOrganizationId	string	Yes	—

Used by route: createOrganizationFollowRoute. Used by feature: createOrganizationFollowFeature.

View complete source

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

---

deleteOrganizationFollowSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Path	followOrganizationId	string	Yes	—

Used by route: deleteOrganizationFollowRoute. Used by feature: deleteOrganizationFollowFeature.

View complete source

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

---

createProductLikeSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Path	likeProductId	string	Yes	—

Used by route: createProductLikeRoute. Used by feature: createProductLikeFeature.

View complete source

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

---

deleteProductLikeSchema

Definition

Location	Field	Type	Required	Constraints
Path	profileId	string	Yes	—
Path	likeProductId	string	Yes	—

Used by route: deleteProductLikeRoute. Used by feature: deleteProductLikeFeature.

View complete source

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

---