GIgitcafe
Issues

Close an issue

Close an issue. Requires authenticated authority and enforces current resource policy.

post/api/repos/{owner}/{repo}/issues/{issue}/close

Request

  • Base URL
    https://git.cafe
  • Auth
    • API key in cookie gc-session
    • or HTTP bearer
    • or HTTP basic
    • or HTTP token
    • or OAuth 2
      Authorization code: /api/oauth/authorize
      Token URL: /api/oauth/token scopes: issue:contents:write

Path parameters

ownerstring required
repostring required
issuestring required

Request body

expectedVersioninteger required
state'completed' | 'canceled'
reasonstring nullable

Response

Response for status 200

idstring required
repoIdstring required
numberinteger required
titlestring required
descriptionstring nullable required
versioninteger required
stateType'triage' | 'backlog' | 'unstarted' | 'started' | 'completed' | 'canceled' required
priorityinteger required
authorActorIdstring required
authorDelegatorActorIdstring required
authorViaInstallationIdstring nullable required
dueDatestring date-time nullable required
closedAtstring date-time nullable required
closedByActorIdstring required
closedByDelegatorActorIdstring required
closedByViaInstallationIdstring nullable required
closedReasonstring nullable required
milestoneIdstring nullable required
lockedAtstring date-time nullable required
lockedByActorIdstring required
lockReasonstring nullable required
pinnedAtstring date-time nullable required
pinnedByActorIdstring required
pinSlotinteger nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.