From 55c32d9ab37078273b8c558dff6b7aed42d6eb42 Mon Sep 17 00:00:00 2001 From: Luigi Manzo <30706960+gqadro@users.noreply.github.com> Date: Thu, 31 Jan 2019 00:45:37 +0000 Subject: [PATCH] docs(ee/*) fix typos and broken tables (#1126) Typos in Nav and RBAC admin-api broken tables --- app/_includes/nav.html | 2 +- app/enterprise/0.34-x/rbac/admin-api.md | 67 +++++++++++++------------ 2 files changed, 36 insertions(+), 33 deletions(-) diff --git a/app/_includes/nav.html b/app/_includes/nav.html index 5a958f1dd4a0..501d4350bebe 100644 --- a/app/_includes/nav.html +++ b/app/_includes/nav.html @@ -107,7 +107,7 @@
Offerings
Launch your Dev Portal -

Learn how to create and manager your Kong Dev Portal.

 +

Learn how to create and manage your Kong Dev Portal.

diff --git a/app/enterprise/0.34-x/rbac/admin-api.md b/app/enterprise/0.34-x/rbac/admin-api.md index edf5b4a95b34..1df686917ee8 100644 --- a/app/enterprise/0.34-x/rbac/admin-api.md +++ b/app/enterprise/0.34-x/rbac/admin-api.md @@ -484,10 +484,11 @@ HTTP 200 OK | `endpoint` | The endpoint associated with this permisson. | **Request Body** -| Attribute | Description | -| --------- | ----------- | + +| Attribute | Description | +| --------- | ----------- | | `negative` | If true, explicitly disallow the actions associated with the permissions tied to this resource. By default this value is false. | -| `actions` | One or more actions associated with this permission. | +| `actions` | One or more actions associated with this permission. | **Response** @@ -548,7 +549,7 @@ HTTP 200 OK -## Add a Role Entity Permisson +## Add a Role Entity Permission **Endpoint**
/rbac/roles/{name_or_id}/entities
@@ -597,13 +598,13 @@ HTTP 201 Created --- -## Retrieve a Role Entity Permisson +## Retrieve a Role Entity Permission **Endpoint**
/rbac/roles/{name_or_id}/entities/{entity_id}
| Attribute | Description | | --------- | ----------- | -| `name_or_id` | The RBAC permisson name or UUID. | +| `name_or_id` | The RBAC permission name or UUID. | | `entity_id` | id of the entity associated with this permission. | **Response** @@ -636,9 +637,9 @@ HTTP 200 Ok **Endpoint**
/rbac/roles/{name_or_id}/entities
-| Attribute | Description | -| --------- | ----------- | -| `name_or_id` | The RBAC permisson name or UUID. | +| Attribute | Description | +| --------- | ----------- | +| `name_or_id` | The RBAC permisson name or UUID. | **Response** @@ -673,17 +674,17 @@ HTTP 200 Ok
/rbac/roles/{name_or_id}/entities/{entity_id}
-| Attribute | Description | -| --------- | ----------- | -| `name_or_id` | The RBAC role name or UUID. | -| `entity_id` | The entity name or UUID. | +| Attribute | Description | +| --------- | ----------- | +| `name_or_id` | The RBAC role name or UUID. | +| `entity_id` | The entity name or UUID. | **Request Body** -| Attribute | Description | -| --------- | ----------- | -| `negative` | If true, explicitly disallow the actions associated with the permissions tied to this resource. By default this value is false. | -| `actions` | One or more actions associated with this permission. | +| Attribute | Description | +| --------- | ----------- | +| `negative` | If true, explicitly disallow the actions associated with the permissions tied to this resource. By default this value is false. | +| `actions` | One or more actions associated with this permission. | **Response** @@ -763,14 +764,15 @@ HTTP 200 OK
/rbac/users/{name_or_id}/roles
-| Attribute | Description | -| --------- | ----------- | -| `name_or_id` | The RBAC user name or UUID. | +| Attribute | Description | +| --------- | ----------- | +| `name_or_id` | The RBAC role name or UUID. | **Request Body** -| Attribute | Description | -| --------- | ----------- | + +| Attribute | Description | +| --------- | ----------- | | `roles` | Comma-separated list of role names to assign to the user. | **Response** @@ -803,9 +805,9 @@ HTTP 201 Created
/rbac/users/{name_or_id}/roles
-| Attribute | Description | -| --------- | ----------- | -| `name_or_id` | The RBAC user name or UUID. | +| Attribute | Description | +| --------- | ----------- | +| `name_or_id` | The RBAC role name or UUID. | **Response** @@ -838,12 +840,13 @@ HTTP 200 OK
/rbac/users/{name_or_id}/roles
-| Attribute | Description | -| --------- | ----------- | -| `name_or_id` | The RBAC user name or UUID. | +| Attribute | Description | +| --------- | ----------- | +| `name_or_id` | The RBAC role name or UUID. | **Request Body** + | Attribute | Description | | --------- | ----------- | | `roles` | Comma-separated list of role names to assign to the user. | @@ -864,9 +867,9 @@ HTTP 204 No Content
/rbac/users/{name_or_id}/permissions
-| Attribute | Description | -| --------- | ----------- | -| `name_or_id` | The RBAC user name or UUID. | +| Attribute | Description | +| --------- | ----------- | +| `name_or_id` | The RBAC role name or UUID. | **Response** @@ -892,4 +895,4 @@ HTTP 200 OK Next: [RBAC Examples ›]({{page.book.next}}) ---- \ No newline at end of file +---