← Back to catalog

Other

Crucible

auto-generated
swirls add crucible
actionPOSTv1.0.0

addFisheyeReviewItem

Add the changes between two files in a fisheye repository to the review.

Source
actionPOSTv1.0.0

addPatchReview0

Old, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch

Source
actionPOSTv1.0.0

addPatchToReview

Add the revisions in a patch to an existing review.

Source
actionPOSTv1.0.0

addReply

Adds a reply to the given comment. This call includes the repsonse header that contains the URL of the newly created entity.

Source
actionPOSTv1.0.0

addReviewers

Adds the given list of reviewers to the review.

Source
actionPOSTv1.0.0

addReviewItem

Adds the given review item to the review. This will always create a new review item, even if there is an existing one with the same data in the review (in which case the existing item will be replaced).

Source
actionPOSTv1.0.0

addReviewItemRevisions

Adds the given list of revisions to the supplied review item, merging if required. For example, if the review item for contains revisions 3 to 6, and if:

Source
actionPOSTv1.0.0

addReviewItems

Adds a review item for each of the supplied crucibleRevisionData elements.

Source
actionGETv1.0.0

browse

Lists the contents of the specified directory.

Source
actionGETv1.0.0

change

Represents a particular changeset.

Source
actionGETv1.0.0

changes

Represents a sorted list of changesets, newest first.

Source
actionPOSTv1.0.0

changeState

Change the state of a review by performing an action on it.

Source
actionPOSTv1.0.0

completeReview

Completes the review for the current user

Source
actionDELETEv1.0.0

deleteReview

Permanently deletes the specified review. The review must have been abandoned.

Source
actionGETv1.0.0

getAllComments

Return all the comments visible to the requesting user for the review.

Source
actionGETv1.0.0

getAllDetailedReviews

Retrieves all reviews that are in one of the the specified states. For each review all details are included (review items + comments). The wiki rendered comments will be available via the <messageAsHtml> element

Source
actionGETv1.0.0

getAllProjects

Get the list of projects that the authenticated user is entitled to access.

Source
actionGETv1.0.0

getAllRepositories

Returns a list of all repositories. This includes plugin provided repositories

Source
actionGETv1.0.0

getAvailableActions

Get a list of the actions which the current user is allowed to perform on the review.

Source
actionGETv1.0.0

getAvailableTransitions

Get a list of the actions which the current user can perform on this review, given its current state and the user's permissions.

Source
actionGETv1.0.0

getComment

Gets the given comment.

Source
actionGETv1.0.0

getContents

Returns the raw content of the specified file revision as a binary stream. No attempt is made to identify the content type and no mime type is provided.

Source
actionGETv1.0.0

getCustomFilterReviews

To ignore a property, omit it from the query string.

Source
actionGETv1.0.0

getFilteredReviewsForUser

Get all the reviews which match the given filter, for the current user.

Source
actionGETv1.0.0

getMappedUser

Returns the user details of the user mapped to a committer in a repository.

Source
actionGETv1.0.0

getMetrics

Get comment metrics metadata for the specified metrics version.

Source
actionGETv1.0.0

getProject

Returns a project description.

Source
actionGETv1.0.0

getReplies

Gets the replies to the given comment.

Source
actionGETv1.0.0

getReview

Get a single review by its permId (e.g. "CR-45"). If the review does not exist, a 404 is returned. The moderator element may not exist if the review does not have a Moderator.

Source
actionGETv1.0.0

getReviewers

Get a list of reviewers in the review given by the permaid id.

Source
actionGETv1.0.0

getReviewItem

Returns detailed information for a specific review item.

Source
actionGETv1.0.0

getReviewPatches

Get a list of patches and their details for the given review

Source
actionGETv1.0.0

getReviewsDetailsForPath

Return a list of Reviews which include a particular file.

Source
actionGETv1.0.0

getReviewsForIssueKey

Get a list of all reviews that have been linked to the specified JIRA issue key.

Source
actionGETv1.0.0

getReviewsForPath

Return a list of Reviews which include a particular file.

Source
actionGETv1.0.0

getReviewsForTerm

Search for reviews where the name, description, state or permaId contain the specified term.

Source
actionGETv1.0.0

getSvnRepositoryDetails

For backward compatibility we provide this method, but repositories should be referred to just by their key.

Source
actionGETv1.0.0

getUncompletedReviewers

Gets a list of reviewers that have not completed the review.

Source
actionGETv1.0.0

getUserProfile

Returns the user's profile details.

Source
actionGETv1.0.0

getUsers

Get a list of all the users. You can also ask for a set of users.

Source
actionGETv1.0.0

history

Represents the history of a versioned entity.

Source
actionGETv1.0.0

login

Get the user authentication token. This is a legacy version of the login request. Using GET is deprecated as your password is likely to appear in logs which record request URLs. Use the POST version instead.

Source
actionPOSTv1.0.0

loginPost

Get the user authentication token.

Source
actionPOSTv1.0.0

markAllCommentsAsRead

For the effective user, mark all comments in a review as read (except those marked as leave unread).

Source
actionPOSTv1.0.0

markCommentAsLeaveUnread

Marks the comment as leave unread to the current user - it will not automatically be marked as read by crucible.

Source
actionPOSTv1.0.0

markCommentAsRead

Mark the given comment as read for the user used to make this POST.

Source
actionPOSTv1.0.0

postCustomFilterReviews

This method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only.

Source
actionPOSTv1.0.0

postDetailedCustomFilterReviews

This method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only.

Source
actionPOSTv1.0.0

publishAllComments

Publishes all the draft comments of the current user.

Source
actionPOSTv1.0.0

publishComment

publishes the given draft comment.

Source
actionPOSTv1.0.0

remindIncompleteReviewers

Immediately send a reminder to incomplete reviewers about the given review.

Source
actionDELETEv1.0.0

removeComment

Deletes the given comment.

Source
actionDELETEv1.0.0

removePatch

Removes the patch with the given id from the review. All of the revisions provided by the patch will be removed as well.

Source
actionDELETEv1.0.0

removeReply

Deletes the reply.

Source
actionDELETEv1.0.0

removeReviewer

Removes the reviewer from the review.

Source
actionDELETEv1.0.0

removeReviewItemRevisions

Removes the revisions given from the review item in the review specified by the id. If the review item has no more revisions left, it is automatically deleted.

Source
actionPUTv1.0.0

setReviewItem

Sets the review item specified by itemId with the given reviewItem. The old review item is discarded. Can only perform this operation if the old review item specified by itemId can be deleted. The old review item's permId is not changed.

Source
actionPOSTv1.0.0

uncompleteReview

Uncompletes the review for the current user.

Source
actionPOSTv1.0.0

updateComment

Updates the comment given by the perma id to the new comment posted.

Source
actionPOSTv1.0.0

updateReply

Updates a reply with the given newComment.

Source
Beyond the catalog

Any provider, on request.

01

Request it

Tell us which provider you need, and we will ship it in the registry.

02

Generate it

Point swirls add at an OpenAPI or GraphQL spec. Typed actions for any API you hold credentials for, today.

acme · integrations
terminal
~/acme $swirls add linear
✓ 12 typed actions · scopes and schemas included
 
~/acme $swirls add https://api.acme.dev/openapi.json
◆ Fetched spec · 38 operations
✓ 6 typed actions · generated from spec