Organisations
Read one request for approval, with what changed
The request, and for a new version what changed against the one the library shows (compare_diagrams).
GET
/orgs/{org}/approvals/{id}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Read one request for approval, with what changed. |
| What does it take? | org, id in the path. |
| What does it return? | Status 200 with a body of type ApprovalRequestDetail. |
| What can go wrong? | 401 not signed in; 403 the caller does not approve (orgs.forbidden); 404 no such organisation or request, or the request is about a diagram in a folder the caller may not use; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
The request, and for a new version what changed against the one the library shows (compare_diagrams). Approvers only.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The request and its diff. | ApprovalRequestDetail |
| 401 | Not signed in. | ErrorResponse |
| 403 | The caller does not approve (orgs.forbidden). | ErrorResponse |
| 404 | No such organisation or request, or the request is about a diagram in a folder the caller may not use. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type ApprovalRequestDetail.
| Field | Type | Required | Description |
|---|---|---|---|
item | ApprovalRequest | yes | |
item.id | string | yes | |
item.kind | "publish" | "change" | "share" | yes | |
item.status | "pending" | "approved" | "rejected" | "expired" | yes | |
item.diagram | object | null | yes | The diagram as the library has it now, or null once it is gone (a rejected new diagram). |
item.diagram.id | string | yes | |
item.diagram.name | string | null | yes | |
item.diagram.folder | string | null | yes | |
item.diagram.classification | Classification | yes | A diagram's classification label: public, internal (the default, and what a diagram published before labels reads as) or confidential. Confidential is never shared publicly; under "Share only diagrams labelled Public" only public is. |
item.diagram.theme | "light" | "dark" | "auto" | yes | |
item.requestedBy | object | null | yes | Who asked, or null for an organisation key and once the account is gone. |
item.requestedBy.userId | string | yes | |
item.requestedBy.email | string | yes | |
item.requestedAt | integer | yes | |
item.expiresAt | integer | yes | |
item.secretFindings | integer | yes | How many things that look like a secret the scan found when the request was made, under the organisation's scanning options. minimum 0. |
item.reviewedBy | object | null | yes | |
item.reviewedBy.userId | string | yes | |
item.reviewedBy.email | string | yes | |
item.reviewedAt | integer | null | yes | |
item.comment | string | null | yes | The approver's comment, when they gave one. |
diff | object | null | yes | For a new version: what changed against the one the library shows, by meaning (compare_diagrams). Null for a publish and a share. |
diff.same | boolean | yes | |
diff.compared | boolean | yes | False when a side carries no source, so nothing could be compared. |
diff.counts | object | yes | |
diff.counts.added | integer | yes | |
diff.counts.removed | integer | yes | |
diff.counts.renamed | integer | yes | |
diff.counts.moved | integer | yes | |
diff.counts.changed | integer | yes | |
diff.changes | object[] | yes | |
diff.changes[].change | string | yes | |
diff.changes[].subject | string | yes | |
diff.changes[].name | string | yes | |
diff.changes[].line | integer | null | yes | |
diff.changes[].detail | string | yes | |
diff.truncated | boolean | yes | |
diff.summary | string | 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 |