@cognigy/rest-api-client
Version:
Cognigy REST-Client
59 lines • 2.35 kB
JavaScript
/* Custom modules */
import { createQuerySchema } from "../../helper/createQuerySchema";
import { entityMetaSchema } from "./IEntityMeta";
export const playbookRunStatus = ["successful", "failed"];
export const playbookRunStepResultAssertSchema = {
title: "playbookRunStepResultAssertSchema",
type: "object",
additionalProperties: false,
properties: {
_id: { type: "string", format: "mongo-id" },
type: { type: "string", maxLength: 200 },
params: { type: "object" },
actual: { type: "object" },
status: { type: "string", enum: [...playbookRunStatus] }
}
};
export const playbookRunStepResultSchema = {
title: "playbookRunStepResultSchema",
type: "object",
additionalProperties: false,
properties: {
_id: { type: "string", format: "mongo-id" },
status: { type: "string", enum: [...playbookRunStatus] },
text: { type: "string", maxLength: 1000 },
data: { type: "object" },
asserts: {
type: "array",
maxItems: 20,
items: playbookRunStepResultAssertSchema
},
timeout: { type: "boolean" }
}
};
/**
* We don't need a 'playbookRunDataSchema' as we won't allow building
* an API to update a playbook run.
*/
export const playbookRunDataSchema = {
title: "playbookRunDataSchema",
type: "object",
additionalProperties: true,
properties: {
status: { type: "string", enum: [...playbookRunStatus] },
stepResults: {
type: "array",
maxItems: 50,
items: playbookRunStepResultSchema
},
playbookReference: { type: "string", format: "mongo-id" },
}
};
export const playbookRunSchema = {
title: "playbookRunSchema",
type: "object",
additionalProperties: true,
properties: Object.assign(Object.assign(Object.assign({}, playbookRunDataSchema.properties), entityMetaSchema.properties), { entrypoint: { type: "string", format: "mongo-id" }, localeId: { type: "string", format: "uuid" }, flowId: { type: "string", format: "uuid" }, projectReference: { type: "string", format: "mongo-id" }, organisationReference: { type: "string", format: "mongo-id" } })
};
export const playbookRunQuerySchema = createQuerySchema("playbookRunQuerySchema", playbookRunSchema);
//# sourceMappingURL=IPlaybookRun.js.map