search

CircleCI-Archived / api-preview-docs

In-progress docs about the pre-release preview of CircleCI API v2
72 stars 39 forks source link

Workflow jobs and Workflow runs documentation #90

Closed Fgerthoffert closed 4 years ago

Fgerthoffert commented 4 years ago

Hi,

When calling: https://circleci.com/api/v2/insights/{project-slug}/workflows/{workflow-name}/jobs/{job-name} or https://circleci.com/api/v2/insights/{project-slug}/workflows/{workflow-name}

The documentation specifies credits-used but the payload is actually credits_used (see below).

The payload received is:

    {
      "id": "REMOVED",
      "started_at": "2020-03-19T03:20:55.139Z",
      "stopped_at": "2020-03-19T03:25:23.275Z",
      "duration": 268,
      "status": "success",
      "credits_used": 44
    },
sulami commented 4 years ago

@millerpeterson you might be interested in this.

millerpeterson commented 4 years ago

Thanks I'll fix the docs.

millerpeterson commented 4 years ago

Updated the docs to show the correct field name credits_used.