Skip to content

Commit

Permalink
Backport of docs: Adds initial sg documentation for the health API in…
Browse files Browse the repository at this point in the history
…to release 1.20.x (#21988)

* Adds initial sg documentation for the health API  (#21763)

Adds initial sg documentation

* Backport of docs: Adds initial sg documentation for the health API

into release/1.20.x

---------

Co-authored-by: Nick Wales <[email protected]>
  • Loading branch information
aimeeu and nickwales authored Dec 4, 2024
1 parent 297ca6b commit 5b91606
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions website/content/api-docs/health.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The table below shows this endpoint's support for
| `YES` <sup>1</sup> | `all` | `background refresh` | `node:read,service:read` |

<p>
<sup>1</sup>some query parameters will use the <a href="/consul/api-docs/features/blocking#streaming-backend">streaming backend</a> for blocking queries.
<sup>1</sup>some query parameters will use the <a href="/consul/api-docs/features/blocking#streaming-backend">streaming backend</a> for blocking queries.
</p>

### Path Parameters
Expand Down Expand Up @@ -265,14 +265,17 @@ The table below shows this endpoint's support for

- `merge-central-config` - Include this flag in a request for `connect-proxy` kind or `*-gateway` kind
services to return a fully resolved service definition that includes merged values from the
[proxy-defaults/global](/consul/docs/connect/config-entries/proxy-defaults) and
[proxy-defaults/global](/consul/docs/connect/config-entries/proxy-defaults) and
[service-defaults/:service](/consul/docs/connect/config-entries/service-defaults) config entries.
Returning a fully resolved service definition is useful when a service was registered using the
Returning a fully resolved service definition is useful when a service was registered using the
[/catalog/register](/consul/api-docs/catalog#register_entity) endpoint, which does not automatically merge config entries.

- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

- `sg` `(string: "")` <EnterpriseAlert inline /> - Specifies the sameness group the service is a member of to
facilitate requests to identical services in other peers or partitions.

### Sample Request

```shell-session
Expand Down

0 comments on commit 5b91606

Please sign in to comment.