weseek__growi/apps/app/src/interfaces/apiv3/page.ts

import type {
  IPageHasId, IRevisionHasId, ITag, Origin,
} from '@growi/core';

import type { IOptionsForCreate, IOptionsForUpdate } from '../page';

export type IApiv3PageCreateParams = IOptionsForCreate & {
  path?: string,
  parentPath?: string,
  optionalParentPath?: string,

  body?: string,
  pageTags?: string[],

  origin?: Origin,

  isSlackEnabled?: boolean,
  slackChannels?: string,
};

export type IApiv3PageCreateResponse = {
  page: IPageHasId,
  tags: ITag[],
  revision: IRevisionHasId,
};

export type IApiv3PageUpdateParams = IOptionsForUpdate & {
  pageId: string,
  revisionId?: string,
  body: string,

  origin?: Origin,
  isSlackEnabled?: boolean,
  slackChannels?: string,
  wip?: boolean
};

export type IApiv3PageUpdateResponse = {
  page: IPageHasId,
  revision: IRevisionHasId,
};

export const PageUpdateErrorCode = {
  CONFLICT: 'conflict',
  FORBIDDEN: 'forbidden',
} as const;