docs: update api-guide to match the current API - #629
Open
Mesut Oezdil (mesutoezdil) wants to merge 1 commit into
Open
docs: update api-guide to match the current API#629Mesut Oezdil (mesutoezdil) wants to merge 1 commit into
Mesut Oezdil (mesutoezdil) wants to merge 1 commit into
Conversation
Mesut Oezdil (mesutoezdil)
force-pushed
the
docs/api-guide-drift
branch
2 times, most recently
from
August 26, 2026 07:10
f2c80e0 to
1d96bd2
Compare
The api-guide had drifted from the protos and CRD types. It missed terminationGracePeriodSeconds and volumes, described snapshotsConfig as just a bucket path when it also carries onPause and onCommit, and listed 7 of the 13 Control RPCs, leaving the whole atespace API undocumented. It also named CreateActorResponse and DeleteActorResponse, which do not exist.
Mesut Oezdil (mesutoezdil)
force-pushed
the
docs/api-guide-drift
branch
from
August 26, 2026 15:38
1d96bd2 to
94dce58
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The api-guide has drifted from the protos and CRD types. It misses
terminationGracePeriodSecondsandvolumes, describessnapshotsConfigas just a bucket path when it also carriesonPauseandonCommit, and lists 7 of the 13ControlRPCs, leaving the whole atespace API undocumented. It also namesCreateActorResponseandDeleteActorResponse, which do not exist.