Skip to content

The project's main (its commit, checks or not built, the newest build on main) and its latest release

GET
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/repos/{repo}/summary

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Path parameters

  • ownerstringrequired

    The monorepo's owner, a namespace (a person's login or an organization). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
  • monorepostringrequired

    The monorepo's name within its owner (or an old name). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$
  • repostringrequired

    The repo's name (projects-web).

Returns

200

OK

JSON
  • repostringrequired
  • mainobjectrequired
    6 properties
    • branchstringrequired
    • shastring | nullrequired

      Null for an empty repo.

    • titlestring | nullrequired
    • statesuccessorpendingorfailureorerrorormissingorunknown+1 morerequired

      A commit's checks as a build state: Checks' state, or not_built when nothing reported on it and nothing is required (never green).

    • checksChecksornullrequired
      2 variants

      One of the following:

      • Checks
        6 properties
        • shastring | nullrequired
        • statesuccessorpendingorfailureorerrorormissingorunknownrequired

          success when the merge gate passes; missing when a required context has not reported; unknown while the required checks are (an unforced merge is refused).

        • requiredarray | nullrequired

          Null while unknown.

        • checks_unknownstring | nullrequired

          Why the required checks are unknown, in plain words: "Pando couldn't read this monorepo's required checks; try again", or "pando.toml line 3: expected comma or end of structure; fix it on main, or merge with force". Null otherwise.

        • statusesarray ofobjectrequired

          The latest status per context.

          8 properties
          • shastringrequired
          • contextstringrequired
          • statependingorsuccessorfailureorerrorrequired
          • created_atstringrequired
            format: date-time
          • target_urloptionalstring | null
          • descriptionoptionalstring | null
          • creatoroptionalstring

            The member who posted it (a login); app:<slug> for a status posted with a status token or by a CI integration; hook:<hook id> for a status token from a web hook with no app.

          • appoptionalstring | null

            The CI service that reported it (buildkite, github-actions, ...), stamped by Pando from a status token or a CI integration, never from the body or target_url. Null when a member posted it with their own credential. The web shows the service's mark for a slug it knows.

        • missingoptionalarray ofstring
      • null
    • buildCiBuildornullrequired

      The newest build on main, whatever its commit.

      2 variants

      One of the following:

      • CiBuild
        19 properties
        • idstringrequired

          Pando's id (cib_...).

        • servicestringrequired
        • connectionstringrequired
        • pipelinestringrequired
        • numberintegerrequired
        • repostringrequired
        • shastring | nullrequired

          Null when the service built no fixed commit.

        • statequeuedorrunningorblockedorpassedorfailedorcanceled+1 morerequired

          One vocabulary for every service. Buildkite's scheduled and waiting are queued, failing and canceling are running, not_run and broken are skipped; service_state keeps the service's own word.

        • service_statestringrequired
        • created_atstring | nullrequired
          format: date-time
        • repo_pathoptionalstring | null
        • branchoptionalstring | null
        • messageoptionalstring | null
        • web_urloptionalstring | null
        • pushed_byoptionalstring | null

          Who pushed the commit (a login), from Pando's own records; never the service's creator.

        • started_atoptionalstring | null
          format: date-time
        • finished_atoptionalstring | null
          format: date-time
        • duration_soptionalinteger | null
        • rebuilt_fromoptionalstring | null

          The service's id of the build this one rebuilt.

      • null
  • latest_releaseobject | nullrequired
    5 properties
    • tagstringrequired
    • titlestringrequired
    • shastringrequired
    • published_atstringrequired
      format: date-time
    • published_bystringrequired
Navigation

Type to search…

↑↓ navigate↵ selectEsc close