github.updateissueprops
Home > @runlightyear/github > UpdateIssueProps
UpdateIssueProps interface
Signature:interface UpdateIssueProps
Required Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| issueNumber | number | The number that identifies the issue. | |
| owner | string | The account owner of the repository. The name is not case sensitive. | |
| repo | string | The name of the repository. The name is not case sensitive. |
Optional Properties
| Property | Modifiers | Type | Description |
|---|---|---|---|
| assignees? | Array<string> | Logins for Users to assign to this issue. Pass one or more user logins to replace the set of assignees on this Issue. Send an empty array ([]) to clear all assignees from the Issue. NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise. | |
| body? | string | null | The contents of the issue. | |
| labels? | Array<string> | Array<object> | Labels to associate with this issue. Pass one or more Labels to replace the set of Labels on this Issue. Send an empty array ([]) to clear all Labels from the Issue. NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise. | |
| milestone? | string | number | null | The number of the milestone to associate this issue with or null to remove current. NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise. | |
| state? | "open" | "closed" | State of the issue. | |
| stateReason? | "completed" | "not_planned" | "reopened" | null | The reason for the current state | |
| title? | string | number | null | The title of the issue. |