Organisations
Choose the style of an organisation's diagrams
The spacing, the line shape, or both, for the flow diagrams drawn for the organisation on the hosted service.
PUT
/orgs/{org}/styleTL;DR
| Question | Answer |
|---|---|
| What does it do? | Choose the style of an organisation's diagrams. |
| What does it take? | A JSON body of type SetOrganisationStyleBody. |
| What does it return? | Status 200 with a body of type OrganisationStyle. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 the role may not (orgs.forbidden), or the request came from an origin that may not make changes; 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, the line shape, or both, for the flow diagrams drawn for the organisation on the hosted service. The owner or an admin.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type SetOrganisationStyleBody.
| Field | Type | Required | Description |
|---|---|---|---|
spacing | "members" | "compact" | "normal" | "roomy" | no | |
edges | "members" | "orthogonal" | "spline" | "straight" | no | |
allowed | object | no | |
allowed.spacing | ("compact" | "normal" | "roomy")[] | no | |
allowed.edges | ("orthogonal" | "spline" | "straight")[] | no |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The choice now. | OrganisationStyle |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The role may not (orgs.forbidden), or the request came from an origin that may not make changes. | 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 |