update readme

pinax-network · Oct 25, 2023 · 8b760df · 8b760df
1 parent 8fb5f74
commit 8b760df
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -10,9 +10,11 @@
 | ----------------------|-------------------------------------------------------- |
 | GET `/`               | [Swagger UI](https://swagger.io/resources/open-api/)
 | GET `/chains`         | Available `chains`
-| GET `/supply`         | ERC20 total supply of a contract
+| GET `/supply`         | ERC20 total supply
 | GET `/contract`       | ERC20 contract information (name,symbol,decimals)
-| GET `/balance`        | ERC20 balance changes of address
+| GET `/balance`        | ERC20 balance changes
+| GET `/health`         | Health check
+| GET `/metrics`        | Prometheus metrics
 | GET `/openapi`        | [OpenAPI v3 JSON](https://spec.openapis.org/oas/v3.0.0)
 
 ## Requirements

diff --git a/src/fetch/openapi.ts b/src/fetch/openapi.ts
@@ -89,7 +89,7 @@ export default new OpenApiBuilder()
   .addPath("/supply", {
     get: {
       tags: [TAGS.USAGE],
-      summary: "Get the total supply of an ERC20 contract",
+      summary: "ERC20 total supply",
       parameters: [
         parameterChain,
         parameterString("address"),
@@ -104,7 +104,7 @@ export default new OpenApiBuilder()
   .addPath("/contract", {
     get: {
       tags: [TAGS.USAGE],
-      summary: "Get the ERC20 contract information",
+      summary: "ERC20 contract information",
       parameters: [
         parameterChain,
         parameterString("address"),
@@ -121,7 +121,7 @@ export default new OpenApiBuilder()
   .addPath("/balance", {
     get: {
       tags: [TAGS.USAGE],
-      summary: "Get the ERC20 balance changes",
+      summary: "ERC20 balance changes",
       parameters: [
         parameterChain,
         parameterString("owner"),