From 8df6b7fd85618a1d6a9409347773da1ff75409b4 Mon Sep 17 00:00:00 2001 From: Angela Liss <59097311+angela-tarantula@users.noreply.github.com> Date: Wed, 8 Apr 2026 08:04:35 -0400 Subject: [PATCH] update readme --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d485aa9..3c0c3c9 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,10 @@ + ## About The Project @@ -25,6 +27,10 @@ LLM-generated patch payloads. - **Input Safety**: patch operations are Pydantic models, so malformed payloads fail fast with clear, structured errors. +- **FastAPI Native**: set up PATCH routes quickly with minimal boilerplate, with + optional `application/json-patch+json` enforcement and a recommended HTTP + error mapping. + ### It also provides extensibility beyond the RFC - **Richer Operations**: define custom patch operations such as `increment`, @@ -50,14 +56,6 @@ LLM-generated patch payloads. - **Lifecycle Management**: evolve operation contracts over time with additive schema changes and deprecations. -### Integrates cleanly with FastAPI - -- **Protocol Enforcement**: require `application/json-patch+json` and publish - accurate request schemas with examples in OpenAPI. - -- **Predictable Failures**: patch errors map to consistent HTTP responses (422, - 409, 415) with structured details. - ## Getting Started ### Installation