APIs.io Engineering Platform · Example Payload

Apis Io Engineering Platform Reposcreate Deployment Example

APIs.ioEngineeringPlatform

Apis Io Engineering Platform Reposcreate Deployment Example is an example object payload from APIs.io Engineering Platform, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

Raw ↑ 
{
  "operationId": "repos/create-deployment",
  "method": "POST",
  "path": "/repos/{owner}/{repo}/deployments",
  "summary": "APIs.io Engineering Platform Create a deployment",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "simple-example",
      "example": {
        "ref": "topic-branch",
        "payload": "{ \"deploy\": \"migrate\" }",
        "description": "Deploy request from hubot"
      }
    },
    {
      "contentType": "application/json",
      "name": "advanced-example",
      "example": {
        "ref": "topic-branch",
        "auto_merge": false,
        "payload": "{ \"deploy\": \"migrate\" }",
        "description": "Deploy request from hubot",
        "required_contexts": [
          "ci/janky",
          "security/brakeman"
        ]
      }
    }
  ],
  "responseExamples": [
    {
      "status": "202",
      "contentType": "application/json",
      "name": "merged-branch-response",
      "example": {
        "message": "Auto-merged master into topic-branch on deployment."
      }
    }
  ]
}