📝 doc(usage): label required flags

[jfbus]

Description

This PR adds a [REQUIRED] label in the usage to each required flag.

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

[github-actions]

🔖 auto-tagging: Adding label "kind/documentation"

[github-actions]

WARNING : Differences in reference doc 🤔

 docs/reference/octl_iaas_account_create.md               | 16 ++++++++--------
 docs/reference/octl_iaas_adminpassword_list.md           |  2 +-
 docs/reference/octl_iaas_ca_create.md                    |  2 +-
 docs/reference/octl_iaas_clientgateway_create.md         |  6 +++---
 docs/reference/octl_iaas_co2emissionaccount_list.md      |  4 ++--
 docs/reference/octl_iaas_consoleoutput_list.md           |  2 +-
 docs/reference/octl_iaas_dedicatedgroup_create.md        |  6 +++---
 docs/reference/octl_iaas_dedicatedgroup_update.md        |  2 +-
 docs/reference/octl_iaas_directlink_create.md            |  6 +++---
 docs/reference/octl_iaas_directlinkinterface_create.md   | 10 +++++-----
 docs/reference/octl_iaas_directlinkinterface_update.md   |  2 +-
 docs/reference/octl_iaas_entitieslinkedtopolicy_list.md  |  2 +-
 docs/reference/octl_iaas_flexiblegpu_create.md           |  4 ++--
 docs/reference/octl_iaas_flexiblegpu_link.md             |  2 +-
 docs/reference/octl_iaas_imageexporttask_create.md       |  6 +++---
 docs/reference/octl_iaas_internetservice_link.md         |  2 +-
 docs/reference/octl_iaas_internetservice_unlink.md       |  2 +-
 docs/reference/octl_iaas_keypair_create.md               |  2 +-
 docs/reference/octl_iaas_linkedpolicy_list.md            |  2 +-
 docs/reference/octl_iaas_listenerrule_create.md          |  8 ++++----
 docs/reference/octl_iaas_loadbalancer_create.md          |  2 +-
 docs/reference/octl_iaas_loadbalancerlistener_create.md  |  2 +-
 docs/reference/octl_iaas_loadbalancerpolicy_create.md    |  6 +++---
 .../octl_iaas_managedpolicieslinkedtousergroup_list.md   |  2 +-
 docs/reference/octl_iaas_natservice_create.md            |  4 ++--
 docs/reference/octl_iaas_net_create.md                   |  2 +-
 docs/reference/octl_iaas_net_update.md                   |  2 +-
 docs/reference/octl_iaas_netaccesspoint_create.md        |  4 ++--
 docs/reference/octl_iaas_netpeering_create.md            |  4 ++--
 docs/reference/octl_iaas_nic_create.md                   |  2 +-
 docs/reference/octl_iaas_nic_link.md                     |  4 ++--
 docs/reference/octl_iaas_policy_create.md                |  4 ++--
 docs/reference/octl_iaas_policy_link.md                  |  2 +-
 docs/reference/octl_iaas_policy_unlink.md                |  2 +-
 docs/reference/octl_iaas_policyversion_create.md         |  2 +-
 docs/reference/octl_iaas_policyversion_delete.md         |  2 +-
 docs/reference/octl_iaas_policyversion_describe.md       |  2 +-
 docs/reference/octl_iaas_policyversion_set-default.md    |  2 +-
 docs/reference/octl_iaas_producttype_create.md           |  2 +-
 docs/reference/octl_iaas_route_create.md                 |  4 ++--
 docs/reference/octl_iaas_routetable_create.md            |  2 +-
 docs/reference/octl_iaas_securitygroup_create.md         |  4 ++--
 docs/reference/octl_iaas_securitygrouprule_create.md     |  4 ++--
 docs/reference/octl_iaas_servercertificate_create.md     |  6 +++---
 docs/reference/octl_iaas_snapshotexporttask_create.md    |  6 +++---
 docs/reference/octl_iaas_subnet_create.md                |  4 ++--
 docs/reference/octl_iaas_subnet_update.md                |  2 +-
 docs/reference/octl_iaas_unitprice_list.md               |  6 +++---
 docs/reference/octl_iaas_user_create.md                  |  2 +-
 docs/reference/octl_iaas_usergroup_create.md             |  2 +-
 docs/reference/octl_iaas_usergrouppolicy_list.md         |  2 +-
 docs/reference/octl_iaas_usergroupsperuser_list.md       |  2 +-
 docs/reference/octl_iaas_userpolicy_list.md              |  2 +-
 docs/reference/octl_iaas_virtualgateway_create.md        |  2 +-
 docs/reference/octl_iaas_vm_create.md                    |  2 +-
 docs/reference/octl_iaas_vmgroup_create.md               |  8 ++++----
 docs/reference/octl_iaas_vmtemplate_create.md            | 10 +++++-----
 docs/reference/octl_iaas_volume_create.md                |  2 +-
 docs/reference/octl_iaas_volume_link.md                  |  4 ++--
 docs/reference/octl_iaas_vpnconnection_create.md         |  6 +++---
 docs/reference/octl_iaas_vpnconnectionroute_create.md    |  4 ++--
 docs/reference/octl_kube_cluster_create.md               |  4 ++--
 docs/reference/octl_kube_nodepool_api.md                 |  2 +-
 docs/reference/octl_kube_nodepool_api_Create.md          |  2 +-
 docs/reference/octl_kube_nodepool_api_Delete.md          |  2 +-
 docs/reference/octl_kube_nodepool_api_Get.md             |  2 +-
 docs/reference/octl_kube_nodepool_api_List.md            |  2 +-
 docs/reference/octl_kube_nodepool_api_Update.md          |  2 +-
 docs/reference/octl_kube_nodepool_create.md              | 10 +++++-----
 docs/reference/octl_kube_nodepool_delete.md              |  2 +-
 docs/reference/octl_kube_nodepool_describe.md            |  2 +-
 docs/reference/octl_kube_nodepool_list.md                |  2 +-
 docs/reference/octl_kube_project_create.md               |  2 +-
 docs/reference/octl_kube_secret.md                       |  2 +-
 docs/reference/octl_storage_api_AbortMultipartUpload.md  |  6 +++---
 .../octl_storage_api_CompleteMultipartUpload.md          |  6 +++---
 docs/reference/octl_storage_api_CopyObject.md            |  6 +++---
 docs/reference/octl_storage_api_CreateBucket.md          |  2 +-
 docs/reference/octl_storage_api_CreateMultipartUpload.md |  4 ++--
 docs/reference/octl_storage_api_DeleteBucket.md          |  2 +-
 docs/reference/octl_storage_api_DeleteBucketCors.md      |  2 +-
 .../reference/octl_storage_api_DeleteBucketEncryption.md |  2 +-
 docs/reference/octl_storage_api_DeleteBucketLifecycle.md |  2 +-
 docs/reference/octl_storage_api_DeleteBucketPolicy.md    |  2 +-
 docs/reference/octl_storage_api_DeleteBucketWebsite.md   |  2 +-
 docs/reference/octl_storage_api_DeleteObject.md          |  4 ++--
 docs/reference/octl_storage_api_DeleteObjectTagging.md   |  4 ++--
 docs/reference/octl_storage_api_GetBucketAcl.md          |  2 +-
 docs/reference/octl_storage_api_GetBucketCors.md         |  2 +-
 docs/reference/octl_storage_api_GetBucketEncryption.md   |  2 +-
 .../octl_storage_api_GetBucketLifecycleConfiguration.md  |  2 +-
 docs/reference/octl_storage_api_GetBucketLocation.md     |  2 +-
 docs/reference/octl_storage_api_GetBucketPolicy.md       |  2 +-
 docs/reference/octl_storage_api_GetBucketVersioning.md   |  2 +-
 docs/reference/octl_storage_api_GetBucketWebsite.md      |  2 +-
 docs/reference/octl_storage_api_GetObject.md             |  4 ++--
 docs/reference/octl_storage_api_GetObjectAcl.md          |  4 ++--
 .../octl_storage_api_GetObjectLockConfiguration.md       |  2 +-
 docs/reference/octl_storage_api_GetObjectRetention.md    |  4 ++--
 docs/reference/octl_storage_api_GetObjectTagging.md      |  4 ++--
 docs/reference/octl_storage_api_HeadBucket.md            |  2 +-
 docs/reference/octl_storage_api_HeadObject.md            |  4 ++--
 docs/reference/octl_storage_api_ListMultipartUploads.md  |  2 +-
 docs/reference/octl_storage_api_ListObjectVersions.md    |  2 +-
 docs/reference/octl_storage_api_ListObjectsV2.md         |  2 +-
 docs/reference/octl_storage_api_ListParts.md             |  6 +++---
 docs/reference/octl_storage_api_PutBucketAcl.md          |  4 ++--
 docs/reference/octl_storage_api_PutBucketCors.md         |  6 +++---
 docs/reference/octl_storage_api_PutBucketEncryption.md   |  4 ++--
 .../octl_storage_api_PutBucketLifecycleConfiguration.md  | 12 ++++++------
 docs/reference/octl_storage_api_PutBucketPolicy.md       |  4 ++--
 docs/reference/octl_storage_api_PutBucketVersioning.md   |  2 +-
 docs/reference/octl_storage_api_PutBucketWebsite.md      |  8 ++++----
 docs/reference/octl_storage_api_PutObject.md             |  4 ++--
 docs/reference/octl_storage_api_PutObjectAcl.md          |  6 +++---
 .../octl_storage_api_PutObjectLockConfiguration.md       |  2 +-
 docs/reference/octl_storage_api_PutObjectRetention.md    |  4 ++--
 docs/reference/octl_storage_api_PutObjectTagging.md      |  8 ++++----
 docs/reference/octl_storage_api_UploadPart.md            |  8 ++++----
 docs/reference/octl_storage_api_UploadPartCopy.md        | 10 +++++-----
 docs/reference/octl_storage_bucket_create.md             |  2 +-
 docs/reference/octl_storage_multipartupload_create.md    |  4 ++--
 docs/reference/octl_storage_multipartupload_list.md      |  2 +-
 docs/reference/octl_storage_object_acl_configure.md      |  2 +-
 docs/reference/octl_storage_object_acl_describe.md       |  2 +-
 docs/reference/octl_storage_object_copy.md               |  2 +-
 docs/reference/octl_storage_object_delete.md             |  2 +-
 docs/reference/octl_storage_object_describe.md           |  2 +-
 docs/reference/octl_storage_object_download.md           |  2 +-
 docs/reference/octl_storage_object_list.md               |  2 +-
 docs/reference/octl_storage_object_put.md                |  2 +-
 .../reference/octl_storage_object_retention_configure.md |  4 ++--
 docs/reference/octl_storage_object_retention_desc.md     |  2 +-
 docs/reference/octl_storage_object_tagging_configure.md  |  2 +-
 docs/reference/octl_storage_object_tagging_delete.md     |  2 +-
 docs/reference/octl_storage_object_tagging_describe.md   |  2 +-
 docs/reference/octl_storage_object_versions.md           |  2 +-
 docs/reference/octl_storage_part_list.md                 |  6 +++---
 138 files changed, 242 insertions(+), 242 deletions(-)

Detailed changes

docs/reference/octl_iaas_account_create.md

-      --city string                The city of the account owner.
-      --company-name string        The name of the company for the account.
-      --country string             The country of the account owner.
-      --customer-id string         The ID of the customer.
-      --email string               The main email address for the account.
-      --first-name string          The first name of the account owner.
+      --city string                [REQUIRED] The city of the account owner.
+      --company-name string        [REQUIRED] The name of the company for the account.
+      --country string             [REQUIRED] The country of the account owner.
+      --customer-id string         [REQUIRED] The ID of the customer.
+      --email string               [REQUIRED] The main email address for the account.
+      --first-name string          [REQUIRED] The first name of the account owner.
-      --last-name string           The last name of the account owner.
+      --last-name string           [REQUIRED] The last name of the account owner.
-      --zip-code string            The ZIP code of the city.
+      --zip-code string            [REQUIRED] The ZIP code of the city.

docs/reference/octl_iaas_adminpassword_list.md

-      --vm-id string   The ID of the VM.
+      --vm-id string   [REQUIRED] The ID of the VM.

docs/reference/octl_iaas_ca_create.md

-      --pem string           The CA in PEM format.
+      --pem string           [REQUIRED] The CA in PEM format.

docs/reference/octl_iaas_clientgateway_create.md

-      --bgp-asn int              The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
-      --connection-type string   The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
+      --bgp-asn int              [REQUIRED] The Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your client gateway through the Internet.
+      --connection-type string   [REQUIRED] The communication protocol used to establish tunnel with your client gateway (always ipsec.1).
-      --public-ip string         The public fixed IPv4 address of your client gateway.
+      --public-ip string         [REQUIRED] The public fixed IPv4 address of your client gateway.

docs/reference/octl_iaas_co2emissionaccount_list.md

-      --from-month osctime   The beginning of the time period, in ISO 8601 date format (for example, 2020-06-01).
+      --from-month osctime   [REQUIRED] The beginning of the time period, in ISO 8601 date format (for example, 2020-06-01).
-      --to-month osctime     The end of the time period, in ISO 8601 date format (for example, 2020-06-14).
+      --to-month osctime     [REQUIRED] The end of the time period, in ISO 8601 date format (for example, 2020-06-14).

docs/reference/octl_iaas_consoleoutput_list.md

-      --vm-id string   The ID of the VM.
+      --vm-id string   [REQUIRED] The ID of the VM.

docs/reference/octl_iaas_dedicatedgroup_create.md

-      --cpu-generation int   The processor generation for the VMs in the dedicated group (for example, 4).
+      --cpu-generation int   [REQUIRED] The processor generation for the VMs in the dedicated group (for example, 4).
-      --name string          A name for the dedicated group.
-      --subregion string     The Subregion in which you want to create the dedicated group.
+      --name string          [REQUIRED] A name for the dedicated group.
+      --subregion string     [REQUIRED] The Subregion in which you want to create the dedicated group.

docs/reference/octl_iaas_dedicatedgroup_update.md

-      --name string   The new name of the dedicated group.
+      --name string   [REQUIRED] The new name of the dedicated group.

docs/reference/octl_iaas_directlink_create.md

-      --bandwidth string   The bandwidth of the DirectLink (1Gbps | 10Gbps).
+      --bandwidth string   [REQUIRED] The bandwidth of the DirectLink (1Gbps | 10Gbps).
-      --location string    The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method.
-      --name string        The name of the DirectLink.
+      --location string    [REQUIRED] The code of the requested location for the DirectLink, returned by the [ReadLocations](#readlocations) method.
+      --name string        [REQUIRED] The name of the DirectLink.

docs/reference/octl_iaas_directlinkinterface_create.md

-      --bgp-asn int                         
+      --bgp-asn int                         [REQUIRED] 
-      --direct-link-id string               The ID of the existing DirectLink for which you want to create the DirectLink interface.
-      --direct-link-interface-name string   
+      --direct-link-id string               [REQUIRED] The ID of the existing DirectLink for which you want to create the DirectLink interface.
+      --direct-link-interface-name string   [REQUIRED] 
-      --virtual-gateway-id string           
-      --vlan int                            
+      --virtual-gateway-id string           [REQUIRED] 
+      --vlan int                            [REQUIRED] 

docs/reference/octl_iaas_directlinkinterface_update.md

-      --mtu int   The maximum transmission unit (MTU) of the DirectLink interface, in bytes.
+      --mtu int   [REQUIRED] The maximum transmission unit (MTU) of the DirectLink interface, in bytes.

docs/reference/octl_iaas_entitieslinkedtopolicy_list.md

-      --policy-orn string     The OUTSCALE Resource Name (ORN) of the policy.
+      --policy-orn string     [REQUIRED] The OUTSCALE Resource Name (ORN) of the policy.

docs/reference/octl_iaas_flexiblegpu_create.md

-      --model-name string       The model of fGPU you want to allocate.
-      --subregion string        The Subregion in which you want to create the fGPU.
+      --model-name string       [REQUIRED] The model of fGPU you want to allocate.
+      --subregion string        [REQUIRED] The Subregion in which you want to create the fGPU.

docs/reference/octl_iaas_flexiblegpu_link.md

-      --vm-id string   The ID of the VM you want to attach the fGPU to.
+      --vm-id string   [REQUIRED] The ID of the VM you want to attach the fGPU to.

docs/reference/octl_iaas_imageexporttask_create.md

-      --image-id string                            The ID of the OMI to export.
-      --osu-export-disk-image-format string        The format of the export disk (qcow2 | raw).
+      --image-id string                            [REQUIRED] The ID of the OMI to export.
+      --osu-export-disk-image-format string        [REQUIRED] The format of the export disk (qcow2 | raw).
-      --osu-export-osu-bucket string               The name of the OOS bucket where you want to export the object.
+      --osu-export-osu-bucket string               [REQUIRED] The name of the OOS bucket where you want to export the object.

docs/reference/octl_iaas_internetservice_link.md

-      --net-id string   The ID of the Net to which you want to attach the internet service.
+      --net-id string   [REQUIRED] The ID of the Net to which you want to attach the internet service.

docs/reference/octl_iaas_internetservice_unlink.md

-      --net-id string   The ID of the Net from which you want to detach the internet service.
+      --net-id string   [REQUIRED] The ID of the Net from which you want to detach the internet service.

docs/reference/octl_iaas_keypair_create.md

-      --name string             A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters).
+      --name string             [REQUIRED] A unique name for the keypair, with a maximum length of 255 [ASCII printable characters](https://en.wikipedia.org/wiki/ASCII#Printable_characters).

docs/reference/octl_iaas_linkedpolicy_list.md

-      --user-name string     The name of the user the policies are linked to.
+      --user-name string     [REQUIRED] The name of the user the policies are linked to.

docs/reference/octl_iaas_listenerrule_create.md

-      --listener-load-balancer-name string   The name of the load balancer to which the listener is attached.
-      --listener-load-balancer-port int      The port of load balancer on which the load balancer is listening (between 1 and 65535 both included).
-      --listener-rule-name string            A human-readable name for the listener rule.
+      --listener-load-balancer-name string   [REQUIRED] The name of the load balancer to which the listener is attached.
+      --listener-load-balancer-port int      [REQUIRED] The port of load balancer on which the load balancer is listening (between 1 and 65535 both included).
+      --listener-rule-name string            [REQUIRED] A human-readable name for the listener rule.
-      --priority int                         The priority level of the listener rule, between 1 and 19999 both included.
+      --priority int                         [REQUIRED] The priority level of the listener rule, between 1 and 19999 both included.

docs/reference/octl_iaas_loadbalancer_create.md

-      --name string                              The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (-).
+      --name string                              [REQUIRED] The unique name of the load balancer, with a maximum length of 32 alphanumeric characters and dashes (-).

docs/reference/octl_iaas_loadbalancerlistener_create.md

-      --name string                              The name of the load balancer for which you want to create listeners.
+      --name string                              [REQUIRED] The name of the load balancer for which you want to create listeners.

docs/reference/octl_iaas_loadbalancerpolicy_create.md

-      --name string                    The name of the load balancer for which you want to create a policy.
-      --policy-name string             The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (-).
-      --policy-type string             The type of stickiness policy you want to create: app or load_balancer.
+      --name string                    [REQUIRED] The name of the load balancer for which you want to create a policy.
+      --policy-name string             [REQUIRED] The unique name of the policy, with a maximum length of 32 alphanumeric characters and dashes (-).
+      --policy-type string             [REQUIRED] The type of stickiness policy you want to create: app or load_balancer.

docs/reference/octl_iaas_managedpolicieslinkedtousergroup_list.md

-      --user-group-name string   The name of the group.
+      --user-group-name string   [REQUIRED] The name of the group.

docs/reference/octl_iaas_natservice_create.md

-      --public-ip-id string   The allocation ID of the public IP to associate with the NAT service.
-      --subnet-id string      The ID of the Subnet in which you want to create the NAT service.
+      --public-ip-id string   [REQUIRED] The allocation ID of the public IP to associate with the NAT service.
+      --subnet-id string      [REQUIRED] The ID of the Subnet in which you want to create the NAT service.

docs/reference/octl_iaas_net_create.md

-      --ip-range string   The IP range for the Net, in CIDR notation (for example, 10.0.0.0/16).
+      --ip-range string   [REQUIRED] The IP range for the Net, in CIDR notation (for example, 10.0.0.0/16).

docs/reference/octl_iaas_net_update.md

-      --dhcp-options-set-id string   The ID of the DHCP options set (or default if you want to associate the default one).
+      --dhcp-options-set-id string   [REQUIRED] The ID of the DHCP options set (or default if you want to associate the default one).

docs/reference/octl_iaas_netaccesspoint_create.md

-      --net-id string            The ID of the Net.
+      --net-id string            [REQUIRED] The ID of the Net.
-      --service-name string      The name of the service (in the format com.outscale.region.service).
+      --service-name string      [REQUIRED] The name of the service (in the format com.outscale.region.service).

docs/reference/octl_iaas_netpeering_create.md

-      --accepter-net-id string     The ID of the Net you want to connect with.
+      --accepter-net-id string     [REQUIRED] The ID of the Net you want to connect with.
[...]

[github-actions]

Binary size: 82.2MB => 82.2MB (change +4KB, +0.0%) 😉

[github-actions]

🔖 auto-tagging: Adding label "kind/documentation"

[github-actions]

🔖 auto-tagging: Adding label "kind/documentation"