Repository navigation
docs: sync from source repos 2026-11-13 - #168
kong-volcano-app[bot] wants to merge 1 commit into
Conversation
|
|
AI review: 3 P0-P2 finding(s)Synchronizes CLI/platform documentation and OpenAPI definitions for previews, TypeScript, Aikido, protocol limits, and LavaFlow. The main risks are inaccurate operational guidance and removals from the published API contract. 🟡 P2
⚪ P3
Not checked: The AI review read the diff, the code, and the PR's text; it ran no tests or builds and read nothing outside this repository.
Push a fix, or have a collaborator with write access (including the PR author) add the Failing round 1 of 3 since this PR was last marked ready for review. If 3 rounds in a row find P0-P2 problems, the AI review moves the PR back to draft for the author to re-assess the approach. Human review: needed
Decide the points above: approve to accept them, or request changes. Suggested reviewer: |
| { "id": "lavaflow.aikido", "status": "unavailable" }, | ||
| { "id": "functions.response_streaming", "status": "available" }, | ||
| { "id": "frontend_routes", "status": "available" }, | ||
| { "id": "frontends.candidates", "status": "unavailable" }, |
There was a problem hiding this comment.
⚪ P3: Capabilities example response omits the newly documented functions.candidates entry
This sync adds a functions.candidates row to the capabilities table in overview.md, and functions/previews.md tells readers to look for it in GET /capabilities. The example GET /capabilities response just above the table gained lavaflow.open_pr_ci_start and lavaflow.aikido but not functions.candidates. A reader comparing the example with the table can't see where the new entry appears. content/platform is synced from Kong/volcano-hosting and must not be hand-edited, so the fix belongs upstream: add { "id": "functions.candidates", "status": "unavailable" } beside frontends.candidates in the source doc.
Found by claude-opus-5-5
|
|
||
| Every promotion and rollback names the serving `revision` it read, and is | ||
| refused with `stale_revision` if someone promoted or rolled back since. The CLI | ||
| reads it for you, so retrying a rollback that already applied is refused rather |
There was a problem hiding this comment.
🟡 P2: Distinguish request retries from rerunning rollback
Rerunning volcano cloud functions rollback api reads the current revision again, so it can undo the previous rollback, as this section explicitly describes. Only replaying the original request with its original expected_revision receives stale_revision. After a lost response, this guarantee could lead someone to rerun the command and restore the preview unintentionally. Clarify that retry protection applies to the same API request.
Found by gpt-6.1-sol
| `409` and `code: function_served_by_candidate` before anything is stored, | ||
| because it would reach only the function's own build, which receives no | ||
| traffic. Roll back or deploy first, then write it again. | ||
| - `volcano config deploy` and replacing the shared variable list store the |
There was a problem hiding this comment.
🟡 P2: Use the cloud namespace for configuration changes
volcano config deploy targets local development, as the namespace table in content/cli/project-configuration.md documents, while function previews are cloud-only. Following this command updates local configuration or fails without a local server, leaving the cloud project unchanged. Use volcano cloud config deploy here and in the matching FunctionProductionEnvironment OpenAPI description.
Found by gpt-6.1-sol
| Query must be parsed again; otherwise its lookup fails with SQLSTATE `26000`. | ||
|
|
||
| A Parse, Bind or Describe that would exceed a session ceiling fails with | ||
| SQLSTATE `54000` and `pgproxy session prepared statement or portal limit exceeded; close unused statements and portals`. |
There was a problem hiding this comment.
🟡 P2: Update the SQLSTATE reference alongside the protocol limits
The new section documents SQLSTATEs 54000, 34000, and 26000, but this page's Error Codes section still says every Volcano refusal outside its four listed codes arrives without a SQLSTATE. Users implementing error handling receive contradictory guidance for protocol and prepared-statement failures. Add these codes and their recovery actions to the reference, or qualify its exhaustive claim.
Found by gpt-6.1-sol
|
Superseded by #170, which carries the final snapshot of every product repo's docs and removes the sync. |
Automated docs sync. Sources: docs.config.yaml.