fix formatting and make path descriptions clearer

Signed-off-by: Jakub Sokołowski <jakub@status.im>
This commit is contained in:
Jakub Sokołowski 2018-12-22 11:58:38 +01:00
parent 8beb231a3d
commit 1c778b25d8
No known key found for this signature in database
GPG Key ID: 4EF064D0E6D63020
1 changed files with 8 additions and 21 deletions

View File

@ -22,8 +22,8 @@ The problem this solves is posting comments in a PR from multiple builds without
It exposes just 1 call: It exposes just 1 call:
* `POST /builds/:id` - Post a comment for PR with given ID. * `POST /builds/:id` - Add a new build result and update the PR comment.
* `POST /builds/:id/refresh` - Update the comment for PR with given ID. * `POST /builds/:id/refresh` - Re-render the PR comment for given ID.
* `POST /comments` - Show currently managed comments in PRs. * `POST /comments` - Show currently managed comments in PRs.
By default it listens on `localhost:8080`. By default it listens on `localhost:8080`.
@ -33,24 +33,17 @@ By default it listens on `localhost:8080`.
``` ```
$ cat << EOF $ cat << EOF
{ {
"id": 1, "id": 1, "commit": "7367f3d5", "success": true, "platform": "linux", "duration": "~15 min",
"commit": "7367f3d5",
"success": true,
"platform": "linux",
"duration": "~15 min",
"url": "https://ci.status.im/job/status-react/job/prs/job/linux/job/PR-7123/1/", "url": "https://ci.status.im/job/status-react/job/prs/job/linux/job/PR-7123/1/",
"pkg_url": "https://status-im-prs.ams3.digitaloceanspaces.com/StatusIm-181212-211210-5157d2-pr.AppImage" "pkg_url": "https://status-im-prs.ams3.digitaloceanspaces.com/StatusIm-181212-211210-5157d2-pr.AppImage"
} }
EOF >> /tmp/body/json EOF >> /tmp/body/json
$ curl -s -XPOST https://localhost:8000/builds/7123 -d@/tmp/body.json -H 'Content-Type: application/json' $ curl -s -XPOST https://localhost:8000/builds/7123 -d@/tmp/body.json -H 'Content-Type: application/json'
{ { "status": "ok" }
"status": "ok"
} sochan@lilim: infra-misc% curl https://clicks.status.im/click [10/17/18 11:22:50]
$ curl -s -XPOST https://localhost:8000/builds/7123/refresh $ curl -s -XPOST https://localhost:8000/builds/7123/refresh
{ { "status": "ok" }
"status": "ok"
} sochan@lilim: infra-misc% curl https://clicks.status.im/click [10/17/18 11:22:50]
``` ```
You can also check all PRs the application knows about: You can also check all PRs the application knows about:
``` ```
@ -58,14 +51,8 @@ $ curl -s http://localhost:8000/comments
{ {
"count": 2, "count": 2,
"comments": [ "comments": [
{ { "pr": "7000", "comment_id": 446940840 },
"pr": "7000", { "pr": "7084", "comment_id": 446779864 }
"comment_id": 446940840
},
{
"pr": "7084",
"comment_id": 446779864
}
] ]
} }
``` ```