website: add canary meta to api docs

hashicorp · Jan 27, 2020 · 018f071 · 018f071
1 parent 64f4e9e
commit 018f071
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/website/source/api/json-jobs.html.md b/website/source/api/json-jobs.html.md
@@ -412,6 +412,12 @@ The `Task` object supports the following keys:
        updated to the set defined in the `Tags` field. String interpolation is
        supported in tags.
 
+     - `CanaryMeta`: A key-value map that annotates this Service while it
+       is a canary. Once the canary is promoted, the registered meta will be
+       updated to the set defined in the `Meta` field or removed if the `Meta`
+       field is not set. String interpolation is supported in meta keys and
+       values.
+
      - `PortLabel`: `PortLabel` is an optional string and is used to associate
        a port with the service.  If specified, the port label must match one
        defined in the resources block.  This could be a label of either a

diff --git a/website/source/docs/job-specification/service.html.md b/website/source/docs/job-specification/service.html.md
@@ -155,7 +155,7 @@ Connect][connect] integration.
   annotates the Consul service with user-defined metadata when the service is
   part of an allocation that is currently a canary. Once the canary is
   promoted, the registered meta will be updated to those specified in the
-  `meta` parameter. If this is not supploed, the registered meta will be set to
+  `meta` parameter. If this is not supplied, the registered meta will be set to
   that of the `meta` parameter.
 
 ### `check` Parameters