komrad

read_forge_pull_request_text

Read a pull request's title and description from its forge.

read-onlyidempotentCLI onlyForge

Refuses when the forge will not let the credential change them.

Calling it#

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

Request#

ReadForgePullRequestTextRequest#

FieldTypeDescription
urlstring*

at most 2048 characters

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

Response#

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.