status-im
/
consul
mirror of https://github.com/status-im/consul.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update docs for merge-central-config support (#14597) 

Updates API docs to highlight merge-central-config support.
This commit is contained in:
Riddhi Shah 2022-09-16 14:48:03 -07:00 committed by GitHub
parent 4b89b66fc9
commit 59249b7dda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
website/content/api-docs/catalog.mdx
View File

@ -537,9 +537,17 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `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](/docs/connect/config-entries/proxy-defaults) and
[service-defaults/:service](/docs/connect/config-entries/service-defaults) config entries.
Returning a fully resolved service definition is useful when a service was registered using the
[/catalog/register](/api-docs/catalog#register_entity) endpoint, which does not automatically merge config entries.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the services you lookup.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).
### Sample Request
```shell-session
@ -874,6 +882,13 @@ The table below shows this endpoint's support for
- `filter` `(string: "")` - Specifies the expression used to filter the
queries results prior to returning the data.
- `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](/docs/connect/config-entries/proxy-defaults) and
[service-defaults/:service](/docs/connect/config-entries/service-defaults) config entries.
Returning a fully resolved service definition is useful when a service was registered using the
[/catalog/register](/api-docs/catalog#register_entity) endpoint, which does not automatically merge config entries.
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the services you lookup.
The namespace may be specified as '\*' to return results for all namespaces.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

7
website/content/api-docs/health.mdx
View File

@ -264,6 +264,13 @@ The table below shows this endpoint's support for
- `peer` `(string: "")` - Specifies the imported service's peer. Applies only to imported services.
- `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](/docs/connect/config-entries/proxy-defaults) and
[service-defaults/:service](/docs/connect/config-entries/service-defaults) config entries.
Returning a fully resolved service definition is useful when a service was registered using the
[/catalog/register](/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).