GitHub

Verify GitHub installation

Changed on

Check that the GitHub App is installed on a repository and holds the permissions Kaneo needs. Always 200 -- problems are reported in the body so the client can guide the user.

post/github-integration/verify

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/github-integration/verify
  • Auth
    HTTP bearer

Request body

projectIdstring required
repositoryOwnerstring required
repositoryNamestring required

Response

Verification result

isInstalledboolean required
installationIdnumber nullable required
repositoryExistsboolean nullable required
repositoryPrivateboolean nullable required
permissionsobject nullable required

The permissions the installation currently grants.

hasRequiredPermissionsboolean required
missingPermissionsstring[] required

Permissions that must be granted before the link will work.

messagestring required

A human-readable summary to show the user.

settingsUrlstring

Where to adjust the installation, when one exists.

installationUrlstring

Where to install the App, when it is not installed yet.

Changes

  • c9984766c765Revision changes
    • info

      added the non-success response with the status

  • c7b8a842601bRevision 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

    • 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