Skip to content

docs: fix securitygroup create and securityrule create examples#249

Merged
aru-amedeo merged 1 commit into
mainfrom
fix/docs-securitygroup-create-example
Jun 22, 2026
Merged

docs: fix securitygroup create and securityrule create examples#249
aru-amedeo merged 1 commit into
mainfrom
fix/docs-securitygroup-create-example

Conversation

@aru-amedeo

Copy link
Copy Markdown
Member

Summary

  • securitygroup create: the vpc-id is a positional argument, not a --vpc-id flag. All example pages were updated to use the correct positional syntax.
  • securityrule create: examples used non-existent flags (--direction Inbound, --port-range-min/max, --remote-ip-prefix). Replaced with the actual flags: --direction Ingress/Egress, --port, --target-kind, --target-value, plus the required --name and --region.
  • securityrule update: the resource reference page incorrectly showed --port and --target-value as updatable. Only --name and --tags can be updated; the invalid examples were removed and a note was added.

Files changed

  • docs/website/docs/examples/database.md
  • docs/website/docs/examples/containerregistry.md
  • docs/website/docs/it/examples/database.md
  • docs/website/docs/it/examples/containerregistry.md
  • docs/website/i18n/it/docusaurus-plugin-content-docs/current/examples/database.md
  • docs/website/i18n/it/docusaurus-plugin-content-docs/current/examples/containerregistry.md
  • docs/website/docs/resources/network/securityrule.md

Test plan

  • Verify each changed code block matches the actual CLI command syntax
  • Run acloud network securitygroup create --help and confirm vpc-id is a positional argument
  • Run acloud network securityrule create --help and confirm the correct flag names

Closes #248

🤖 Generated with Claude Code

The vpc-id is a positional argument, not a --vpc-id flag.
Fix all example files (EN, IT) to use the correct command syntax:

  acloud network securitygroup create <vpc-id> --name ... --region ...

Also fix the securityrule create examples that used non-existent flags
(--direction Inbound, --port-range-min/max, --remote-ip-prefix). The
correct flags are --direction Ingress/Egress, --port, --target-kind, and
--target-value.

Additionally, remove the securityrule update examples that incorrectly
showed --port and --target-value as updateable (only --name and --tags
can be updated).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 22, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.20%. Comparing base (c7103a0) to head (7f78d81).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #249   +/-   ##
=======================================
  Coverage   78.20%   78.20%           
=======================================
  Files          53       53           
  Lines       12593    12593           
=======================================
  Hits         9848     9848           
  Misses       1575     1575           
  Partials     1170     1170           
Flag Coverage Δ
unittests 78.20% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@aru-amedeo aru-amedeo merged commit f9271b4 into main Jun 22, 2026
12 checks passed
aru-amedeo pushed a commit that referenced this pull request Jun 22, 2026
First stable GA release. Covers the two fixes landed since v0.5.3:
- #249/#251: securitygroup/securityrule doc examples corrected
- #250/#251: create-command completion for nested resources, vpnroute
  completion gap, and subnet ExactArgs constraint

Also adds the v0.5.3 comparison link which was previously missing from
the footer, and updates [Unreleased] to point to v1.0.0.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: securitygroup create and securityrule create examples use wrong syntax

2 participants