APIs.io Engineering Platform · Example Payload

Apis Io Engineering Platform Checkscreate Example

APIs.ioEngineeringPlatform

Apis Io Engineering Platform Checkscreate 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": "checks/create",
  "method": "POST",
  "path": "/repos/{owner}/{repo}/check-runs",
  "summary": "APIs.io Engineering Platform Create a check run",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "example-of-in-progress-conclusion",
      "example": {
        "name": "mighty_readme",
        "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
        "status": "in_progress",
        "external_id": "42",
        "started_at": "2018-05-04T01:14:52Z",
        "output": {
          "title": "Mighty Readme report",
          "summary": "",
          "text": ""
        }
      }
    },
    {
      "contentType": "application/json",
      "name": "example-of-completed-conclusion",
      "example": {
        "name": "mighty_readme",
        "head_sha": "ce587453ced02b1526dfb4cb910479d431683101",
        "status": "completed",
        "started_at": "2017-11-30T19:39:10Z",
        "conclusion": "success",
        "completed_at": "2017-11-30T19:49:10Z",
        "output": {
          "title": "Mighty Readme report",
          "summary": "There are 0 failures, 2 warnings, and 1 notices.",
          "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.",
          "annotations": [
            {
              "path": "README.md",
              "annotation_level": "warning",
              "title": "Spell Checker",
              "message": "Check your spelling for 'banaas'.",
              "raw_details": "Do you mean 'bananas' or 'banana'?",
              "start_line": 2,
              "end_line": 2
            },
            {
              "path": "README.md",
              "annotation_level": "warning",
              "title": "Spell Checker",
              "message": "Check your spelling for 'aples'",
              "raw_details": "Do you mean 'apples' or 'Naples'",
              "start_line": 4,
              "end_line": 4
            }
          ],
          "images": [
            {
              "alt": "Super bananas",
              "image_url": "http://example.com/images/42"
            }
          ]
        },
        "actions": [
          {
            "label": "Fix",
            "identifier": "fix_errors",
            "description": "Allow us to fix these errors for you"
          }
        ]
      }
    }
  ],
  "responseExamples": []
}