teableio/teable

View on GitHub
packages/openapi/src/comment/get.ts

Summary

Maintainability
A
0 mins
Test Coverage
import type { RouteConfig } from '@asteasolutions/zod-to-openapi';
import { axios } from '../axios';
import { registerRoute, urlBuilder } from '../utils';
import { z } from '../zod';
import { commentReactionSchema } from './reaction';
import { commentContentSchema } from './types';

export const GET_COMMENT_DETAIL = '/comment/{tableId}/{recordId}/{commentId}';

export const commentSchema = z.object({
  id: z.string(),
  content: commentContentSchema,
  createdBy: z.string(),
  reaction: commentReactionSchema.optional().nullable(),
  createdTime: z.date(),
  lastModifiedTime: z.date(),
  quoteId: z.string().optional(),
  deletedTime: z.date().optional(),
});

export type ICommentVo = z.infer<typeof commentSchema>;

export const GetCommentDetailRoute: RouteConfig = registerRoute({
  method: 'get',
  path: GET_COMMENT_DETAIL,
  description: 'Get record comment detail',
  request: {
    params: z.object({
      tableId: z.string(),
      recordId: z.string(),
    }),
  },
  responses: {
    200: {
      description: "Returns the record's comment detail",
      content: {
        'application/json': {
          schema: commentSchema.array(),
        },
      },
    },
  },
  tags: ['comment'],
});

export const getCommentDetail = async (tableId: string, recordId: string, commentId: string) => {
  return axios.get<ICommentVo | null>(
    urlBuilder(GET_COMMENT_DETAIL, { tableId, recordId, commentId })
  );
};