LCORE-1142: minor updates in docstrings

[tisnik]

Description

LCORE-1142: minor updates in docstrings

Type of change

• Refactor
• New feature
• Bug fix
• CVE fix
• Optimization
• Documentation Update
• Configuration Update
• Bump-up service version
• Bump-up dependent library
• Bump-up library or tool used for development (does not change the final image)
• CI configuration change
• Konflux configuration change
• Unit tests improvement
• Integration tests improvement
• End to end tests improvement

Tools used to create PR

• Assisted-by: CodeRabbitAI
• Generated by: N/A

Related Tickets & Documents

• Related Issue #LCORE-1142

Summary by CodeRabbit

• Documentation
  • Improved API endpoint documentation: clarified return value structures for readiness and metrics responses and documented an error condition for the feedback endpoint when writing fails.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Added docstring clarifications to three HTTP endpoint handlers: documented a 500 write-failure raise in feedback, added a Returns section describing ReadinessResponse fields in health, and described the PlainTextResponse content for metrics. No code or control-flow changes.

Changes

Cohort / File(s)	Summary
Endpoint documentation updates src/app/endpoints/feedback.py, src/app/endpoints/health.py, src/app/endpoints/metrics.py	Docstring-only edits: feedback.py adds a Raises section documenting HTTP 500 on file-write failures; health.py adds a Returns section outlining ReadinessResponse fields (ready, reason, providers); metrics.py adds a Returns section describing that the endpoint returns a PlainTextResponse with Prometheus metrics text and appropriate content type.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

• Docstrings for endpoints handlers #375: Documentation-only changes touching the same endpoint handlers (health.readiness_probe_get_method, metrics.metrics_endpoint_handler), suggesting overlap in docstring updates.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: minor docstring updates across three endpoint files (feedback, health, metrics).
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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 and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Fix all issues with AI agents

In `@src/app/endpoints/feedback.py`:
- Around line 154-158: Update the docstring for the feedback-writing endpoint
function to remove the redundant IOError (it's an alias of OSError) and to state
that callers will receive an HTTPException when file write fails; reference the
try/except that catches OSError and raises HTTPException so the docstring lists
HTTPException (not OSError/IOError) as the propagated error. Ensure the
description mentions the HTTP status or message returned by the raised
HTTPException and keep the error documentation in sync with the except block
that catches OSError and re-raises HTTPException.

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Docstring inaccuracy: OSError/IOError don't propagate to callers.

The function catches OSError at line 174 and re-raises it as HTTPException. Since Python 3, IOError is an alias for OSError, so listing both is redundant. More importantly, neither exception actually propagates to callers—only HTTPException does.

Consider documenting what the caller actually sees:

Suggested fix

     Raises:
-        OSError: If writing the feedback file fails.
-        IOError: If writing the feedback file fails.
+        HTTPException: If writing the feedback file fails (HTTP 500).

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	Raises:
	OSError: If writing the feedback file fails.
	IOError: If writing the feedback file fails.
	"""
	Raises:
	HTTPException: If writing the feedback file fails (HTTP 500).
	"""

🤖 Prompt for AI Agents

In `@src/app/endpoints/feedback.py` around lines 154 - 158, Update the docstring
for the feedback-writing endpoint function to remove the redundant IOError (it's
an alias of OSError) and to state that callers will receive an HTTPException
when file write fails; reference the try/except that catches OSError and raises
HTTPException so the docstring lists HTTPException (not OSError/IOError) as the
propagated error. Ensure the description mentions the HTTP status or message
returned by the raised HTTPException and keep the error documentation in sync
with the except block that catches OSError and re-raises HTTPException.