Appearance
github.installation.permission_readiness ​
Refresh and check whether a GitHub App installation satisfies delivery permissions.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-github |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
actor | string | No | — | — |
workflow_run_id | string | No | — | — |
github_connection_uuid | uuid | No | — | — |
repository | string | Yes | — | — |
required_permissions | dict | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
status | string | No | — | — |
ready | boolean | No | — | — |
repository | string | No | — | — |
github_connection_uuid | uuid | No | — | — |
github_installation_ref | integer | No | — | — |
connection_status | string | No | — | — |
repository_selection | string | No | — | — |
required_permissions | dict | No | — | — |
installed_permissions | dict | No | — | — |
missing_permissions | list | No | — | — |
permission_source | string | No | — | — |
observed_at | string | No | — | — |
warnings | list | No | — | — |
failure_reason | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "github.installation.permission_readiness",
"initial_data": {
"organization_uuid": "value",
"repository": "value"
}
}