Kong / Kong/developer.konghq.com
AI Gateway: Document AI Sanitizer plugin external PII service interface
- Dominant language
- Ruby
- Stars
- 28
- Forks
- 121
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 313
Description
## Info
The AI Sanitizer plugin docs mention that users can swap the default PII detection image for their own, but do not document the contract a custom service must implement to work with the plugin.
Add an interface reference covering:
- Endpoints the plugin calls (paths, methods)
- Request payload format the plugin sends
- Expected response payload format (including how sanitized values are returned)
- Authentication expectations
- Whether credential sanitization uses a separate contract from PII sanitization
## DoD
- Reference section added to the AI Sanitizer plugin docs documenting the full plugin-to-service contract
- Users can build and validate a custom PII service implementation from the docs alone
- Existing mention of swappable images links to the new reference
## Size
S
Contributor guide
No contributing guide indexed for this repository
Research direction
Start with the AI Sanitizer plugin documentation and locate the existing mention of swappable PII detection images. Document the plugin's endpoints, methods, request and response payloads, authentication, and credential-sanitization distinction, then link that reference from the existing mention. Done when a user can build and validate a custom PII service from the docs alone.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100