Documentation: examples of validators and config for create validator config endpoint
Maintainers usually reply within 10 days
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- api, documentation
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.
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.
- Dominant language
- Python
- Stars
- 5
- Forks
- 4
- Avg merge
- 9d 13h
- Merged PRs (30d)
- 2
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
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.
More from ProjectTech4DevAI/kaapi-guardrails
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
ProjectTech4DevAI/kaapi-guardrails#94 ·
Maintainers usually reply within 10 days
-
Difficulty 1/5 Under an hour Newbie friendliness 65/100
ProjectTech4DevAI/kaapi-guardrails#23 ·
Maintainers usually reply within 10 days
-
Callback Enhancement: Include intermediate responsesPossibly taken @Prajna1999 claimed this 23 days ago. Open
ProjectTech4DevAI/kaapi-guardrails#158 · 1 assignee ·
Maintainers usually reply within 10 days
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
ProjectTech4DevAI/kaapi-guardrails#144 ·
Maintainers usually reply within 10 days
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
ProjectTech4DevAI/kaapi-guardrails#137 ·
Maintainers usually reply within 10 days
All issues in ProjectTech4DevAI/kaapi-guardrails
Similar issues
-
comp/tools duplicate P2 sweeper:risk-compatibility tool/mcp type/bug
Difficulty 1/5 Under an hour Newbie friendliness 88/100
NousResearch/hermes-agent#132042 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
deepset-ai/haystack#13092 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
EverMind-AI/Raven#845 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
AstrBotDevs/AstrBot#10340 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
BasedHardware/omi#20401 · 1 comment ·
Maintainers usually reply within 1 day