Bitrise.io API v0.1 (Work In Progress)

Development Beta Testing
83

@viktorbenei Am I missing something or is the documentation on https://devcenter.bitrise.io/api/v0.1/ very incomplete and half-hearted at the moment? What I mean is this:

POST /apps/register ⚓

Add a new application
Example curl request ⚓

curl -H 'Authorization: token THE-ACCESS-TOKEN' 'https://api.bitrise.io/v0.1/apps/APP-SLUG' -d '{"provider":"github","is_public":false,"repo_url":"git@github.com:api_demo/example-repository.git","type":"git","git_repo_slug":"example-repository","git_owner":"api_demo"}'

Example response ⚓

{
  "status": "ok",
  "slug": "022d8a3124f1225d"
}

This is all information there is for the “new app” API endpoint. The data I need to send is totally undocumented, there’s only an example. What I’m missing at least:

  • [ ] A short description for each request parameter.
  • [ ] All possible values for enum cases.

For example, I have no idea how to setup a new project which is hosted on a self-hosted GitLab server. What’s the right value for provider? What’s the git_owner? And on registering webhook, the example doesn’t even include any sent data – how does it work, then? I have do find these things out through trial and error now.

Also it’s totally unclear to me how the entire app creation process works given there are separate API endpoints for register-ssh-key, register-webhook and app/APP-SLUG/finish … will I have to wait and check some status until the scanner has completed? What if the scanner finds errors, how do I get them?

A complete documentation for the currently existing APIs would be very helpful!