docs: align website docs with actual CLI flags from e2e tests#139
Merged
Conversation
All flag discrepancies found by comparing e2e test scripts against the Go cmd source and the published website docs. cloudserver create - Replace URI flags (--boot-disk-uri, --vpc-uri, --subnet-uri, --security-group-uri, --keypair-uri) with ID flags that the CLI actually accepts (--boot-disk-id, --vpc-id, --subnet-id, --security-group-id, --keypair-id) - Add missing required --zone flag - Fix flavor examples (CSO4A8, not small/medium/large) - Remove non-existent --elasticip-uri flag keypair create - Add missing required --region flag keypair update - Document as unsupported (API returns error); describe delete+recreate workaround for key rotation kaas create - Replace --vpc-uri / --subnet-uri with --vpc-id / --subnet-id - Update example k8s version (1.33.2), instance (K2A4), zone (ITBG-1) - Add known-limitation note: node pool fields not round-tripped by SDK, so only --name/--tags updates work reliably containerregistry create - Replace all five URI flags with ID flags (--public-ip-id, --vpc-id, --subnet-id, --security-group-id, --block-storage-id) - Add note about required SG rules (TCP/443 ingress + egress) dbaas create - Add required --zone and --storage-size flags - Add optional --vpc-id, --subnet-id, --security-group-id, --elastic-ip-id flags - Fix --engine-id example (mysql-8.0, not a hex ID) - Note that database/user update (PUT) returns HTTP 405 schedule job create - Add step flags required by the API: --step-resource-uri, --step-action-uri, --step-http-verb, --step-name - Note typology restriction (cloud servers supported; other resource types may not be registered with the scheduler) All changes mirrored to Italian (i18n/it) translations. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #139 +/- ##
=======================================
Coverage 79.80% 79.80%
=======================================
Files 38 38
Lines 7467 7467
=======================================
Hits 5959 5959
Misses 935 935
Partials 573 573
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
2 participants
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.
All flag discrepancies found by comparing e2e test scripts against the Go cmd source and the published website docs.
cloudserver create
keypair create
keypair update
kaas create
containerregistry create
dbaas create
schedule job create
All changes mirrored to Italian (i18n/it) translations.
Summary
Related issues
Type of change
Changes
Test plan
go test ./cmd/...)go tool cover -func=coverage.txt)Checklist
go fmt/gofmt -sappliedgo vet ./...clean