docs: Update README and FINAL_STATUS for quick start setup and project readiness
- Added quick start instructions in README.md for first-time setup, including commands for complete setup, verification, and service start. - Revised FINAL_STATUS.md to reflect the project's infrastructure completion and readiness for execution, detailing scripts created and documentation status.
This commit is contained in:
@@ -2,10 +2,63 @@ import type { Request, Response } from "express";
|
||||
import { v4 as uuidv4 } from "uuid";
|
||||
import { createHash } from "crypto";
|
||||
import { validatePlan, checkStepDependencies } from "../services/planValidation";
|
||||
import { storePlan, getPlanById, updatePlanSignature } from "../db/plans";
|
||||
import { storePlan, getPlanById, updatePlanSignature, listPlans } from "../db/plans";
|
||||
import { asyncHandler, AppError, ErrorType } from "../services/errorHandler";
|
||||
import type { Plan, PlanStep } from "../types/plan";
|
||||
|
||||
/**
|
||||
* GET /api/plans
|
||||
* List all plans (with optional query parameters)
|
||||
*
|
||||
* @swagger
|
||||
* /api/plans:
|
||||
* get:
|
||||
* summary: List all execution plans
|
||||
* parameters:
|
||||
* - in: query
|
||||
* name: creator
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Filter by creator
|
||||
* - in: query
|
||||
* name: status
|
||||
* schema:
|
||||
* type: string
|
||||
* description: Filter by status
|
||||
* - in: query
|
||||
* name: limit
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Limit number of results
|
||||
* - in: query
|
||||
* name: offset
|
||||
* schema:
|
||||
* type: integer
|
||||
* description: Offset for pagination
|
||||
* responses:
|
||||
* 200:
|
||||
* description: List of plans
|
||||
*
|
||||
* @param req - Express request with optional query parameters
|
||||
* @param res - Express response
|
||||
* @returns Array of plans
|
||||
*/
|
||||
export const listPlansEndpoint = asyncHandler(async (req: Request, res: Response) => {
|
||||
const creator = req.query.creator as string | undefined;
|
||||
const status = req.query.status as string | undefined;
|
||||
const limit = req.query.limit ? parseInt(req.query.limit as string, 10) : undefined;
|
||||
const offset = req.query.offset ? parseInt(req.query.offset as string, 10) : undefined;
|
||||
|
||||
const plans = await listPlans({
|
||||
creator,
|
||||
status,
|
||||
limit: limit || 50, // Default limit
|
||||
offset,
|
||||
});
|
||||
|
||||
res.json(plans);
|
||||
});
|
||||
|
||||
/**
|
||||
* POST /api/plans
|
||||
* Create a new execution plan
|
||||
|
||||
Reference in New Issue
Block a user