Skip to content

API DOC

Ronen edited this page Mar 1, 2020 · 14 revisions

Ping

GET /server/ping/


Pipeline Notifications


Create Comment

POST /comment/:owner/:repo/

{
  "owner": "scalecube",
  "repo": "github-gateway",
  "issue_number": 1,
  "path": "src/examples/comment-template.md",
  "a-param": "some value"
}

Status Update

POST /checks/status/:owner/:repo/:sha

{
  "owner" : "scalecube", "repo": "github-gateway", "pr_number":1, "sha":"8133c9...",
  "statuses": [{
    "name" : "integration-testing",
    "status": "pending",
    "message"  : "initializing integration-testing"
  },{
    "name" : "performance-testing",
    "status": "pending",
    "message"  : "initializing performance-testing"
  }]
}

Create Web-Hook

POST /webhooks/create

{
  "owner": "scalecube",
  "repo": "github-gateway",
  "url":"http://my-server:port/any/path"
}

DEPLOY CONTEXT WEBHOOK

{
  "action_type": "deploy",
  "owner": "scalecube",
  "repo": "github-gateway",
  "branch_name": "develop",
  "sha": "905de160be1c84e65dda76f4aaac557d861a5e4f",
  "is_pull_request": true,
  "issue_number": 9,
  "namespace": "scalecube-github-gateway-develop",
  "labeled": true,
  "labels": [
    "DEPLOY"
  ]
}

Add trace data

POST /traces/add

{
  "owner": "scalecube", "repo": "github-gateway", "sha": "0b654e...",
  "traces": [{
    "name" : "1",
    "type" : "scatter",
    "group": "latency",
    "x" : [ 1, 2 ],
    "y" : [ 4085252095, 4146069503]
  },{
    "name" : "2",
    "type" : "scatter",
    "group": "throughput",
    "x" : [ 1, 2],
    "y" : [ 408525209, 414669503]
  }]
}

Get Trace data

GET /traces/get/:owner/:repo/:sha

GET /traces/get/:owner/:repo/:sha/:filter