mirror of
https://github.com/gristlabs/grist-core.git
synced 2026-03-02 04:09:24 +00:00
f7fdfab6bf
Summary:
Rework of endpoint GET for webhooks to make it coherent with other endpoints. Now data should be return in {webhooks:[{id:"...",fields:{"..."}]} format
```
{
"webhooks": [
{
"id": ...
"fields": {
"url": ...
"unsubscribeKey": ...
"eventTypes": [
"add",
"update"
],
"isReadyColumn": null,
"tableId": "...",
"enabled": false,
"name": "...",
"memo": "..."
},
"usage": {
"status": "idle",
"numWaiting": 0,
"lastEventBatch": null
}
},
{
"id": "...",
"fields": {
"url": "...",
"unsubscribeKey": "...",
"eventTypes": [
"add",
"update"
],
"isReadyColumn": null,
"tableId": "...",
"enabled": true,
"name": "...",
"memo": "..."
},
"usage": {
"status": "error",
"numWaiting": 0,
"updatedTime": 1689076978098,
"lastEventBatch": {
"status": "rejected",
"httpStatus": 404,
"errorMessage": "{\"success\":false,\"error\":{\"message\":\"Alias 5a9bf6a8-4865-403a-bec6-b4ko not found\",\"id\":null}}",
"size": 49,
"attempts": 5
},
"lastSuccessTime": null,
"lastFailureTime": 1689076978097,
"lastErrorMessage": "{\"success\":false,\"error\":{\"message\":\"Alias 5a9bf6a8-4865-403a-bec6-b4ko not found\",\"id\":null}}",
"lastHttpStatus": 404
}
}
]
}
```
Test Plan: new test added to check if GET data fromat is correct. Other tests fixed to handle changed endpoint.
Reviewers: paulfitz
Reviewed By: paulfitz
Differential Revision: https://phab.getgrist.com/D3966
107 lines
3.0 KiB
TypeScript
107 lines
3.0 KiB
TypeScript
/**
|
|
* This module was automatically generated by `ts-interface-builder`
|
|
*/
|
|
import * as t from "ts-interface-checker";
|
|
// tslint:disable:object-literal-key-quotes
|
|
|
|
export const WebhookSubscribeCollection = t.iface([], {
|
|
"webhooks": t.array("Webhook"),
|
|
});
|
|
|
|
export const Webhook = t.iface([], {
|
|
"fields": "WebhookFields",
|
|
});
|
|
|
|
export const WebhookFields = t.iface([], {
|
|
"url": "string",
|
|
"eventTypes": t.array(t.union(t.lit("add"), t.lit("update"))),
|
|
"tableId": "string",
|
|
"enabled": t.opt("boolean"),
|
|
"isReadyColumn": t.opt(t.union("string", "null")),
|
|
"name": t.opt("string"),
|
|
"memo": t.opt("string"),
|
|
});
|
|
|
|
export const WebhookBatchStatus = t.union(t.lit('success'), t.lit('failure'), t.lit('rejected'));
|
|
|
|
export const WebhookStatus = t.union(t.lit('idle'), t.lit('sending'), t.lit('retrying'), t.lit('postponed'), t.lit('error'), t.lit('invalid'));
|
|
|
|
export const WebhookSubscribe = t.iface([], {
|
|
"url": "string",
|
|
"eventTypes": t.array(t.union(t.lit("add"), t.lit("update"))),
|
|
"enabled": t.opt("boolean"),
|
|
"isReadyColumn": t.opt(t.union("string", "null")),
|
|
"name": t.opt("string"),
|
|
"memo": t.opt("string"),
|
|
});
|
|
|
|
export const WebhookSummaryCollection = t.iface([], {
|
|
"webhooks": t.array("WebhookSummary"),
|
|
});
|
|
|
|
export const WebhookSummary = t.iface([], {
|
|
"id": "string",
|
|
"fields": t.iface([], {
|
|
"url": "string",
|
|
"unsubscribeKey": "string",
|
|
"eventTypes": t.array("string"),
|
|
"isReadyColumn": t.union("string", "null"),
|
|
"tableId": "string",
|
|
"enabled": "boolean",
|
|
"name": "string",
|
|
"memo": "string",
|
|
}),
|
|
"usage": t.union("WebhookUsage", "null"),
|
|
});
|
|
|
|
export const WebhookUpdate = t.iface([], {
|
|
"id": "string",
|
|
"fields": "WebhookPatch",
|
|
});
|
|
|
|
export const WebhookPatch = t.iface([], {
|
|
"url": t.opt("string"),
|
|
"eventTypes": t.opt(t.array(t.union(t.lit("add"), t.lit("update")))),
|
|
"tableId": t.opt("string"),
|
|
"enabled": t.opt("boolean"),
|
|
"isReadyColumn": t.opt(t.union("string", "null")),
|
|
"name": t.opt("string"),
|
|
"memo": t.opt("string"),
|
|
});
|
|
|
|
export const WebhookUsage = t.iface([], {
|
|
"numWaiting": "number",
|
|
"status": "WebhookStatus",
|
|
"updatedTime": t.opt(t.union("number", "null")),
|
|
"lastSuccessTime": t.opt(t.union("number", "null")),
|
|
"lastFailureTime": t.opt(t.union("number", "null")),
|
|
"lastErrorMessage": t.opt(t.union("string", "null")),
|
|
"lastHttpStatus": t.opt(t.union("number", "null")),
|
|
"lastEventBatch": t.opt(t.union("null", t.iface([], {
|
|
"size": "number",
|
|
"errorMessage": t.union("string", "null"),
|
|
"httpStatus": t.union("number", "null"),
|
|
"status": "WebhookBatchStatus",
|
|
"attempts": "number",
|
|
}))),
|
|
"numSuccess": t.opt(t.iface([], {
|
|
"pastHour": "number",
|
|
"past24Hours": "number",
|
|
})),
|
|
});
|
|
|
|
const exportedTypeSuite: t.ITypeSuite = {
|
|
WebhookSubscribeCollection,
|
|
Webhook,
|
|
WebhookFields,
|
|
WebhookBatchStatus,
|
|
WebhookStatus,
|
|
WebhookSubscribe,
|
|
WebhookSummaryCollection,
|
|
WebhookSummary,
|
|
WebhookUpdate,
|
|
WebhookPatch,
|
|
WebhookUsage,
|
|
};
|
|
export default exportedTypeSuite;
|