ArchAstro.V1.Tasks.Comments (archastro v0.2.0)

Copy Markdown

Comment API resource.

Summary

Functions

create(client, task, input)

Create a comment on a task

Posts a new comment on the specified task and returns the created comment. The task's owner is resolved from the task itself.

The newly created comment.

delete(client, task, comment)

@spec delete(ArchAstro.Client.t(), String.t(), String.t()) ::
  {:ok, :ok} | {:error, ArchAstro.Error.reason()}

Delete a task comment

Permanently removes a comment from its task. This action cannot be undone. The task's owner is resolved from the task itself.

Only the comment's author, an admin of the comment's organization, or an admin of the owning team may delete a comment. Returns 403 Forbidden otherwise.

Empty body. The server responds with HTTP 204 No Content on success.

list(client, task, params \\ %ArchAstro.Types.Operations.GetApiV1TasksTaskComments.Params{})

List comments on a task

Returns a bounded page of comments on the specified task, ordered by creation time ascending. App-scoped developer and server-to-server callers explicitly provide the owning team, user, or agent and org.

Successful response

replace(client, task, comment, input)

Update a task comment

Replaces the body of an existing comment and returns the updated comment. The task's owner is resolved from the task itself.

Only the comment's author, an admin of the comment's organization, or an admin of the owning team may edit a comment. Returns 403 Forbidden otherwise.

The updated comment.