luxolus
/
open-vault
2
0
Fork 0
Code Issues 1 Pull Requests Releases Activity

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

* removed unpublished:true for sys/internal/* endpoints

* added changelog file

* updated change log and added placeholder summary as these endpoints are not mentioned in docs.

* added documentation for internal/ui/namspaces and resultant-acl

* updated log configs
This commit is contained in:
saltperfect 2021-10-16 00:20:14 +05:30 committed by GitHub
parent a302293c9a
commit 66369469d9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 92 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
changelog/12713.txt Normal file
View File

@ -0,0 +1,3 @@
```release-note:bug
http: removed unpublished true from logical_system path, making openapi spec consistent with documentation
```

10
vault/logical_system_paths.go
View File

@ -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,
Summary: "Backwards compatibility is not guaranteed for this API",
},
},
HelpSynopsis: strings.TrimSpace(sysHelp["internal-ui-namespaces"][0]),
@ -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]),
@ -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]),
@ -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]),
@ -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]),

38
website/content/api-docs/system/internal-ui-namespaces.mdx Normal file
View File

@ -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
website/content/api-docs/system/internal-ui-resultant-acl.mdx Normal file
View File

@ -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
website/data/api-docs-nav-data.json
View File

@ -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"