From 5b91606d825cc364f8a8f56d29b5ae71cc8fbe57 Mon Sep 17 00:00:00 2001 From: Aimee Ukasick Date: Wed, 4 Dec 2024 11:43:18 -0600 Subject: [PATCH] Backport of docs: Adds initial sg documentation for the health API into 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 <588472+nickwales@users.noreply.github.com> --- website/content/api-docs/health.mdx | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/website/content/api-docs/health.mdx b/website/content/api-docs/health.mdx index 405c97df1f1a..dbeea876c0d2 100644 --- a/website/content/api-docs/health.mdx +++ b/website/content/api-docs/health.mdx @@ -222,7 +222,7 @@ The table below shows this endpoint's support for | `YES` 1 | `all` | `background refresh` | `node:read,service:read` |

- 1some query parameters will use the streaming backend for blocking queries. + 1some query parameters will use the streaming backend for blocking queries.

### Path Parameters @@ -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: "")` - Specifies the namespace of the service. You can also [specify the namespace through other methods](#methods-to-specify-namespace). +- `sg` `(string: "")` - 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