Skip to content
Pando

Edit, label, assign, link, close or reopen an issue

Any of the fields, in one call; each change is its own timeline item and the call is one event. Add and remove lists are set operations. state: closed takes state_reason (default completed); setting the state it already has changes nothing. body with base_version is refused with 409 edited (and current) when the body moved; without it the last writer wins.

PATCH
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/issues/{number}
View as Markdown

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}$
  • numberintegerrequired
    minimum: 1

Request bodyJSONrequired

  • titleoptionalstring
    maxLength: 256, minLength: 1
  • bodyoptionalstring
    maxLength: 65536
  • base_versionoptionalinteger
  • projectoptionalstring | null
  • stateoptionalopenorclosed
  • state_reasonoptionalcompletedornot_planned
  • add_labelsoptionalarray ofstring
  • remove_labelsoptionalarray ofstring
  • add_assigneesoptionalarray ofstring
  • remove_assigneesoptionalarray ofstring

Returns

200

The issue now.

JSON
  • numberintegerrequired
  • titlestringrequired
  • stateopenorclosedrequired
  • state_reasoncompletedornot_plannedornullrequired
  • projectstring | nullrequired

    A repo's name; null for the monorepo as a whole.

  • project_pathstring | nullrequired
  • labelsarray ofobjectrequired
    3 properties
    • namestringrequired

      1 to 50 characters, unique ignoring case.

    • colorgrayororangeoryelloworgreenortealorblue+2 morerequired

      Each theme sets the eight from its own tokens (no red, so a label never reads as a failure).

    • descriptionstring | nullrequired
  • assigneesarray ofstringrequired
  • authorstringrequired
  • commentsintegerrequired
  • tasksobject | nullrequired

    - [ ] and - [x] lines in the body; null without a task list.

    2 properties
    • doneoptionalinteger
    • totaloptionalinteger
  • linked_branchesintegerrequired
  • created_atstringrequired
    format: date-time
  • updated_atstringrequired
    format: date-time
  • closed_atstring | nullrequired
    format: date-time
  • closed_bystring | nullrequired
  • closed_by_mergeIssueMergeornullrequired
    2 variants

    One of the following:

  • bodystringrequired
  • body_versionintegerrequired

    Goes up by one on every body edit.

  • machinestring | nullrequired

    The machine that opened it.

  • participantsarray ofstringrequired
  • reactionsarray ofobjectrequired

    Those given at least once, in GitHub's order.

    3 properties
    • content+1or-1orlaughorhoorayorconfusedorheart+2 morerequired
    • countintegerrequired
    • byarray ofstringrequired

      Logins

400

An error

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
    • messagestringrequired
    • pathsoptionalarray ofstring
    • checksoptionalobject

      GitHub's combined status, plus the required contexts and which are missing.

      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

404

An error

JSON
  • errorobjectrequired
    4 properties
    • codestringrequired
    • messagestringrequired
    • pathsoptionalarray ofstring
    • checksoptionalobject

      GitHub's combined status, plus the required contexts and which are missing.

      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

409

edited: the body moved since base_version; current is the issue now.

413

too_large.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close