Organisations
Read the committed picture of one diagram
The SVG committed beside a diagram drawn from code, read from the default branch through the GitHub App and never stored.
GET
/orgs/{org}/evidence/pictureTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read the committed picture of one diagram. |
| What does it take? | org in the path, and repository, name in the query string. |
| What does it return? | Status 200 with no body. |
| What can go wrong? | 400 the query is not valid; 401 not signed in; 403 a plan without compliance evidence (plan.compliance_evidence_not_included); 404 no picture for the diagram (evidence.diagram_not_found), or no such organisation; 429 too many requests, or GitHub asked to wait; 502 GitHub did not answer as expected (github.unavailable); 503 the GitHub App is not set up here. Every failure uses the one error envelope. |
What it does
The SVG committed beside a diagram drawn from code, read from the default branch through the GitHub App and never stored. Every member, on Enterprise.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Query parameters
| Field | Type | Required | Description |
|---|---|---|---|
repository | string | yes | The repository, as owner/name. |
name | string | yes | The source's name. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The picture. | none |
| 400 | The query is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | A plan without compliance evidence (plan.compliance_evidence_not_included). | ErrorResponse |
| 404 | No picture for the diagram (evidence.diagram_not_found), or no such organisation. | ErrorResponse |
| 429 | Too many requests, or GitHub asked to wait. | ErrorResponse |
| 502 | GitHub did not answer as expected (github.unavailable). | ErrorResponse |
| 503 | The GitHub App is not set up here. | ErrorResponse |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |