chore(docs): Add Pydantic models

[Prajna1999]

Issue

Closes #PLEASE_TYPE_ISSUE_NUMBER

Summary

• Before: No Pydantic models were defined.
• Now: Pydantic models have been added.
• Required defining data validation structures.
• Required integration into the existing codebase.

Checklist

Before submitting a pull request, please ensure that you mark these task.

• Ran fastapi run --reload app/main.py or docker compose up in the repository root and test.
• If you've fixed a bug or added code that is tested and has test cases.

Notes

Please add here if any other information is required for the reviewer.

Original PR description

Issue

Closes #PLEASE_TYPE_ISSUE_NUMBER

Summary

Explain the motivation for making this change. What existing problem does the pull request solve?

Checklist

Before submitting a pull request, please ensure that you mark these task.

• Ran fastapi run --reload app/main.py or docker compose up in the repository root and test.
• If you've fixed a bug or added code that is tested and has test cases.

Notes

Please add here if any other information is required for the reviewer.

[github-actions]

OpenAPI changes   🔴 12 breaking changes

Caution

Downstream consumers may need an update before merging.

Breaking changes  ·  12

	Method	Path	Change
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property banned_words
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property description
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property domain
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property name
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property description
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property llm_prompt
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property name
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property validator_name
🔴	POST	/api/v1/guardrails/validators/configs	added the new required request property name
🔴	POST	/api/v1/guardrails/validators/configs	added the new required request property stage
🔴	POST	/api/v1/guardrails/validators/configs	added the new required request property type
🔴	GET	/api/v1/guardrails/{job_id}	added #/components/schemas/GuardrailsCallbackData-Output to the data/anyOf[subschema #1: GuardrailsJobPublic]/guardrails_response response property anyOf list for the response status 200

Full changelog  ·  127

	Method	Path	Change
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property banned_words
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property description
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property domain
🔴	POST	/api/v1/guardrails/ban_lists	added the new required request property name
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property description
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property llm_prompt
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property name
🔴	POST	/api/v1/guardrails/llm_prompt_configs	added the new required request property validator_name
🔴	POST	/api/v1/guardrails/validators/configs	added the new required request property name
🔴	POST	/api/v1/guardrails/validators/configs	added the new required request property stage
🔴	POST	/api/v1/guardrails/validators/configs	added the new required request property type
🔴	GET	/api/v1/guardrails/{job_id}	added #/components/schemas/GuardrailsCallbackData-Output to the data/anyOf[subschema #1: GuardrailsJobPublic]/guardrails_response response property anyOf list for the response status 200
🟢	—	—	removed the schema GuardrailsCallbackData
🟢	—	—	removed the schema GuardrailsCallbackResponse
🟢	—	—	a breaking change was detected but the version is still 0.5.0
🟢	GET	/api/v1/guardrails	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails	added the required property validators to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails/ban_lists	added the optional property data to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists	added the optional property error to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists	added the optional property errors to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists	added the optional property metadata to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists	added the required property success to the response with the 200 status
🟢	POST	/api/v1/guardrails/ban_lists	added the new optional request property is_public
🟢	POST	/api/v1/guardrails/ban_lists	the response's body type was narrowed from any to object for status 200
🟢	POST	/api/v1/guardrails/ban_lists	added the optional property data to the response with the 200 status
🟢	POST	/api/v1/guardrails/ban_lists	added the optional property error to the response with the 200 status
🟢	POST	/api/v1/guardrails/ban_lists	added the optional property errors to the response with the 200 status
🟢	POST	/api/v1/guardrails/ban_lists	added the optional property metadata to the response with the 200 status
🟢	POST	/api/v1/guardrails/ban_lists	added the required property success to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/ban_lists/{ban_list_id}	the response's body type was narrowed from any to object for status 200
🟢	DELETE	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property data to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property error to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property errors to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property metadata to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/ban_lists/{ban_list_id}	added the required property success to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists/{ban_list_id}	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property data to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property error to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property errors to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property metadata to the response with the 200 status
🟢	GET	/api/v1/guardrails/ban_lists/{ban_list_id}	added the required property success to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the new optional request property banned_words
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the new optional request property description
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the new optional request property domain
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the new optional request property is_public
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the new optional request property name
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	the response's body type was narrowed from any to object for status 200
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property data to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property error to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property errors to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the optional property metadata to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/ban_lists/{ban_list_id}	added the required property success to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails/llm_prompt_configs	added the optional property data to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs	added the optional property error to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs	added the optional property errors to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs	added the optional property metadata to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs	added the required property success to the response with the 200 status
🟢	POST	/api/v1/guardrails/llm_prompt_configs	added the new optional request property prompt_schema_version
🟢	POST	/api/v1/guardrails/llm_prompt_configs	the response's body type was narrowed from any to object for status 200
🟢	POST	/api/v1/guardrails/llm_prompt_configs	added the optional property data to the response with the 200 status
🟢	POST	/api/v1/guardrails/llm_prompt_configs	added the optional property error to the response with the 200 status
🟢	POST	/api/v1/guardrails/llm_prompt_configs	added the optional property errors to the response with the 200 status
🟢	POST	/api/v1/guardrails/llm_prompt_configs	added the optional property metadata to the response with the 200 status
🟢	POST	/api/v1/guardrails/llm_prompt_configs	added the required property success to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	the response's body type was narrowed from any to object for status 200
🟢	DELETE	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property data to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property error to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property errors to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property metadata to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the required property success to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property data to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property error to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property errors to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property metadata to the response with the 200 status
🟢	GET	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the required property success to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the new optional request property description
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the new optional request property is_active
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the new optional request property llm_prompt
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the new optional request property name
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the new optional request property prompt_schema_version
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	the response's body type was narrowed from any to object for status 200
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property data to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property error to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property errors to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the optional property metadata to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/llm_prompt_configs/{prompt_config_id}	added the required property success to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails/validators/configs	added the optional property data to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs	added the optional property error to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs	added the optional property errors to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs	added the optional property metadata to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs	added the required property success to the response with the 200 status
🟢	POST	/api/v1/guardrails/validators/configs	added the new optional request property is_enabled
🟢	POST	/api/v1/guardrails/validators/configs	added the new optional request property on_fail_action
🟢	POST	/api/v1/guardrails/validators/configs	the response's body type was narrowed from any to object for status 200
🟢	POST	/api/v1/guardrails/validators/configs	added the optional property data to the response with the 200 status
🟢	POST	/api/v1/guardrails/validators/configs	added the optional property error to the response with the 200 status
🟢	POST	/api/v1/guardrails/validators/configs	added the optional property errors to the response with the 200 status
🟢	POST	/api/v1/guardrails/validators/configs	added the optional property metadata to the response with the 200 status
🟢	POST	/api/v1/guardrails/validators/configs	added the required property success to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/validators/configs/{config_id}	the response's body type was narrowed from any to object for status 200
🟢	DELETE	/api/v1/guardrails/validators/configs/{config_id}	added the optional property data to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/validators/configs/{config_id}	added the optional property error to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/validators/configs/{config_id}	added the optional property errors to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/validators/configs/{config_id}	added the optional property metadata to the response with the 200 status
🟢	DELETE	/api/v1/guardrails/validators/configs/{config_id}	added the required property success to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs/{config_id}	the response's body type was narrowed from any to object for status 200
🟢	GET	/api/v1/guardrails/validators/configs/{config_id}	added the optional property data to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs/{config_id}	added the optional property error to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs/{config_id}	added the optional property errors to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs/{config_id}	added the optional property metadata to the response with the 200 status
🟢	GET	/api/v1/guardrails/validators/configs/{config_id}	added the required property success to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the new optional request property is_enabled
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the new optional request property name
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the new optional request property on_fail_action
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the new optional request property stage
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the new optional request property type
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	the response's body type was narrowed from any to object for status 200
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the optional property data to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the optional property error to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the optional property errors to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the optional property metadata to the response with the 200 status
🟢	PATCH	/api/v1/guardrails/validators/configs/{config_id}	added the required property success to the response with the 200 status
🟢	GET	/api/v1/guardrails/{job_id}	removed #/components/schemas/GuardrailsCallbackData from the data/anyOf[subschema #1: GuardrailsJobPublic]/guardrails_response response property anyOf list for the response status 200

_{main ↔ 29aa6f92 · generated by oasdiff}

[coderabbitai]

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)

• ready-for-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository: ProjectTech4DevAI/kaapi-backend/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 7b8dfeb6-5422-4037-8d3c-b87a819d41fa

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

• 🔍 Trigger review

• Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!