Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions INITIAL-8.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,24 @@
- request validation
- response_model-enforced outputs
- OpenAPI export generation (also used as a RAG source).
- Job-Driven Orchestration: - Asynchronous task pattern (POST returns job_id, GET polls status).
- Standardized Job statuses: PENDING | RUNNING | COMPLETED | FAILED.
- Dimension Discovery:
- Metadata endpoints for Store and Product catalogs (names, categories, IDs).
- Standardized API Protocols:
- Unified filtering, sorting, and pagination schemas (Mixin pattern).
- Semantic Error responses with domain-specific error codes (RFC 7807).
- AI-Enhanced Documentation:
- Rich OpenAPI metadata optimized for LLM tool-calling and RAG indexing.
- Agent-First API Design:
  - Rich OpenAPI metadata (Pydantic Field descriptions) for RAG indexing.
  - Discovery endpoints for Store/Product metadata resolution.
- Asynchronous Task Protocol:
  - Unified Job Status API (job_id tracking) for long-running ForecastOps.
- Robust Error Handling:
  - Semantic error codes (RFC 7807) to enable Agent-led troubleshooting.
- Scalable Data Access:
  - Standardized Pagination and Filtering mixins for consistent tool-calling.

## EXAMPLES:
- `examples/api/train.http`
Expand Down
Loading