Skip to content

Commit

Permalink
docs(autodoc/api) make it clear that the database status info (Kong#1824
Browse files Browse the repository at this point in the history
)

returned by `/status` endpoint does not reflect the status of
read-only database connections yet
  • Loading branch information
dndx authored Mar 6, 2020
1 parent 7582d22 commit 3b1c827
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions autodoc-admin-api/data.lua
Original file line number Diff line number Diff line change
Expand Up @@ -245,8 +245,9 @@ return {
connections waiting for a request.
* `database`: Metrics about the database.
* `reachable`: A boolean value reflecting the state of the
database connection. Please note that this flag **does not**
reflect the health of the database itself.
main database connection. Please note that this flag **does not**
reflect the health of the database itself nor does it reflect the
state of the read-only connection (if enabled).
]],
},
}
Expand Down

0 comments on commit 3b1c827

Please sign in to comment.