LCORE-390: field description for liveness response

[tisnik]

Description

LCORE-390: field description for liveness response

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

Related Tickets & Documents

• Related Issue #LCORE-390

Summary by CodeRabbit

• Documentation
  • Added CustomProfile model to API docs with fields: path and prompts.
  • Extended Customization model with new fields: profile_path and custom_profile.
  • Clarified Liveness/Readiness docs: alive field now includes a description and example values.
  • Minor formatting and example text refinements across documentation.

[coderabbitai]

Walkthrough

Adds description and examples to LivenessResponse.alive across OpenAPI and Pydantic. Introduces a new CustomProfile model in markdown docs and extends Customization with profile_path and custom_profile. Minor doc edits (headings/labels). No behavioral changes.

Changes

Cohort / File(s)	Summary
OpenAPI schema (JSON) docs/openapi.json	Enhanced #/components/schemas/LivenessResponse.alive with description and examples; type/title unchanged.
OpenAPI docs (Markdown) docs/openapi.md	Documented new CustomProfile model; extended Customization with profile_path and custom_profile; minor wording tweaks; noted alive field description.
Generated/Output docs docs/output.md	Added CustomProfile docs (duplicated section); extended Customization with profile_path and custom_profile; added description to LivenessResponse.alive.
Pydantic response model src/models/responses.py	Updated LivenessResponse.alive to Field(..., description=..., examples=[True, False]); no logic change.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

• LCORE-380: regenerated schema #275 — Previously reorganized/moved LivenessResponse in OpenAPI; related to current schema metadata update.
• LCORE-304: OpenAPI documentation in Markdown #259 — Introduced OpenAPI markdown spec; current PR refines the same LivenessResponse metadata.
• LCORE-390: fields in response structures #399 — Added Pydantic Field metadata across responses; aligns with this PR’s LivenessResponse Field annotations.

Poem

Little paws tap docs tonight,
I sprinkle fields in tidy light.
Alive? I mark it true or false—
a boolean hop, no extra waltz.
New profiles tucked in burrowed rows,
customization softly grows.
Thump-thump, the schema glows! 🐇✨

Pre-merge checks and finishing touches

✅ 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 "LCORE-390: field description for liveness response" succinctly and accurately summarizes the primary change (adding a description to the liveness response field) and includes the tracking ticket for traceability, making it clear to reviewers. It is concise, specific, and directly related to the modifications in the OpenAPI schema and model. A teammate scanning history can understand the main intent from this title.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Please see the documentation for more information.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

---

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: 0

🧹 Nitpick comments (4)

docs/output.md (2)

690-700: New CustomProfile section added

Looks good. Confirm inclusion is intentional since PR title focuses on liveness docs.

Was adding CustomProfile in this PR scope, or should it be split?

---

710-710: Fill in missing types in Customization table

Types are blank; suggest specifying explicit types for clarity.

Apply this diff:

-| profile_path |  |  |
+| profile_path | string|null |  |
...
-| custom_profile |  |  |
+| custom_profile | CustomProfile|null |  |

Also applies to: 714-714

docs/openapi.md (2)

690-700: New CustomProfile section added

Looks fine; check PR scope alignment with liveness‑only objective.

If unintended, consider moving to a separate PR for clean history.

---

710-710: Specify types for Customization fields

Populate the Type column for better consumer ergonomics.

Apply this diff:

-| profile_path |  |  |
+| profile_path | string|null |  |
...
-| custom_profile |  |  |
+| custom_profile | CustomProfile|null |  |

Also applies to: 714-714

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fab67fa and abd781d.

📒 Files selected for processing (4)

• docs/openapi.json (1 hunks)
• docs/openapi.md (4 hunks)
• docs/output.md (3 hunks)
• src/models/responses.py (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: build-pr
• GitHub Check: e2e_tests

🔇 Additional comments (5)

src/models/responses.py (1)

220-224: LGTM: clear field description and examples for LivenessResponse.alive

Matches existing style (e.g., ReadinessResponse.ready). No behavioral change.

docs/output.md (1)

977-977: LGTM: alive field description clarified

Copy matches code and OpenAPI schema.

docs/openapi.md (2)

765-785: Examples update: OK

Examples show positive sentiment without categories and negative with categories—consistent with field semantics.

---

986-986: LGTM: alive field description clarified

Matches schema and code.

docs/openapi.json (1)

1824-1829: Approve: OpenAPI LivenessResponse.alive description and examples present

Verified via jq: description = "Flag indicating that the app is alive"; examples = [true, false].