Skip to content

Commit

Permalink
docs(ee/*) fix typos and broken tables (Kong#1126)
Browse files Browse the repository at this point in the history 
Typos in Nav and RBAC admin-api broken tables
  • Loading branch information
@gqadro
gqadro authored and Aron Eidelman committed Jan 31, 2019
1 parent d711697 commit 55c32d9
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 33 deletions.
2 changes: 1 addition & 1 deletion app/_includes/nav.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ <h5 class="list-group-item-action">Offerings</h5>
</div>
<div class="list-item">
<a href="https://docs.konghq.com/enterprise/latest/developer-portal/introduction/" class="list-group-item list-group-item-action">Launch your Dev Portal
<p>Learn how to create and manager your Kong Dev Portal.<br><br></p></a>
<p>Learn how to create and manage your Kong Dev Portal.<br><br></p></a>
</div>
</div>
</div>
Expand Down
67 changes: 35 additions & 32 deletions app/enterprise/0.34-x/rbac/admin-api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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**

Expand Down Expand Up @@ -548,7 +549,7 @@ HTTP 200 OK



## Add a Role Entity Permisson
## Add a Role Entity Permission
**Endpoint**
<div class="endpoint post">/rbac/roles/{name_or_id}/entities</div>

Expand Down Expand Up @@ -597,13 +598,13 @@ HTTP 201 Created

---

## Retrieve a Role Entity Permisson
## Retrieve a Role Entity Permission
**Endpoint**
<div class="endpoint get">/rbac/roles/{name_or_id}/entities/{entity_id}</div>

| 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**
Expand Down Expand Up @@ -636,9 +637,9 @@ HTTP 200 Ok
**Endpoint**
<div class="endpoint get">/rbac/roles/{name_or_id}/entities</div>

| Attribute | Description |
| --------- | ----------- |
| `name_or_id` | The RBAC permisson name or UUID. |
| Attribute | Description |
| --------- | ----------- |
| `name_or_id` | The RBAC permisson name or UUID. |

**Response**

Expand Down Expand Up @@ -673,17 +674,17 @@ HTTP 200 Ok

<div class="endpoint patch">/rbac/roles/{name_or_id}/entities/{entity_id}</div>

| 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**

Expand Down Expand Up @@ -763,14 +764,15 @@ HTTP 200 OK

<div class="endpoint post">/rbac/users/{name_or_id}/roles</div>

| 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**
Expand Down Expand Up @@ -803,9 +805,9 @@ HTTP 201 Created

<div class="endpoint get">/rbac/users/{name_or_id}/roles</div>

| Attribute | Description |
| --------- | ----------- |
| `name_or_id` | The RBAC user name or UUID. |
| Attribute | Description |
| --------- | ----------- |
| `name_or_id` | The RBAC role name or UUID. |


**Response**
Expand Down Expand Up @@ -838,12 +840,13 @@ HTTP 200 OK

<div class="endpoint delete">/rbac/users/{name_or_id}/roles</div>

| 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. |
Expand All @@ -864,9 +867,9 @@ HTTP 204 No Content

<div class="endpoint get">/rbac/users/{name_or_id}/permissions</div>

| Attribute | Description |
| --------- | ----------- |
| `name_or_id` | The RBAC user name or UUID. |
| Attribute | Description |
| --------- | ----------- |
| `name_or_id` | The RBAC role name or UUID. |

**Response**

Expand All @@ -892,4 +895,4 @@ HTTP 200 OK

Next: [RBAC Examples &rsaquo;]({{page.book.next}})

---
---

0 comments on commit 55c32d9

Please sign in to comment.