Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Removed unpublished:true for sys/internal/* endpoints #12713

Merged
merged 5 commits into from Oct 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions changelog/12713.txt
@@ -0,0 +1,3 @@
```release-note:bug
http: removed unpublished true from logical_system path, making openapi spec consistent with documentation
```
10 changes: 5 additions & 5 deletions vault/logical_system_paths.go
Expand Up @@ -928,7 +928,7 @@ func (b *SystemBackend) internalPaths() []*framework.Path {
Operations: map[logical.Operation]framework.OperationHandler{
logical.ReadOperation: &framework.PathOperation{
Callback: pathInternalUINamespacesRead(b),
Unpublished: true,
hghaf099 marked this conversation as resolved.
Show resolved Hide resolved
Summary: "Backwards compatibility is not guaranteed for this API",
},
},
HelpSynopsis: strings.TrimSpace(sysHelp["internal-ui-namespaces"][0]),
Expand All @@ -939,7 +939,7 @@ func (b *SystemBackend) internalPaths() []*framework.Path {
Operations: map[logical.Operation]framework.OperationHandler{
logical.ReadOperation: &framework.PathOperation{
Callback: b.pathInternalUIResultantACL,
Unpublished: true,
Summary: "Backwards compatibility is not guaranteed for this API",
},
},
HelpSynopsis: strings.TrimSpace(sysHelp["internal-ui-resultant-acl"][0]),
Expand All @@ -950,7 +950,7 @@ func (b *SystemBackend) internalPaths() []*framework.Path {
Operations: map[logical.Operation]framework.OperationHandler{
logical.ReadOperation: &framework.PathOperation{
Callback: b.pathInternalCountersRequests,
Unpublished: true,
Summary: "Backwards compatibility is not guaranteed for this API",
},
},
HelpSynopsis: strings.TrimSpace(sysHelp["internal-counters-requests"][0]),
Expand All @@ -961,7 +961,7 @@ func (b *SystemBackend) internalPaths() []*framework.Path {
Operations: map[logical.Operation]framework.OperationHandler{
logical.ReadOperation: &framework.PathOperation{
Callback: b.pathInternalCountersTokens,
Unpublished: true,
Summary: "Backwards compatibility is not guaranteed for this API",
},
},
HelpSynopsis: strings.TrimSpace(sysHelp["internal-counters-tokens"][0]),
Expand All @@ -972,7 +972,7 @@ func (b *SystemBackend) internalPaths() []*framework.Path {
Operations: map[logical.Operation]framework.OperationHandler{
logical.ReadOperation: &framework.PathOperation{
Callback: b.pathInternalCountersEntities,
Unpublished: true,
Summary: "Backwards compatibility is not guaranteed for this API",
},
},
HelpSynopsis: strings.TrimSpace(sysHelp["internal-counters-entities"][0]),
Expand Down
38 changes: 38 additions & 0 deletions website/content/api-docs/system/internal-ui-namespaces.mdx
@@ -0,0 +1,38 @@
---
layout: api
page_title: /sys/internal/ui/namespaces - HTTP API
description: >-
The `/sys/internal/ui/namespaces` endpoint exposes namespaces to the UI.
---

# `/sys/internal/ui/namespaces`

The `/sys/internal/ui/namespaces` endpoint is used to expose namespaces
to the UI so that it can change its behavior in response, even before a user logs in.

This is currently only being used internally for the UI and is
an unauthenticated endpoint. Due to the nature of its intended usage, there is no
guarantee on backwards compatibility for this endpoint.

## Get Namespaces

This endpoint lists the namespaces relevant to the UI.

| Method | Path |
| :----- | :------------------------------- |
| `GET` | `/sys/internal/ui/namespaces` |

### Sample Request

```shell-session
$ curl \
http://127.0.0.1:8200/v1/sys/internal/ui/namespaces
```

### Sample Response

```json
{
"namespaces": []
}
```
38 changes: 38 additions & 0 deletions website/content/api-docs/system/internal-ui-resultant-acl.mdx
@@ -0,0 +1,38 @@
---
layout: api
page_title: /sys/internal/ui/resultant-acl - HTTP API
description: >-
The `/sys/internal/ui/resultant-acl` endpoint exposes resultant-acl to the UI.
---

# `/sys/internal/ui/resultant-acl`

The `/sys/internal/ui/resultant-acl` endpoint is used to expose resultant-acl
to the UI so that it can change its behavior in response, even before a user logs in.

This is currently only being used internally for the UI and is
an unauthenticated endpoint. Due to the nature of its intended usage, there is no
guarantee on backwards compatibility for this endpoint.

## Get Resultant-acl

This endpoint lists the resultant-acl relevant to the UI.

| Method | Path |
| :----- | :------------------------------- |
| `GET` | `/sys/internal/ui/resultant-acl` |

### Sample Request

```shell-session
$ curl \
http://127.0.0.1:8200/v1/sys/internal/ui/resultant-acl
```

### Sample Response

```json
{
"resultant-acl": []
}
```
8 changes: 8 additions & 0 deletions website/data/api-docs-nav-data.json
Expand Up @@ -409,6 +409,14 @@
"title": "<code>/sys/internal/ui/mounts</code>",
"path": "system/internal-ui-mounts"
},
{
"title": "<code>/sys/internal/ui/namespaces</code>",
"path": "system/internal-ui-namespaces"
},
{
"title": "<code>/sys/internal/ui/resultant-acl</code>",
"path": "system/internal-ui-resultant-acl"
},
{
"title": "<code>/sys/key-status</code>",
"path": "system/key-status"
Expand Down