hotfix(agents-api): fix in docs routes

[HamadaSalhab]

PR Type

Bug fix, Documentation

---

Description

• Added connection_pool parameter as a placeholder in two API routes.

• Simplified and updated Table of Contents in multiple README files.

• Removed unused or redundant TOC entries across documentation files.

• Marked connection_pool as a placeholder to be removed later.

---

Changes walkthrough 📝

	Relevant files
Bug fix	create_doc.py Added placeholder `connection_pool` parameter in create_doc route agents-api/agents_api/routers/docs/create_doc.py Added connection_pool parameter as a placeholder. Marked it with a FIXME comment for future removal. +1/-0      search_docs.py Added placeholder `connection_pool` parameter in search_docs route agents-api/agents_api/routers/docs/search_docs.py Added connection_pool parameter as a placeholder. Marked it with a FIXME comment for future removal. +2/-0
Documentation	README-CN.md Updated and simplified TOC in Chinese README                          README-CN.md Simplified and updated Table of Contents structure. Removed redundant or unused TOC entries. Adjusted formatting for consistency. +27/-39  README-FR.md Updated and simplified TOC in French README                            README-FR.md Simplified and updated Table of Contents structure. Removed redundant or unused TOC entries. Adjusted formatting for consistency. +29/-36  README-JA.md Updated and simplified TOC in Japanese README                        README-JA.md Simplified and updated Table of Contents structure. Removed redundant or unused TOC entries. Adjusted formatting for consistency. +29/-39  README.md Updated and simplified TOC in main README                                README.md Simplified and updated Table of Contents structure. Removed redundant or unused TOC entries. Adjusted formatting for consistency. +0/-7

---

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

---

Important

Adds connection_pool parameter as a placeholder in document creation and search functions in create_doc.py and search_docs.py.

• Behavior:
  • Adds connection_pool parameter as a placeholder in create_user_doc() and create_agent_doc() in create_doc.py.
  • Adds connection_pool parameter as a placeholder in search_user_docs() and search_agent_docs() in search_docs.py.
• Misc:
  • Marks connection_pool as a placeholder to be removed in the future.

^{This description was created by for 1d872e3. It will automatically update as commits are pushed.}

[qodo-merge-pro-for-open-source]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ Recommended focus areas for review Code Cleanup The connection_pool parameter is marked as a placeholder to be removed. This should be properly addressed and removed if not needed to avoid technical debt. connection_pool: Any = None, # FIXME: Placeholder that should be removed

[qodo-merge-pro-for-open-source]

CI Failure Feedback 🧐

Action: Lint-And-Format

Failed stage: Run stefanzweifel/git-auto-commit-action@v4 [❌]

Failure summary: The action failed because of a Git push error. The local branch is behind the remote branch, causing a non-fast-forward rejection. Specifically: The attempt to push to the dev branch was rejected The local branch needs to be updated with remote changes first Git suggests running git pull to integrate remote changes before pushing

Relevant error logs: 1: ##[group]Operating System 2: Ubuntu ... 1294: * [new branch] f/embed-instruction -> origin/f/embed-instruction 1295: * [new branch] f/entries-summarization -> origin/f/entries-summarization 1296: * [new branch] f/grafana-traefik -> origin/f/grafana-traefik 1297: * [new branch] f/increase-test-coverage -> origin/f/increase-test-coverage 1298: * [new branch] f/integrations-sentry -> origin/f/integrations-sentry 1299: * [new branch] f/prompt-step-run-tools -> origin/f/prompt-step-run-tools 1300: * [new branch] f/remote-browser-args-connect-url -> origin/f/remote-browser-args-connect-url 1301: * [new branch] f/scispace-poc -> origin/f/scispace-poc 1302: * [new branch] f/tasks-validation-errors-enhancement -> origin/f/tasks-validation-errors-enhancement 1303: * [new branch] main -> origin/main 1304: * [new branch] mintlify-docs -> origin/mintlify-docs 1305: * [new branch] translate-readme -> origin/translate-readme 1306: * [new branch] v0.3 -> origin/v0.3 1307: * [new branch] x/error-transition -> origin/x/error-transition ... 1321: [dev d7ff1da] refactor: Lint agents-api (CI) 1322: Author: HamadaSalhab <[email protected]> 1323: 1 file changed, 1 deletion(-) 1324: INPUT_TAGGING_MESSAGE: 1325: No tagging message supplied. No tag will be added. 1326: INPUT_PUSH_OPTIONS: 1327: To https://github.com/julep-ai/julep 1328: ! [rejected] dev -> dev (non-fast-forward) 1329: error: failed to push some refs to 'https://github.com/julep-ai/julep' 1330: hint: Updates were rejected because the tip of your current branch is behind 1331: hint: its remote counterpart. If you want to integrate the remote changes, 1332: hint: use 'git pull' before pushing again. 1333: hint: See the 'Note about fast-forwards' in 'git push --help' for details. 1334: Error: Invalid status code: 1 1335: at ChildProcess.<anonymous> (/home/runner/work/_actions/stefanzweifel/git-auto-commit-action/v4/index.js:17:19) 1336: at ChildProcess.emit (node:events:519:28) 1337: at maybeClose (node:internal/child_process:1105:16) 1338: at ChildProcess._handle.onexit (node:internal/child_process:305:5) { 1339: code: 1 1340: } 1341: Error: Invalid status code: 1

---

✨ CI feedback usage guide:

---

The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
The tool analyzes the failed checks and provides several feedbacks:

• Failed stage
• Failed test name
• Failure summary
• Relevant error logs

In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"

where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

Configuration options

• enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
• excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
• enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
• persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
• final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

See more information about the checks tool in the docs.

[qodo-merge-pro-for-open-source]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Score
General	Remove unnecessary placeholder parameter to maintain clean API interface Remove the placeholder connection_pool parameter since it's marked as a FIXME and appears unnecessary. If database connection pooling is needed, it should be handled at the application configuration level rather than passed as a route parameter. agents-api/agents_api/routers/docs/create_doc.py [43-48] async def create_agent_doc( agent_id: UUID, data: CreateDocRequest, x_developer_id: Annotated[UUID, Depends(get_developer_id)], - connection_pool: Any = None, # FIXME: Placeholder that should be removed ) -> ResourceCreatedResponse: Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion correctly identifies and removes an unnecessary placeholder parameter that was explicitly marked for removal. This improves code clarity and prevents potential confusion.	8
	Remove unnecessary placeholder parameter and extra whitespace to maintain clean API interface Remove the placeholder connection_pool parameter and the extra blank line that follows it, since it's marked as a FIXME and appears unnecessary. If database connection pooling is needed, it should be handled at the application configuration level. agents-api/agents_api/routers/docs/search_docs.py [132-138] async def search_agent_docs( x_developer_id: Annotated[UUID, Depends(get_developer_id)], search_params: (TextOnlyDocSearchRequest | VectorDocSearchRequest | HybridDocSearchRequest), agent_id: UUID, - connection_pool: Any = None, # FIXME: Placeholder that should be removed - ) -> DocSearchResponse: Apply this suggestion Suggestion importance[1-10]: 8 Why: The suggestion correctly removes both the unnecessary placeholder parameter and extra whitespace, improving code cleanliness and consistency. The change aligns with the FIXME comment's intention.	8

[ellipsis-dev]

❌ Changes requested. Reviewed everything up to 1d872e3 in 1 minute and 2 seconds

More details

• Looked at 288 lines of code in 6 files
• Skipped 0 files when reviewing.
• Skipped posting 1 drafted comments based on config settings.

1. agents-api/agents_api/routers/docs/search_docs.py:136

• Draft comment:
  The 'connection_pool' parameter is a placeholder and should be removed as it is not used in the function.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable:
  The comment is technically correct - the parameter is unused and marked for removal. However, this is already explicitly noted in the code itself with the "FIXME" comment. The automated comment is just repeating what's already clearly visible in the code. Comments that don't add new information should be removed.
  The comment might be helpful in drawing attention to technical debt that needs to be cleaned up. It could serve as a reminder to remove the placeholder.
  While drawing attention to technical debt is valuable, the inline FIXME comment already serves this purpose. The PR comment is redundant and doesn't add any new information or insight.
  Delete the comment since it's merely repeating information that's already explicitly stated in the code via the FIXME comment.

Workflow ID: wflow_HN5JFlqr0keUZTFg

---

Want Ellipsis to fix these issues? Tag @ellipsis-dev in a comment. You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[ellipsis-dev]

The 'connection_pool' parameter is a placeholder and should be removed as it is not used in the function.