Merge pull request #2520 from hashicorp/jbs-2393

Attempt to describe entire response (for #2393)
hashicorp · Nov 18, 2016 · 460bf5f · 460bf5f
2 parents 0cdc11c + 9402328
commit 460bf5f
Showing 1 changed file with 29 additions and 6 deletions.
diff --git a/website/source/docs/agent/http/catalog.html.markdown b/website/source/docs/agent/http/catalog.html.markdown
@@ -261,19 +261,42 @@ It returns a JSON body like this:
 ```javascript
 [
   {
+    "Address": "192.168.10.10",
+    "TaggedAddresses": {
+      "lan": "192.168.10.10",
+      "wan": "10.0.10.10"
+    },
+    "CreateIndex": 51,
+    "ModifyIndex": 51,
     "Node": "foobar",
-    "Address": "10.1.10.12",
-    "ServiceID": "redis",
-    "ServiceName": "redis",
-    "ServiceTags": null,
-    "ServiceAddress": "",
-    "ServicePort": 8000
+    "ServiceAddress": "172.17.0.3",
+    "ServiceEnableTagOverride": false,
+    "ServiceID": "32a2a47f7992:nodea:5000",
+    "ServiceName": "foobar",
+    "ServicePort": 5000,
+    "ServiceTags": [
+      "tacos"
+    ]
   }
 ]
 ```
 
 This endpoint supports blocking queries and all consistency modes.
 
+The returned fields are as follows:
+
+- `Address`: IP address of the Consul node on which the service is registered 
+- `TaggedAddresses`: List of explicit LAN and WAN IP addresses for the agent
+- `CreateIndex`: Internal index value representing when the service was created
+- `ModifyIndex`: Last index that modified the service
+- `Node`: Node name of the Consul node on which the service is registered
+- `ServiceAddress`: IP address of the service host — if empty, node address should be used
+- `ServiceEnableTagOverride`: Whether service tags can be overridden on this service
+- `ServiceID`: A unique service instance identifier
+- `ServiceName`: Name of the service
+- `ServicePort`: Port number of the service
+- `ServiceTags`: List of tags for the service
+
 ### <a name="catalog_node"></a> /v1/catalog/node/\<node\>
 
 This endpoint is hit with a GET and returns the node's registered services.