komrad

edit_forge_pull_request

Change a pull request's title, description or both on its forge.

writesidempotentdestructiveCLI onlyForge

Calling it#

curl -X POST http://127.0.0.1:8787/komrad.forge.v1.ForgeService/EditForgePullRequest \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "<url>",
  "edited_from": "<edited_from>"
}'

Request#

EditForgePullRequestRequest#

FieldTypeDescription
urlstring*

at most 2048 characters

The pull request to change, by web address. The address's host picks the forge connection.

edited_fromPullRequestText*

The title and description the caller read. The call refuses to change a field that has moved since, unless the field already holds the new value.

titlestring

not empty

at most 1024 characters

The new title. Unset leaves the title as it is.

bodystring

at most 1048576 characters

The new description. Unset leaves the description as it is, and empty clears it.

Response#

Empty#

No fields.

Types#

PullRequestText#

PullRequestText is a pull request's title and description.

FieldTypeDescription
titlestring

at most 1024 characters

The pull request's title.

bodystring

at most 1048576 characters

The pull request's description, empty when it has none.