Merge pull request #457 from dapr/spec

Add the Dapr /healthz API spec

reference/api/error_codes.md

@@ -35,4 +35,5 @@ ERR_MALFORMED_REQUEST | Error with a malformed request.
 ERR_DIRECT_INVOKE | Error in direct invocation.
 ERR_DESERIALIZE_HTTP_BODY | Error deserializing an HTTP request body.
 ERR_SECRET_STORE_NOT_CONFIGURED| Error that no secret store is configured.
-ERR_SECRET_STORE_NOT_FOUND | Error that specified secret store is not found.
+ERR_SECRET_STORE_NOT_FOUND | Error that specified secret store is not found.
+ERR_HEALTH_NOT_READY | Error that Dapr is not ready.

reference/api/health_api.md

@@ -0,0 +1,33 @@
+# Dapr health API reference
+
+Dapr provides health checking probes that can be used as readiness or liveness of Dapr.
+
+### Get Dapr health state
+
+Gets the health state for Dapr.
+
+#### HTTP Request
+
+```http
+GET http://localhost:<daprPort>/v1.0/healthz
+```
+
+#### HTTP Response Codes
+
+Code | Description
+---- | -----------
+200  | dapr is healthy
+500  | dapr is not healthy
+
+#### URL Parameters
+
+Parameter | Description
+--------- | -----------
+daprPort | The Dapr port.
+
+#### Examples
+
+```shell
+curl http://localhost:3500/v1.0/healthz
+```
+