github

GET`/github.one`

github-one

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`githubId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/github.one?githubId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET`/github.getGithubRepositories`

github-getGithubRepositories

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`githubId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/github.getGithubRepositories?githubId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET`/github.getGithubBranches`

github-getGithubBranches

Authorization

`Authorization`
Required
Bearer <token>

In: header

Query Parameters

`repo`
Required
string

Minimum length: 1

`owner`
Required
string

Minimum length: 1

`githubId`string

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/github.getGithubBranches?repo=string&owner=string&githubId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET`/github.githubProviders`

github-githubProviders

Authorization

`Authorization`
Required
Bearer <token>

In: header

Status code	Description
`200`	Successful response
`default`	Error response

curl -X GET "http://localhost:3000/api/github.githubProviders"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/github.testConnection`

github-testConnection

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`githubId`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/github.testConnection" \
  -d '{
  "githubId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST`/github.update`

github-update

Authorization

`Authorization`
Required
Bearer <token>

In: header

Request Body

`githubId`
Required
string

Minimum length: 1

`githubAppName`string | null

`githubAppId`number | null

`githubClientId`string | null

`githubClientSecret`string | null

`githubInstallationId`string | null

`githubPrivateKey`string | null

`githubWebhookSecret`string | null

`gitProviderId`
Required
string

Minimum length: 1

`name`
Required
string

Minimum length: 1

Status code	Description
`200`	Successful response
`default`	Error response

curl -X POST "http://localhost:3000/api/github.update" \
  -d '{
  "githubId": "string",
  "githubAppName": "string",
  "githubAppId": 0,
  "githubClientId": "string",
  "githubClientSecret": "string",
  "githubInstallationId": "string",
  "githubPrivateKey": "string",
  "githubWebhookSecret": "string",
  "gitProviderId": "string",
  "name": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

github

GET/github.one

AuthorizationRequiredBearer <token>

githubIdRequiredstring

Response

Typescript

GET/github.getGithubRepositories

AuthorizationRequiredBearer <token>

githubIdRequiredstring

Response

Typescript

GET/github.getGithubBranches

AuthorizationRequiredBearer <token>

repoRequiredstring

ownerRequiredstring

githubIdstring

Response

Typescript

GET/github.githubProviders

AuthorizationRequiredBearer <token>

Response

Typescript

POST/github.testConnection

AuthorizationRequiredBearer <token>

githubIdRequiredstring

Response

Typescript

POST/github.update

AuthorizationRequiredBearer <token>

githubIdRequiredstring

githubAppNamestring | null

githubAppIdnumber | null

githubClientIdstring | null

githubClientSecretstring | null

githubInstallationIdstring | null

githubPrivateKeystring | null

githubWebhookSecretstring | null

gitProviderIdRequiredstring

nameRequiredstring

Response

Typescript

On this page

GET`/github.one`

`Authorization`
Required
Bearer <token>

`githubId`
Required
string

GET`/github.getGithubRepositories`

`Authorization`
Required
Bearer <token>

`githubId`
Required
string

GET`/github.getGithubBranches`

`Authorization`
Required
Bearer <token>

`repo`
Required
string

`owner`
Required
string

`githubId`string

GET`/github.githubProviders`

`Authorization`
Required
Bearer <token>

POST`/github.testConnection`

`Authorization`
Required
Bearer <token>

`githubId`
Required
string

POST`/github.update`

`Authorization`
Required
Bearer <token>

`githubId`
Required
string

`githubAppName`string | null

`githubAppId`number | null

`githubClientId`string | null

`githubClientSecret`string | null

`githubInstallationId`string | null

`githubPrivateKey`string | null

`githubWebhookSecret`string | null

`gitProviderId`
Required
string

`name`
Required
string