strapi/packages/core/content-manager/shared/contracts/uid.ts

import type { UID, Modules } from '@strapi/types';

import { errors } from '@strapi/utils';

type Entity = Modules.EntityService.Result<UID.Schema>;

/**
 * POST /uid/generate
 */
export declare namespace GenerateUID {
  export interface Request {
    body: {
      contentTypeUID: string;
      data: Entity;
      field: string;
    };
    query: {
      locale?: string | null;
    };
  }
  export interface Response {
    data: string;
    error?: errors.ApplicationError | errors.YupValidationError;
  }
}

/**
 * POST /uid/check-availability
 */
export declare namespace CheckUIDAvailability {
  export interface Request {
    body: {
      contentTypeUID: string;
      field: string;
      value: string;
    };
    query: {
      locale?: string | null;
    };
  }
  export type Response =
    | {
        isAvailable: boolean;
        suggestion: string | null;
        error?: never;
      }
    | {
        isAvailable?: never;
        suggesiton?: never;
        error?: errors.ApplicationError | errors.YupValidationError;
      };
}