Browse Source

Merge pull request #41851 from thaJeztah/fix_api_docs_typos

docs: fix typos in API docs
Tianon Gravi 4 years ago
parent
commit
5526afa241

+ 2 - 2
api/swagger.yaml

@@ -1274,7 +1274,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:
@@ -10050,7 +10050,7 @@ paths:
                 description: |
                 description: |
                   Address or interface to use for data path traffic (format:
                   Address or interface to use for data path traffic (format:
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
-                  like `eth0`. If `DataPathAddr` is unspecified, the same addres
+                  like `eth0`. If `DataPathAddr` is unspecified, the same address
                   as `AdvertiseAddr` is used.
                   as `AdvertiseAddr` is used.
 
 
                   The `DataPathAddr` specifies the address that global scope
                   The `DataPathAddr` specifies the address that global scope

+ 1 - 1
docs/api/v1.32.yaml

@@ -898,7 +898,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 1 - 1
docs/api/v1.33.yaml

@@ -903,7 +903,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 1 - 1
docs/api/v1.34.yaml

@@ -914,7 +914,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 1 - 1
docs/api/v1.35.yaml

@@ -890,7 +890,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 1 - 1
docs/api/v1.36.yaml

@@ -890,7 +890,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 1 - 1
docs/api/v1.37.yaml

@@ -893,7 +893,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 1 - 1
docs/api/v1.38.yaml

@@ -904,7 +904,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:

+ 2 - 2
docs/api/v1.39.yaml

@@ -1184,7 +1184,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:
@@ -9679,7 +9679,7 @@ paths:
                 description: |
                 description: |
                   Address or interface to use for data path traffic (format:
                   Address or interface to use for data path traffic (format:
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
-                  like `eth0`. If `DataPathAddr` is unspecified, the same addres
+                  like `eth0`. If `DataPathAddr` is unspecified, the same address
                   as `AdvertiseAddr` is used.
                   as `AdvertiseAddr` is used.
 
 
                   The `DataPathAddr` specifies the address that global scope
                   The `DataPathAddr` specifies the address that global scope

+ 2 - 2
docs/api/v1.40.yaml

@@ -1243,7 +1243,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:
@@ -9880,7 +9880,7 @@ paths:
                 description: |
                 description: |
                   Address or interface to use for data path traffic (format:
                   Address or interface to use for data path traffic (format:
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
-                  like `eth0`. If `DataPathAddr` is unspecified, the same addres
+                  like `eth0`. If `DataPathAddr` is unspecified, the same address
                   as `AdvertiseAddr` is used.
                   as `AdvertiseAddr` is used.
 
 
                   The `DataPathAddr` specifies the address that global scope
                   The `DataPathAddr` specifies the address that global scope

+ 2 - 2
docs/api/v1.41.yaml

@@ -1274,7 +1274,7 @@ definitions:
     type: "object"
     type: "object"
     properties:
     properties:
       Bridge:
       Bridge:
-        description: Name of the network'a bridge (for example, `docker0`).
+        description: Name of the network's bridge (for example, `docker0`).
         type: "string"
         type: "string"
         example: "docker0"
         example: "docker0"
       SandboxID:
       SandboxID:
@@ -10050,7 +10050,7 @@ paths:
                 description: |
                 description: |
                   Address or interface to use for data path traffic (format:
                   Address or interface to use for data path traffic (format:
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
                   `<ip|interface>`), for example,  `192.168.1.1`, or an interface,
-                  like `eth0`. If `DataPathAddr` is unspecified, the same addres
+                  like `eth0`. If `DataPathAddr` is unspecified, the same address
                   as `AdvertiseAddr` is used.
                   as `AdvertiseAddr` is used.
 
 
                   The `DataPathAddr` specifies the address that global scope
                   The `DataPathAddr` specifies the address that global scope