Skip to content

docs(api): drop "in text" from /find and /replace summaries #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jstjoe merged 1 commit into from
May 13, 2026
Merged

docs(api): drop "in text" from /find and /replace summaries #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions api/src/opf_api/routes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down
4 changes: 2 additions & 2 deletions docs/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,7 @@
"description": "Detector backend failure or vault call failure."
}
},
"summary": "Find sensitive data in text",
"summary": "Find sensitive data",
"tags": [
"Find"
]
Expand Down Expand Up @@ -1028,7 +1028,7 @@
"description": "Detector backend failure or vault call failure."
}
},
"summary": "Replace sensitive data in text",
"summary": "Replace sensitive data",
"tags": [
"Replace"
]
Expand Down
4 changes: 2 additions & 2 deletions docs/api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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:

Expand Down
Loading