Activity5

Assets1

Authentication3

Columns5

Comments4

Config1

Discord4

External Links1

Generic Webhook4

Gitea7

GitHub8

Instance1

Invitations2

Labels8

MCP4

Notification Preferences4

Notifications5

Organization Management35

Projects8

Search1

Slack4

Task Relations3

Tasks17

Telegram4

Time Entries4

User3

Workflow Rules3

Workspaces1

GitHub

Verify GitHub installation

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

Changed in 3 of the 23 revisions of this API.615

Aug 24, 202608bbb5bedb5d213See the full diff
- ▲
  added the new required request property projectId
  new-required-request-property
- ▲
  removed the required property installed from the response with the 200 status
  response-required-property-removed
- ○
  added the non-success response with the status 400
  response-non-success-status-added
- ○
  added the non-success response with the status 401
  response-non-success-status-added
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the optional property installationUrl to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property settingsUrl to the response with the 200 status
  response-optional-property-added
- ○
  the response property message became required for the status 200
  response-property-became-required
- ○
  added the required property hasRequiredPermissions to the response with the 200 status
  response-required-property-added
- ○
  added the required property installationId to the response with the 200 status
  response-required-property-added
- ○
  added the required property isInstalled to the response with the 200 status
  response-required-property-added
- ○
  added the required property missingPermissions to the response with the 200 status
  response-required-property-added
- ○
  added the required property permissions to the response with the 200 status
  response-required-property-added
- ○
  added the required property repositoryExists to the response with the 200 status
  response-required-property-added
- ○
  added the required property repositoryPrivate to the response with the 200 status
  response-required-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 11, 202632cece1ebe431See the full diff
- ▲
  request body became required
  request-body-became-required
Dec 11, 202593b23177312632See the full diff
- ▲
  the repositoryName request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the repositoryOwner request property's minLength was increased from 0 to 1
  request-property-min-length-increased
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ○
  added the optional property message to the response with the 200 status
  response-optional-property-added
- ○
  added the required property installed to the response with the 200 status
  response-required-property-added

Full history