Skip to content

Commit 113c4e4

Browse files
authored
fix: keep known initialisms together in generated command names (#60)
* fix: keep known initialisms together when generating kebab-case names The camelToKebab conversion used for CLI command/flag names inserted a dash before every uppercase letter, splitting initialisms like BGP, SSH, IP, VLAN, and API into commands such as b-g-p, s-s-h-key, and i-p-address. Add a shared internal/casing package that recognizes a list of known initialisms and keeps them as a single word, fixing commands like bgp, ssh-key, ip-address, and oauth. * fix: keep version-style digit suffixes attached to their word Digits like the "2" in OAuth2 or the "4"/"6" in IPv4/IPv6 were treated as a new word boundary, producing oauth-2-token instead of the well-known spec name oauth2-token. Trailing digits now attach to the preceding word like other suffixes. * docs: regenerate docs with fixed initialism command names Run 'make docs' to pick up the renamed commands (e.g. b-g-p -> bgp, create-a-p-i-key -> create-api-key, o-auth2-token -> oauth2-token) from the camelToKebab fix.
1 parent 098fd3f commit 113c4e4

119 files changed

Lines changed: 1643 additions & 1654 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/equinix_accesstokenv1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ providing access to all available API services.
2626
### SEE ALSO
2727

2828
* [equinix](equinix.md) - Equinix CLI
29-
* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources
29+
* [equinix accesstokenv1 oauth2-token](equinix_accesstokenv1_oauth2-token.md) - Manage oauth2-token resources
3030

docs/equinix_accesstokenv1_o-auth2-token.md

Lines changed: 0 additions & 28 deletions
This file was deleted.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
## equinix accesstokenv1 oauth2-token
2+
3+
Manage oauth2-token resources
4+
5+
### Synopsis
6+
7+
Commands for managing oauth2-token resources in the API
8+
9+
### Options
10+
11+
```
12+
-h, --help help for oauth2-token
13+
```
14+
15+
### Options inherited from parent commands
16+
17+
```
18+
--config string config file (default is $HOME/.config/equinix/equinix.yaml)
19+
--debug Enable debug logging for HTTP requests
20+
-f, --format string Format to use for output (json or yaml) (default "json")
21+
```
22+
23+
### SEE ALSO
24+
25+
* [equinix accesstokenv1](equinix_accesstokenv1.md) - Manage Equinix accesstokenv1 resources
26+
* [equinix accesstokenv1 oauth2-token get-oauth2-access-token](equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md) - Execute get-oauth2-access-token operation
27+
* [equinix accesstokenv1 oauth2-token refresh-oauth2-access-token](equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md) - Execute refresh-oauth2-access-token operation
28+

docs/equinix_accesstokenv1_o-auth2-token_get-o-auth2-access-token.md renamed to docs/equinix_accesstokenv1_oauth2-token_get-oauth2-access-token.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
## equinix accesstokenv1 o-auth2-token get-o-auth2-access-token
1+
## equinix accesstokenv1 oauth2-token get-oauth2-access-token
22

3-
Generate New Access Token
3+
Execute get-oauth2-access-token operation
44

55
### Synopsis
66

7-
This API handles authentication and authorization of the API developer. It returns an access_token which would be valid for 60 minutes. The user account will get locked after 5 successive invalid attempts.
7+
Execute the get-oauth2-access-token operation on this service.
88

9-
Use --request flag to provide optional JSON payload fields.
9+
Use --request flag to provide a JSON payload for the request body.
10+
Example: --request '{"field":"value"}'
11+
12+
The command accepts parameters based on the SDK method signature.
1013

1114
```
12-
equinix accesstokenv1 o-auth2-token get-o-auth2-access-token [flags]
15+
equinix accesstokenv1 oauth2-token get-oauth2-access-token [flags]
1316
```
1417

1518
### Options
1619

1720
```
18-
-h, --help help for get-o-auth2-access-token
21+
-h, --help help for get-oauth2-access-token
1922
--payload-additional-properties string payload-additional-properties (JSON)
2023
--payload-client_id string API Consumer Key available under \"My Apps\" in developer portal
2124
--payload-client_secret string API Consumer secret available under \"My Apps\" in developer portal
@@ -36,5 +39,5 @@ equinix accesstokenv1 o-auth2-token get-o-auth2-access-token [flags]
3639

3740
### SEE ALSO
3841

39-
* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources
42+
* [equinix accesstokenv1 oauth2-token](equinix_accesstokenv1_oauth2-token.md) - Manage oauth2-token resources
4043

docs/equinix_accesstokenv1_o-auth2-token_refresh-o-auth2-access-token.md renamed to docs/equinix_accesstokenv1_oauth2-token_refresh-oauth2-access-token.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,24 @@
1-
## equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token
1+
## equinix accesstokenv1 oauth2-token refresh-oauth2-access-token
22

3-
Renew Access Tokens
3+
Execute refresh-oauth2-access-token operation
44

55
### Synopsis
66

7-
Use this API to refresh an access token using its refresh token. A valid refresh token is needed to retrieve a new access_token.
7+
Execute the refresh-oauth2-access-token operation on this service.
88

9-
Use --request flag to provide optional JSON payload fields.
9+
Use --request flag to provide a JSON payload for the request body.
10+
Example: --request '{"field":"value"}'
11+
12+
The command accepts parameters based on the SDK method signature.
1013

1114
```
12-
equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token [flags]
15+
equinix accesstokenv1 oauth2-token refresh-oauth2-access-token [flags]
1316
```
1417

1518
### Options
1619

1720
```
18-
-h, --help help for refresh-o-auth2-access-token
21+
-h, --help help for refresh-oauth2-access-token
1922
--payload-additional-properties string payload-additional-properties (JSON)
2023
--payload-client_id string API Consumer Key available under \"My Apps\" in developer portal
2124
--payload-client_secret string API Consumer secret available under \"My Apps\" in developer portal
@@ -33,5 +36,5 @@ equinix accesstokenv1 o-auth2-token refresh-o-auth2-access-token [flags]
3336

3437
### SEE ALSO
3538

36-
* [equinix accesstokenv1 o-auth2-token](equinix_accesstokenv1_o-auth2-token.md) - Manage o-auth2-token resources
39+
* [equinix accesstokenv1 oauth2-token](equinix_accesstokenv1_oauth2-token.md) - Manage oauth2-token resources
3740

docs/equinix_eiav2.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,5 @@ providing access to all available API services.
2626
### SEE ALSO
2727

2828
* [equinix](equinix.md) - Equinix CLI
29-
* [equinix eiav2 e-i-a-service](equinix_eiav2_e-i-a-service.md) - Manage e-i-a-service resources
29+
* [equinix eiav2 eia-service](equinix_eiav2_eia-service.md) - Manage eia-service resources
3030

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
## equinix eiav2 e-i-a-service
1+
## equinix eiav2 eia-service
22

3-
Manage e-i-a-service resources
3+
Manage eia-service resources
44

55
### Synopsis
66

7-
Commands for managing e-i-a-service resources in the API
7+
Commands for managing eia-service resources in the API
88

99
### Options
1010

1111
```
12-
-h, --help help for e-i-a-service
12+
-h, --help help for eia-service
1313
```
1414

1515
### Options inherited from parent commands
@@ -23,5 +23,5 @@ Commands for managing e-i-a-service resources in the API
2323
### SEE ALSO
2424

2525
* [equinix eiav2](equinix_eiav2.md) - Manage Equinix eiav2 resources
26-
* [equinix eiav2 e-i-a-service create-equinix-internet-accessv2](equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md) - Execute create-equinix-internet-accessv2 operation
26+
* [equinix eiav2 eia-service create-equinix-internet-accessv2](equinix_eiav2_eia-service_create-equinix-internet-accessv2.md) - Creates Equinix Internet Access Service
2727

docs/equinix_eiav2_e-i-a-service_create-equinix-internet-accessv2.md renamed to docs/equinix_eiav2_eia-service_create-equinix-internet-accessv2.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
1-
## equinix eiav2 e-i-a-service create-equinix-internet-accessv2
1+
## equinix eiav2 eia-service create-equinix-internet-accessv2
22

3-
Execute create-equinix-internet-accessv2 operation
3+
Creates Equinix Internet Access Service
44

55
### Synopsis
66

7-
Execute the create-equinix-internet-accessv2 operation on this service.
7+
By passing in the appropriate options, you can create Equinix Internet Access Service product. The entire request either succeeds or fails. In case of failure all the changes in the system are rolled back, so the system gets back to its stated before submitting the request
88

9-
Use --request flag to provide a JSON payload for the request body.
10-
Example: --request '{"field":"value"}'
11-
12-
The command accepts parameters based on the SDK method signature.
9+
Use --request flag to provide optional JSON payload fields.
1310

1411
```
15-
equinix eiav2 e-i-a-service create-equinix-internet-accessv2 [flags]
12+
equinix eiav2 eia-service create-equinix-internet-accessv2 [flags]
1613
```
1714

1815
### Options
@@ -48,5 +45,5 @@ equinix eiav2 e-i-a-service create-equinix-internet-accessv2 [flags]
4845

4946
### SEE ALSO
5047

51-
* [equinix eiav2 e-i-a-service](equinix_eiav2_e-i-a-service.md) - Manage e-i-a-service resources
48+
* [equinix eiav2 eia-service](equinix_eiav2_eia-service.md) - Manage eia-service resources
5249

docs/equinix_fabricv4_ports_create-port.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ equinix fabricv4 ports create-port [flags]
101101
--port-request-location-region string port-request-location-region
102102
--port-request-name string Equinix assigned response attribute for Port name
103103
--port-request-notifications string Notification preferences (JSON array)
104-
--port-request-operation-access-v-c-count int Total number of connections.
104+
--port-request-operation-access-vc-count int Total number of connections.
105105
--port-request-operation-additional-properties string port-request-operation-additional-properties (JSON)
106106
--port-request-operation-connection-count int Total number of connections.
107-
--port-request-operation-evpl-v-c-count int Total number of connections.
108-
--port-request-operation-fg-v-c-count int Total number of connections.
107+
--port-request-operation-evpl-vc-count int Total number of connections.
108+
--port-request-operation-fg-vc-count int Total number of connections.
109109
--port-request-operation-op-status-changed-at string port-request-operation-op-status-changed-at (JSON)
110110
--port-request-operation-operational-status string port-request-operation-operational-status
111111
--port-request-order-additional-properties string port-request-order-additional-properties (JSON)

docs/equinix_fabricv4_routing-protocols_create-connection-routing-protocol.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ equinix fabricv4 routing-protocols create-connection-routing-protocol [flags]
1818
--connection-id string Connection Id (required)
1919
-h, --help help for create-connection-routing-protocol
2020
--request string JSON payload for additional optional fields not exposed as flags
21-
--routing-protocol-base-routing-protocol-b-g-p-type-additional-properties string routing-protocol-base-routing-protocol-b-g-p-type-additional-properties (JSON)
22-
--routing-protocol-base-routing-protocol-b-g-p-type-as-override-enabled Enable AS number override
23-
--routing-protocol-base-routing-protocol-b-g-p-type-bfd string routing-protocol-base-routing-protocol-b-g-p-type-bfd (JSON)
24-
--routing-protocol-base-routing-protocol-b-g-p-type-bgp-auth-key string BGP authorization key
25-
--routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv4 string routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv4 (JSON)
26-
--routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv6 string routing-protocol-base-routing-protocol-b-g-p-type-bgp-ipv6 (JSON)
27-
--routing-protocol-base-routing-protocol-b-g-p-type-customer-asn int Customer asn
28-
--routing-protocol-base-routing-protocol-b-g-p-type-name string routing-protocol-base-routing-protocol-b-g-p-type-name
29-
--routing-protocol-base-routing-protocol-b-g-p-type-type string routing-protocol-base-routing-protocol-b-g-p-type-type
21+
--routing-protocol-base-routing-protocol-bgp-type-additional-properties string routing-protocol-base-routing-protocol-bgp-type-additional-properties (JSON)
22+
--routing-protocol-base-routing-protocol-bgp-type-as-override-enabled Enable AS number override
23+
--routing-protocol-base-routing-protocol-bgp-type-bfd string routing-protocol-base-routing-protocol-bgp-type-bfd (JSON)
24+
--routing-protocol-base-routing-protocol-bgp-type-bgp-auth-key string BGP authorization key
25+
--routing-protocol-base-routing-protocol-bgp-type-bgp-ipv4 string routing-protocol-base-routing-protocol-bgp-type-bgp-ipv4 (JSON)
26+
--routing-protocol-base-routing-protocol-bgp-type-bgp-ipv6 string routing-protocol-base-routing-protocol-bgp-type-bgp-ipv6 (JSON)
27+
--routing-protocol-base-routing-protocol-bgp-type-customer-asn int Customer asn
28+
--routing-protocol-base-routing-protocol-bgp-type-name string routing-protocol-base-routing-protocol-bgp-type-name
29+
--routing-protocol-base-routing-protocol-bgp-type-type string routing-protocol-base-routing-protocol-bgp-type-type
3030
--routing-protocol-base-routing-protocol-direct-type-additional-properties string routing-protocol-base-routing-protocol-direct-type-additional-properties (JSON)
3131
--routing-protocol-base-routing-protocol-direct-type-direct-ipv4 string routing-protocol-base-routing-protocol-direct-type-direct-ipv4 (JSON)
3232
--routing-protocol-base-routing-protocol-direct-type-direct-ipv6 string routing-protocol-base-routing-protocol-direct-type-direct-ipv6 (JSON)

0 commit comments

Comments
 (0)