Skip to content

chore: API documentation sync - #618

Open
github-actions[bot] wants to merge 1 commit into
mainfrom
auto-sync
Open

chore: API documentation sync#618
github-actions[bot] wants to merge 1 commit into
mainfrom
auto-sync

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Automated pull request to sync docs for:

  • Console operator
  • Deployment operator
  • Liquid filters

@github-actions
github-actions Bot requested a review from a team as a code owner August 14, 2026 00:18
@github-actions
github-actions Bot enabled auto-merge (squash) August 14, 2026 00:19
@greptile-apps

greptile-apps Bot commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This automated synchronization expands the CustomHealth script API documentation with the Lua input/output contract, an example, supported statuses, and a link to the full guide.

  • Documents the global Obj input and healthStatus output.
  • Clarifies that returning a Lua table is not consumed.
  • Lists intended health statuses and links to the custom-health guide.

Confidence Score: 4/5

The PR appears safe to merge, with a non-blocking documentation inconsistency around the Paused custom-health status.

The new API-reference text links readers to a guide that omits one status included in the changed exhaustive list, leaving conflicting guidance but no demonstrated runtime defect.

Files Needing Attention: pages/api-reference/kubernetes/agent-api-reference.md

Important Files Changed

Filename Overview
pages/api-reference/kubernetes/agent-api-reference.md The new CustomHealth script contract is useful, but its Paused status conflicts with the exhaustive list in the linked guide.

Comments Outside Diff (1)

  1. pages/api-reference/kubernetes/agent-api-reference.md, line 568 (link)

    P2 Conflicting Paused status guidance

    This description includes Paused in the supported status values, but the linked custom-health guide presents an exhaustive allowed-status list that omits it. Readers following both documents receive conflicting guidance about whether Paused is valid.

Reviews (1): Last reviewed commit: "sync docs" | Re-trigger Greptile

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant