ProjectTech4DevAI / ProjectTech4DevAI/kaapi-guardrails
Documentation: examples of validators and config for create validator config endpoint
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 5
- Forks
- 3
- Avg merge
- 9d 13h
- Merged PRs (30d)
- 2
Description
Describe the current behaviour
Currently when we use the run guardrails endpoint or create validator config we don't have any documentation with api endpoints that we can refer to which tells us what configuration we have to set for each validator. users will have to read through repo's readme to get to know about validator specific configuration.
Describe the enhancement you'd like
Add documentation in the api itself about sample request body when saving or sending config of all the validators, with their respective config.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the run guardrails and create validator config API endpoints, then compare their configuration requirements with the repository README. Done means the API documentation includes sample request bodies and the respective configuration for all validators.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100