Skip to content

[main] update client/openapi/console.yaml - #410

Open
fghanmi wants to merge 1 commit into
mainfrom
create-pull-request/patch-f698136
Open

fghanmi wants to merge 1 commit into
mainfrom
create-pull-request/patch-f698136

Conversation

@fghanmi

@fghanmi fghanmi commented Nov 16, 2026

Copy link
Copy Markdown
Member

The openapi.yaml of rhtas-console has changed

@qodo-for-securesign

Copy link
Copy Markdown

PR Summary by Qodo

Document expanded system health response and optional probe history

📝 Documentation ✨ Enhancement 🕐 20-40 Minutes

Grey Divider

AI Description

• Document deployment and per-service health, including probe metrics and status sources.
• Add an optional history query parameter for retained per-service probe samples.
• Mark legacy service status fields deprecated while retaining them for compatibility.
Diagram

graph TD
  CR["Securesign CR"] --> Response["Health response"] --> Services["Service metrics"] --> Samples["Probe samples"]
  Prober["Background prober"] --> Services
  Request["Health GET"] --> Response
  History["history query"] --> Samples
Loading
High-Level Assessment

Updating the existing OpenAPI operation and reusing its response schema is appropriate for documenting the expanded contract. Keeping the flat status fields deprecated rather than removing them preserves compatibility; a separate versioned endpoint is not warranted by this documentation-only change.

Files changed (1) +267 / -11

Documentation (1) +267 / -11
console.yamlExpand the documented system health API contract +267/-11

Expand the documented system health API contract

• Documents the optional history parameter, deployment status reason, per-service metrics, and retained probe samples with updated response examples. Clarifies condition-derived versus HTTP-probed status, nullable values, and data freshness while deprecating the legacy flat service status fields.

client/openapi/console.yaml

@fghanmi
fghanmi requested a review from jsmid1 November 16, 2026 11:02
@qodo-for-securesign

qodo-for-securesign Bot commented Nov 16, 2026 •

Copy link
Copy Markdown

Code Review by Qodo


Action required

Nice, no open findings for this group


Remediation recommended

Nice, no open findings for this group


Informational

Nice, no open findings for this group


@codecov-commenter

codecov-commenter commented Nov 16, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.27%. Comparing base (f698136) to head (99b7b73).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #410   +/-   ##
=======================================
  Coverage   76.27%   76.27%           
=======================================
  Files         109      109           
  Lines        1623     1623           
  Branches      497      497           
=======================================
  Hits         1238     1238           
  Misses        338      338           
  Partials       47       47           
Flag Coverage Δ
e2e 64.80% <ø> (ø)
unit 61.16% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@jsmid1 jsmid1 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one more response code should be added, otherwise LGTM.

Comment thread client/openapi/console.yaml Resolved
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@fghanmi
fghanmi force-pushed the create-pull-request/patch-f698136 branch from c43852e to 99b7b73 Compare November 16, 2026 13:54

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants