98 lines
2.2 KiB
TypeScript
Raw Normal View History

import { Attribute, Common } from '@strapi/types';
import type { Release, Pagination } from './releases';
import type { Entity } from '../types';
import type { errors } from '@strapi/utils';
import { UserInfo } from '@strapi/helper-plugin';
type ReleaseActionEntry = Entity & {
// Entity attributes
[key: string]: Attribute.Any;
};
export interface ReleaseAction extends Entity {
type: 'publish' | 'unpublish';
entry: ReleaseActionEntry;
contentType: Common.UID.ContentType;
release: Release;
}
/**
* POST /content-releases/:releaseId/actions - Create a release action
*/
export declare namespace CreateReleaseAction {
export interface Request {
params: {
releaseId: Release['id'];
};
body: {
type: ReleaseAction['type'];
entry: {
id: ReleaseActionEntry['id'];
contentType: Common.UID.ContentType;
};
};
}
export interface Response {
data: ReleaseAction;
error?: errors.ApplicationError | errors.ValidationError | errors.NotFoundError;
}
}
/**
* GET /content-releases/:id/actions - Get all release actions
*/
export declare namespace GetReleaseActions {
export interface Request {
params: {
releaseId: Release['id'];
};
query?: Partial<Pick<Pagination, 'page' | 'pageSize'>>;
}
export interface Response {
data: ReleaseAction[];
meta: {
pagination: Pagination;
};
}
}
/*
* DELETE /content-releases/:releaseId/actions/:actionId - Delete a release action
*/
export declare namespace DeleteReleaseAction {
export interface Request {
params: {
actionId: ReleaseAction['id'];
releaseId: Release['id'];
};
}
export interface Response {
data: ReleaseAction;
error?: errors.ApplicationError | errors.NotFoundError;
}
}
/*
* PUT /content-releases/:releaseId/actions/:actionId - Update a release action
*/
export declare namespace UpdateReleaseAction {
export interface Request {
params: {
actionId: ReleaseAction['id']
releaseId: ReleaseAction['id'];
};
body: {
type: ReleaseAction['type'];
};
}
export interface Response {
data: ReleaseAction;
error?: errors.ApplicationError | errors.ValidationError | errors.NotFoundError;
}
}