APIs.io Engineering Platform · Example Payload

Apis Io Engineering Platform Reposupdate Branch Protection Example

APIs.ioEngineeringPlatform

Apis Io Engineering Platform Reposupdate Branch Protection 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/update-branch-protection",
  "method": "PUT",
  "path": "/repos/{owner}/{repo}/branches/{branch}/protection",
  "summary": "APIs.io Engineering Platform Update branch protection",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "default",
      "example": {
        "required_status_checks": {
          "strict": true,
          "contexts": [
            "continuous-integration/travis-ci"
          ]
        },
        "enforce_admins": true,
        "required_pull_request_reviews": {
          "dismissal_restrictions": {
            "users": [
              "octocat"
            ],
            "teams": [
              "justice-league"
            ]
          },
          "dismiss_stale_reviews": true,
          "require_code_owner_reviews": true,
          "required_approving_review_count": 2,
          "require_last_push_approval": true,
          "bypass_pull_request_allowances": {
            "users": [
              "octocat"
            ],
            "teams": [
              "justice-league"
            ]
          }
        },
        "restrictions": {
          "users": [
            "octocat"
          ],
          "teams": [
            "justice-league"
          ],
          "apps": [
            "super-ci"
          ]
        },
        "required_linear_history": true,
        "allow_force_pushes": true,
        "allow_deletions": true,
        "block_creations": true,
        "required_conversation_resolution": true,
        "lock_branch": true,
        "allow_fork_syncing": true
      }
    }
  ],
  "responseExamples": []
}