docs: update API design to reflect TopoServer and CoreTemplate changes #79
Conversation
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
…plate changes Updates the V1Alpha1 design document to match the recent API refactoring. Changes: - Updates `CoreTemplate` examples to remove the `spec` nesting for `multiadmin` and restrict `globalTopoServer` to managed-only configurations (removing `external` options from templates). - Updates `TopoServer` child CR examples to use the new structure, wrapping configuration under an `etcd` key to allow for future extensivility.
rytswd
reviewed
Dec 16, 2025
| # Defines the MultiAdmin component | ||
| # Defines the MultiAdmin component. | ||
| # Note: The 'spec' nesting is removed here (Flattened) compared to the Cluster CR. |
Member
There was a problem hiding this comment.
This is a transient detail and won't be useful for readers in the future unless they have been tracking all the changes. I don't think this comment is necessary (all the LLM tools tend to add these comments)
rytswd
approved these changes
Dec 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Updates the V1Alpha1 design document to match the recent API refactoring.
Changes:
CoreTemplateexamples to remove thespecnesting formultiadminand restrictglobalTopoServerto managed-only configurations (removingexternaloptions from templates).TopoServerchild CR examples to use the new structure, wrapping configuration under anetcdkey to allow for future extensibility.