Organisations
Read the style of an organisation's diagrams
The spacing and line shape of the flow diagrams drawn for the organisation on the hosted service, each members (each member's own) or a value.
GET
/orgs/{org}/styleTL;DR
| Question | Answer |
|---|---|
| What does it do? | Read the style of an organisation's diagrams. |
| What does it take? | org in the path. |
| What does it return? | Status 200 with a body of type OrganisationStyle. |
| 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
The spacing and line shape of the flow diagrams drawn for the organisation on the hosted service, each members (each member's own) or a value. 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. | OrganisationStyle |
| 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 OrganisationStyle.
| Field | Type | Required | Description |
|---|---|---|---|
spacing | "members" | "compact" | "normal" | "roomy" | yes | How far apart the boxes sit: compact, normal, or roomy, or members (each member's own choice, the default). |
edges | "members" | "orthogonal" | "spline" | "straight" | yes | How the lines are drawn: orthogonal (straight runs, rounded corners), spline (curves), or straight (slanted), or members (each member's own choice, the default). |
allowed | object | yes | The values each part may take, every value by default. A diagram that asks for another (by its header, a repository's plotwork.config.json, a member's own choice or an agent) is drawn with an allowed one, with warning S205; a list of one requires it. |
allowed.spacing | ("compact" | "normal" | "roomy")[] | yes | |
allowed.edges | ("orthogonal" | "spline" | "straight")[] | yes |
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 |