Code

{
  "repository_name": "code",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez"
}

List the branches of a given repository

{
  "branches": [
    "master",
    "developer",
    "qa"
  ],
  "default_branch": "master"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name or account not found.

{
  "message": "Not found. Either repository_name, branch or commits are not found"
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "branch": "master",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez"
}

Clone job started

{
  "bundle_id": "979a6aa8-4f2-400d-9451-80ee1e127485"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name or branch is not found.

{
  "message": "Not found. Either repository_name or branch is not found."
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

Clone status

{
  "bundle_id": "979a6aa8-4f2-400d-9451-80ee1e127485",
  "clone_status": "SUCCEEDED",
  "commit_hash": "80a6e06179b267f0f4da68a2e1707d17b8f77fb2",
  "source_url": "https://code-dev-025.s3.amazonaws.com/service-builder-api/979a6aa8/source.zip",
  "metadata": {
    "service-code": {
      "commit_hash": "979a6aa8-4f2-400d-9451-80ee1e127485",
      "id": "d898b987-eda3-4b75-b7e7-bea8ae39674c",
      "issuer": "https://api.staircaseapi.com/code",
      "status": "SUCCEEDED",
      "timestamp": 1611603369.1289215,
      "version": 1.1,
      "repository_name": "StaircaseAPI/code"
    }
  }
}

Bad syntax

{
  "message": "Bad syntax"
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Clone job not found.

{
  "message": "Clone job not found."
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez",
  "private": true,
  "visibility": "private",
  "gitignore_template": "Python",
  "description": "Repository description"
}

Repository created

{
  "status": "Succeeded",
  "repo_url": "https://<redacted>"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name or account not found.

{
  "message": "Not found. Either repository_name, branches or secret"
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez",
  "secret_name": "newsecret",
  "secret_value": "0d1357"
}

The secret was updated or created

{
  "message": "Succeeded"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name or account not found.

{
  "message": "Not found. Either repository_name, branches or secret"
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez",
  "secret_name": "newsecret"
}

The secret was deleted

{
  "message": "Succeeded"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name or account not found.

{
  "message": "Not found. Either repository_name, branches or secret"
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "branch": "master",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez",
  "start_date": "2021-01-05",
  "end_date": "2021-01-15",
  "next_token": 1
}

Clone job started

{
  "commits": [
    {
      "comments": "First commit",
      "author": "bezos",
      "date": "2021-01-29T16:55:51Z"
    },
    {
      "comments": "Second commit",
      "author": "jeff",
      "date": "2021-01-29T16:25:51Z"
    }
  ],
  "next_token": 0
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name, branch or commits are not found.

{
  "message": "Not found. Either repository_name, branch or commits are not found."
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez",
  "new_branch": "feature-branch",
  "user_email": "user@email.com",
  "user_name": "User Name",
  "zip_url": "https://bucket.s3.amazonaws.com/repo.zip?AWSAccessKeyId=<redacted>&Signature=<redacted>"
}

Commit operation job started

{
  "operation_id": "704db6f3-c534-4c4b-b7dd-d4fa52d60e71"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name, branch or commits are not found.

{
  "message": "Not found. Either repository_name, branch or commits are not found."
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

Clone status

{
  "status": "SUCCEEDED"
}

Bad syntax

{
  "message": "Bad syntax"
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Commit change operation not found.

{
  "message": "Commit change operation not found."
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "repository_name": "code",
  "github_account": "staircaseapi",
  "github_token": "a50d135781d8c9ca26884ab0a858205d74f726ez",
  "head": "head",
  "base": "base",
  "title": "title",
  "body": "body"
}

Pull request created

{
  "message": "Succeeded"
}

Bad request syntax or missed a required field

{
  "message": "Bad request syntax or missed a required field"
}

Unauthorized, Bad credentials.

{
  "message": "Unauthorized, Bad credentials."
}

Bad request syntax or forbidden request

{
  "message": "Bad request syntax or missed a required field"
}

Not found. Either repository_name or account not found.

{
  "message": "Not found. Either repository_name, branches or secret"
}

Method not allowed.

{
  "message": "The method is not allowed for the requested URL"
}

{
  "test": "test"
}

200 response

{
  "assessment_id": "devops-code-assessor:9dff4dc3-f700-4fc8-a51a-56d91d7ed7df"
}