[api] fix doc string typo

githedgehog · Mar 1, 2024 · e9e6e8f · e9e6e8f
1 parent 7727162
commit e9e6e8f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/api/wiring/v1alpha2/connection_types.go b/api/wiring/v1alpha2/connection_types.go
@@ -129,7 +129,7 @@ type ConnMCLAG struct {
 	Links []ServerToSwitchLink `json:"links,omitempty"`
 	// ServerFacingConnectionConfig defines any server-facing connection (unbundled, bundled, mclag, etc.) configuration
 	ServerFacingConnectionConfig `json:",inline"`
-	// Fallback is the optional flag that used to idicate one of the links in LACP port channel to be used as a fallback link
+	// Fallback is the optional flag that used to indicate one of the links in LACP port channel to be used as a fallback link
 	Fallback bool `json:"fallback,omitempty"`
 }
 
@@ -140,7 +140,7 @@ type ConnESLAG struct {
 	Links []ServerToSwitchLink `json:"links,omitempty"`
 	// ServerFacingConnectionConfig defines any server-facing connection (unbundled, bundled, eslag, etc.) configuration
 	ServerFacingConnectionConfig `json:",inline"`
-	// Fallback is the optional flag that used to idicate one of the links in LACP port channel to be used as a fallback link
+	// Fallback is the optional flag that used to indicate one of the links in LACP port channel to be used as a fallback link
 	Fallback bool `json:"fallback,omitempty"`
 }
 

diff --git a/config/crd/bases/agent.githedgehog.com_agents.yaml b/config/crd/bases/agent.githedgehog.com_agents.yaml
@@ -237,7 +237,7 @@ spec:
                       properties:
                         fallback:
                           description: Fallback is the optional flag that used to
-                            idicate one of the links in LACP port channel to be used
+                            indicate one of the links in LACP port channel to be used
                             as a fallback link
                           type: boolean
                         links:
@@ -406,7 +406,7 @@ spec:
                       properties:
                         fallback:
                           description: Fallback is the optional flag that used to
-                            idicate one of the links in LACP port channel to be used
+                            indicate one of the links in LACP port channel to be used
                             as a fallback link
                           type: boolean
                         links:

diff --git a/config/crd/bases/wiring.githedgehog.com_connections.yaml b/config/crd/bases/wiring.githedgehog.com_connections.yaml
@@ -94,7 +94,7 @@ spec:
                   server to 2-4 switches with multiple links)
                 properties:
                   fallback:
-                    description: Fallback is the optional flag that used to idicate
+                    description: Fallback is the optional flag that used to indicate
                       one of the links in LACP port channel to be used as a fallback
                       link
                     type: boolean
@@ -250,7 +250,7 @@ spec:
                   server to pair of switches with multiple links)
                 properties:
                   fallback:
-                    description: Fallback is the optional flag that used to idicate
+                    description: Fallback is the optional flag that used to indicate
                       one of the links in LACP port channel to be used as a fallback
                       link
                     type: boolean

diff --git a/docs/api.md b/docs/api.md
@@ -713,7 +713,7 @@ _Appears in:_
 | --- | --- |
 | `links` _[ServerToSwitchLink](#servertoswitchlink) array_ | Links is the list of server-to-switch links |
 | `mtu` _integer_ | MTU is the MTU to be configured on the switch port or port channel |
-| `fallback` _boolean_ | Fallback is the optional flag that used to idicate one of the links in LACP port channel to be used as a fallback link |
+| `fallback` _boolean_ | Fallback is the optional flag that used to indicate one of the links in LACP port channel to be used as a fallback link |
 
 
 #### ConnExternal
@@ -786,7 +786,7 @@ _Appears in:_
 | --- | --- |
 | `links` _[ServerToSwitchLink](#servertoswitchlink) array_ | Links is the list of server-to-switch links |
 | `mtu` _integer_ | MTU is the MTU to be configured on the switch port or port channel |
-| `fallback` _boolean_ | Fallback is the optional flag that used to idicate one of the links in LACP port channel to be used as a fallback link |
+| `fallback` _boolean_ | Fallback is the optional flag that used to indicate one of the links in LACP port channel to be used as a fallback link |
 
 
 #### ConnMCLAGDomain