strapi/packages/core/upload/shared/contracts/settings.ts

/**
 * Used to store user configurations related to media files.
 * E.g the size optimization flag, the responsive dimensions flag and the auto orientation.
 */

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

export interface Settings {
  data: {
    sizeOptimization?: boolean;
    responsiveDimensions?: boolean;
    autoOrientation?: boolean;
    videoPreview?: boolean;
  };
}

/**
 * GET /upload/settings
 *
 * Return the stored settings for the media files.
 */
export declare namespace GetSettings {
  export interface Request {
    query?: {};
  }

  export interface Response {
    data: Settings;
  }
}

/**
 * PUT /upload/settings
 *
 * Update the stored settings
 */
export declare namespace UpdateSettings {
  export interface Request {
    body: Settings['data'];
  }

  export type Response = Utils.OneOf<
    { data: Settings['data'] },
    { error?: errors.ApplicationError | errors.ValidationError }
  >;
}