Skip to content

✨ feat(help): add help texts#15

Merged
jfbus merged 1 commit intomainfrom
help
Feb 5, 2026
Merged

✨ feat(help): add help texts#15
jfbus merged 1 commit intomainfrom
help

Conversation

@jfbus
Copy link
Contributor

@jfbus jfbus commented Feb 5, 2026

Description

This PR adds help texts on commands and flags:

gli oapi -h
Send commands to the Outscale API.

Usage:
  gli oapi [command]

NetPeering
  AcceptNetPeering                     Accepts a Net peering request.
  CreateNetPeering                     Requests a Net peering between a Net you own and a peer Net that belongs to you or another account.
  DeleteNetPeering                     Deletes a Net peering.
  ReadNetPeerings                      Lists one or more peering connections between two Nets.
  RejectNetPeering                     Rejects a Net peering request.
[...]
gli oapi AcceptNetPeering -h
Accepts a Net peering request.

To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering becomes expired.

**[NOTE]**

A peering connection between two Nets works both ways. Therefore, when an A-to-B peering connection is accepted, any pending B-to-A peering connection is automatically rejected as redundant.

Usage:
  gli oapi AcceptNetPeering [flags]

Flags:
      --DryRun                If true, checks whether you have the required permissions to perform the action.
      --NetPeeringId string   The ID of the Net peering you want to accept.
  -h, --help                  help for AcceptNetPeering

Global Flags:
      --jq string   jq-like output filter
  -v, --verbose     Verbose output

Type of Change

Please check the relevant option(s):

  • 🐛 Bug fix
  • ✨ New feature
  • 🧹 Code cleanup or refactor
  • 📝 Documentation update
  • 🔧 Build or CI-related change
  • 🔒 Security fix
  • Other (specify):

How Has This Been Tested?

Please describe the test strategy:

  • Manual testing
  • Unit tests
  • Integration tests
  • Not tested yet

Checklist

  • I have followed the Contributing Guidelines
  • I have added tests or explained why they are not needed
  • I have updated relevant documentation (README, examples, etc.)
  • My changes follow the Conventional Commits specification
  • My commits include appropriate Gitmoji

Additional Context

@jfbus jfbus merged commit 81e4aec into main Feb 5, 2026
4 checks passed
@jfbus jfbus deleted the help branch February 5, 2026 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants