Organisations
Turn the legend of your diagrams on or off
on or off, for the flow diagrams you draw on the hosted service when no organisation decides it.
PUT
/user/legendTL;DR
| Question | Answer |
|---|---|
| What does it do? | Turn the legend of your diagrams on or off. |
| What does it take? | A JSON body of type SetUserLegendBody. |
| What does it return? | Status 200 with a body of type UserLegend. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 the request came from an origin that may not make changes; 429 too many requests. Every failure uses the one error envelope. |
What it does
on or off, for the flow diagrams you draw on the hosted service when no organisation decides it.
Request body
The body has the type SetUserLegendBody.
| Field | Type | Required | Description |
|---|---|---|---|
legend | "on" | "off" | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The choice now. | UserLegend |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The request came from an origin that may not make changes. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 200 answer has the type UserLegend.
| Field | Type | Required | Description |
|---|---|---|---|
legend | "on" | "off" | yes | The legend of flow diagrams you draw on the hosted service, on (the default) or off, when no organisation decides it. A repository's plotwork.config.json and a diagram's header still win. |
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 |