From 3ba743d07de26f42ce2d45202796031656dc08a9 Mon Sep 17 00:00:00 2001 From: Joseph McCarron Date: Wed, 13 May 2026 09:22:54 -0700 Subject: [PATCH] docs(api): drop "in text" from /find and /replace summaries Endpoint summaries get rendered as the headline label in Scalar/Swagger (narrow column, wrapping is ugly) and these endpoints will eventually accept other data types. Shorten: - "Find sensitive data in text" -> "Find sensitive data" - "Replace sensitive data in text" -> "Replace sensitive data" Co-Authored-By: Claude Opus 4.7 (1M context) --- api/src/opf_api/routes.py | 4 ++-- docs/api/openapi.json | 4 ++-- docs/api/openapi.yaml | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/api/src/opf_api/routes.py b/api/src/opf_api/routes.py index f04b8e2..e4bb027 100644 --- a/api/src/opf_api/routes.py +++ b/api/src/opf_api/routes.py @@ -161,7 +161,7 @@ async def _run_find(request: Request, body: _FindInput) -> tuple[str, list[Span] "/find", response_model=FindResponse, tags=["Find"], - summary="Find sensitive data in text", + summary="Find sensitive data", description=( "Run the chosen detector over `text` and return canonical-labelled spans.\n\n" "No rewriting is performed — call `/api/replace` for that.\n\n" @@ -215,7 +215,7 @@ def _build_label_token_renderer_raising_http( "/replace", response_model=ReplaceResponse, tags=["Replace"], - summary="Replace sensitive data in text", + summary="Replace sensitive data", description=( "Find spans, then rewrite each one under the chosen `mode`. Four modes, " "in increasing strength of identity preservation:\n\n" diff --git a/docs/api/openapi.json b/docs/api/openapi.json index 7fff47d..cafb5b8 100644 --- a/docs/api/openapi.json +++ b/docs/api/openapi.json @@ -888,7 +888,7 @@ "description": "Detector backend failure or vault call failure." } }, - "summary": "Find sensitive data in text", + "summary": "Find sensitive data", "tags": [ "Find" ] @@ -1028,7 +1028,7 @@ "description": "Detector backend failure or vault call failure." } }, - "summary": "Replace sensitive data in text", + "summary": "Replace sensitive data", "tags": [ "Replace" ] diff --git a/docs/api/openapi.yaml b/docs/api/openapi.yaml index f4b6877..1b8a3dd 100644 --- a/docs/api/openapi.yaml +++ b/docs/api/openapi.yaml @@ -65,7 +65,7 @@ paths: post: tags: - Find - summary: Find sensitive data in text + summary: Find sensitive data description: 'Run the chosen detector over `text` and return canonical-labelled spans. @@ -152,7 +152,7 @@ paths: post: tags: - Replace - summary: Replace sensitive data in text + summary: Replace sensitive data description: 'Find spans, then rewrite each one under the chosen `mode`. Four modes, in increasing strength of identity preservation: