Detect a repository's framework

GET

/teams/{teamId}/github/repos/{owner}/{repo}/detect

curl --request GET \
  --url https://api.deploybase.eu/api/v1/teams/example/github/repos/example/example/detect

Inspects the repo’s root files and package.json to guess the framework. Advisory — returns framework: null when unsure.

Parameters

Path Parameters

teamId

required

string

Team UUID

owner

required

string

Repository owner

repo

required

string

Repository name

Query Parameters

ref

string

Branch, tag or SHA (defaults to the repo’s default branch)

Responses

200

OK

Media type application/json

object

data

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "data": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

403

Forbidden

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

404

Repository not found

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}

409

No GitHub App connection

Media type application/json

object

code

string

details

error

string

meta

object

request_id

string

timestamp

string

trace_id

string

Example ^generated

{
  "code": "example",
  "details": "example",
  "error": "example",
  "meta": {
    "request_id": "example",
    "timestamp": "example",
    "trace_id": "example"
  }
}