Organisations
Read the legend of an organisation's diagrams
members (each member's own), on, off, or required, for the flow diagrams drawn for the organisation on the hosted service.
GET
/orgs/{org}/legendTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read the legend of an organisation's diagrams. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrganisationLegend. |
| What can go wrong? | 401 not signed in; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
members (each member's own), on, off, or required, for the flow diagrams drawn for the organisation on the hosted service. A session, or a key of the organisation, so a GitHub Action run reads it.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The choice. | OrganisationLegend |
| 401 | Not signed in. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type OrganisationLegend.
| Field | Type | Required | Description |
|---|---|---|---|
legend | "members" | "on" | "off" | "required" | yes | The legend of flow diagrams drawn for the organisation on the hosted service: members (each member's own choice, the default), on or off (a repository's plotwork.config.json and a diagram's header still win), or required (drawn whatever a repository or a header says). |
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 |