Files
pole-book/server/node_modules/@strapi/upload/dist/shared/contracts/configuration.d.ts

45 lines
1.0 KiB
TypeScript

/**
* Used to store the media library configuration.
* E.g the page size, the sort.
*/
import { errors } from '@strapi/utils';
import type { Utils } from '@strapi/types';
type SortOrder = 'ASC' | 'DESC';
type SortKey = 'createdAt' | 'name' | 'updatedAt';
export interface Configuration {
pageSize: number;
sort: `${SortKey}:${SortOrder}`;
}
/**
* GET /upload/configuration
*
* Return the configuration for the media files.
*/
export declare namespace GetConfiguration {
interface Request {
query?: {};
}
interface Response {
data: {
data: Configuration;
};
error?: errors.ApplicationError | errors.NotFoundError;
}
}
/**
* PUT /upload/configuration
*
* Update the configuration
*/
export declare namespace UpdateConfiguration {
interface Request {
body: Configuration;
}
type Response = Utils.OneOf<{
data: Configuration;
}, {
error?: errors.ApplicationError | errors.ValidationError;
}>;
}
export {};