Class DocCommentsService

constructor

• new DocCommentsService(httpRequest): DocCommentsService

• Parameters

  • httpRequest: BaseHttpRequest

  Returns DocCommentsService

Readonly httpRequest

docCommentCreate

• docCommentCreate(options): CancelablePromise<{
      docComment: DocCommentPayload;
  }>

• Create a comment on a doc

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docId: number;
        requestBody: {
            content: string;
        };
    }

    • channelId: string

    • docId: number

    • requestBody: {
          content: string;
      }

      • content: string

        The content of the doc comment

  Returns CancelablePromise<{
      docComment: DocCommentPayload;
  }>

  any Success

docCommentDelete

• docCommentDelete(options): CancelablePromise<void>

• Delete a doc comment

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docCommentId: number;
        docId: number;
    }

    • channelId: string

    • docCommentId: number

    • docId: number

  Returns CancelablePromise<void>

  void

docCommentRead

• docCommentRead(options): CancelablePromise<{
      docComment: DocCommentPayload;
  }>

• Get a comment on a doc

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docCommentId: number;
        docId: number;
    }

    • channelId: string

    • docCommentId: number

    • docId: number

  Returns CancelablePromise<{
      docComment: DocCommentPayload;
  }>

  any Success

docCommentReadMany

• docCommentReadMany(options): CancelablePromise<{
      docComments: DocCommentPayload[];
  }>

• Get a doc's comments

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docId: number;
    }

    • channelId: string

    • docId: number

  Returns CancelablePromise<{
      docComments: DocCommentPayload[];
  }>

  any Success

docCommentUpdate

• docCommentUpdate(options): CancelablePromise<{
      docComment: DocCommentPayload;
  }>

• Update a doc comment

  Throws

  ApiError

  Parameters

  • options: {
        channelId: string;
        docCommentId: number;
        docId: number;
        requestBody: {
            content: string;
        };
    }

    • channelId: string

    • docCommentId: number

    • docId: number

    • requestBody: {
          content: string;
      }

      • content: string

        The content of the doc comment

  Returns CancelablePromise<{
      docComment: DocCommentPayload;
  }>

  any Success