GitHub

Turn pull request comments on or off (projects:write); nothing is ever built because of a pull request

patch/projects/{projectId}/pull-request-comments

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/projects/{projectId}/pull-request-comments
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

projectIdstring uuid required

Request body

enabledboolean required

Response

Updated

projectIdstring uuid required
enabledboolean required

the project switch (default on): comment on pull requests with the branch preview

configuredboolean required

this server can write to GitHub (the customer GitHub App's private key is installed); false: nothing is posted whatever the switch says

eligibleboolean required

the project deploys a GitHub repository (only those get pull request comments)

appConnectedboolean required

the repository is connected through the Hostingsurge GitHub App, whose installation writes the comment; false: comments are written only when the organization's Hostingsurge GitHub App installation also covers the repository (a push-webhook project)

updatedAtstring nullable required

ISO-8601; null while the project still has the default

Changes

No recorded changes to this operation across all 1 revision of this API.