APIs.io Engineering Platform · Example Payload

Apis Io Engineering Platform Pullsmerge Example

APIs.ioEngineeringPlatform

Apis Io Engineering Platform Pullsmerge 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": "pulls/merge",
  "method": "PUT",
  "path": "/repos/{owner}/{repo}/pulls/{pull_number}/merge",
  "summary": "APIs.io Engineering Platform Merge a pull request",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "response-if-merge-was-successful",
      "example": {
        "commit_title": "Expand enum",
        "commit_message": "Add a new value to the merge_method enum"
      }
    }
  ],
  "responseExamples": [
    {
      "status": "405",
      "contentType": "application/json",
      "name": "response-if-merge-cannot-be-performed",
      "example": {
        "message": "Pull Request is not mergeable"
      }
    },
    {
      "status": "409",
      "contentType": "application/json",
      "name": "response-if-sha-was-provided-and-pull-request-head-did-not-match",
      "example": {
        "message": "Head branch was modified. Review and try the merge again."
      }
    }
  ]
}