Skip to content

Commit

Permalink
Merge 0c7746c into backport/docs-CE556/hopefully-flowing-sturgeon
Browse files Browse the repository at this point in the history
  • Loading branch information
hc-github-team-consul-core authored Jul 18, 2024
2 parents 79883c5 + 0c7746c commit 980feae
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 9 deletions.
4 changes: 4 additions & 0 deletions website/content/api-docs/agent/service.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -684,6 +684,8 @@ The `/agent/service/register` endpoint supports camel case and _snake case_ for
`false`. See [anti-entropy syncs](/consul/docs/architecture/anti-entropy) for
additional information.

@include 'http-api-body-options-partition.mdx'

#### Connect Structure

For the `Connect` field, the parameters are:
Expand Down Expand Up @@ -769,6 +771,8 @@ The corresponding CLI command is [`consul services deregister`](/consul/commands
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace of the service you deregister.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down
3 changes: 1 addition & 2 deletions website/content/api-docs/exported-services.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,7 @@ The table below shows this endpoint's support for

### Query Parameters

- `partition` `(string: "")` <EnterpriseAlert inline /> - Specifies the admin partition the services are exported from. When not specified, assumes the default value `default`.

@include 'http-api-query-parms-partition.mdx'

### Sample Request

Expand Down
6 changes: 6 additions & 0 deletions website/content/api-docs/kv.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,8 @@ The corresponding CLI command is [`consul kv get`](/consul/commands/kv/get).
For recursive lookups, the namespace may be specified as '\*'
to return results for all namespaces.

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down Expand Up @@ -220,6 +222,8 @@ The corresponding CLI command is [`consul kv put`](/consul/commands/kv/put).
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'

### Sample Payload

The payload is arbitrary, and is loaded directly into Consul as supplied.
Expand Down Expand Up @@ -289,6 +293,8 @@ The corresponding CLI command is [`consul kv delete`](/consul/commands/kv/delete
- `ns` `(string: "")` <EnterpriseAlert inline /> - Specifies the namespace to query.
You can also [specify the namespace through other methods](#methods-to-specify-namespace).

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down
27 changes: 20 additions & 7 deletions website/content/api-docs/namespaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ The corresponding CLI command is [`consul namespace create`](/consul/commands/na
- `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata
to associate with the namespace.

@include 'http-api-body-options-partition.mdx'

### Sample Payload

```json
Expand Down Expand Up @@ -169,6 +171,10 @@ The corresponding CLI command is [`consul namespace read`](/consul/commands/name

- `name` `(string: <required>)` - Specifies the namespace to read.

### Query Parameters

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down Expand Up @@ -272,6 +278,8 @@ The corresponding CLI command is [`consul namespace update`](/consul/commands/na
- `Meta` `(map<string|string>: <optional>)` - Specifies arbitrary KV metadata
to associate with the namespace.

@include 'http-api-body-options-partition.mdx'

### Sample Payload

```json
Expand Down Expand Up @@ -348,18 +356,15 @@ $ curl --request PUT \

## Delete a Namespace

This endpoint marks a Namespace for deletion. Once marked Consul will
deleted all the associated Namespaced data in the background. Only once
all associated data has been deleted will the Namespace actually disappear.
Until then, further reads can be performed on the namespace and a `DeletedAt`
field will now be populated with the timestamp of when the Namespace was
marked for deletion.
This endpoint marks a Namespace for deletion. Once marked, Consul deletes all the associated Namespaced data in the background. Only after all associated data has been deleted, Consul deletes the Namespace.
Until then, you can perform further reads on the namespace, and a `DeletedAt`
field is populated with the timestamp of when the Namespace was marked for deletion.

| Method | Path | Produces |
| -------- | ------------------ | -------- |
| `DELETE` | `/namespace/:name` | N/A |

This endpoint will return no data. Success or failure is indicated by the status
This endpoint returns no data. Success or failure is indicated by the status
code returned.

The table below shows this endpoint's support for
Expand All @@ -378,6 +383,10 @@ The corresponding CLI command is [`consul namespace delete`](/consul/commands/na

- `name` `(string: <required>)` - Specifies the namespace to delete.

### Query Parameters

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down Expand Up @@ -449,6 +458,10 @@ the request has been granted any access in the namespace (read, list or write).

The corresponding CLI command is [`consul namespace list`](/consul/commands/namespace/list).

### Query Parameters

@include 'http-api-query-parms-partition.mdx'

### Sample Request

```shell-session
Expand Down

0 comments on commit 980feae

Please sign in to comment.