GitHub

Update GitHub integration

Changed on

Update the GitHub integration. Omitted fields keep their current value.

patch/github-integration/project/{projectId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/github-integration/project/{projectId}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Request body

isActiveboolean
commentTaskLinkOnGitHubIssueboolean

Response

The updated integration

idstring required
projectIdstring required
repositoryOwnerstring required
repositoryNamestring required
installationIdnumber nullable required

The GitHub App installation that grants access to the repository.

requiresVerificationboolean required
branchPatternstring

Template used to name branches created for a task.

commentTaskLinkOnGitHubIssueboolean

When on, Kaneo comments a link back to the task on the linked GitHub issue.

isActiveboolean nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the media type text/plain for the response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status