Skip to content

Commit

Permalink
docs: added OpenAPI spec for rbac-backend (#1830)
Browse files Browse the repository at this point in the history
* docs: added OpenAPI spec for rbac-backend

Signed-off-by: Kashish Mittal <[email protected]>

* converted rbac-backend's openapi spec to yaml

Signed-off-by: Kashish Mittal <[email protected]>

* corrected '#ref' to ''

Signed-off-by: Kashish Mittal <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Add Schema `Condition` for rbac-backend openapi spec

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* fixed formatting errors in rbac openapi spec

Signed-off-by: Kashish Mittal <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* upadated plugins/rbac-backend/openapi.yaml

Signed-off-by: Kashish Mittal <[email protected]>

* Update plugins/rbac-backend/openapi.yaml

Co-authored-by: Oleksandr Andriienko <[email protected]>

* upadated apis.md to remove request parameters for delete permission

Signed-off-by: Kashish Mittal <[email protected]>

---------

Signed-off-by: Kashish Mittal <[email protected]>
Co-authored-by: Oleksandr Andriienko <[email protected]>
  • Loading branch information
04kash and AndrienkoAleksandr authored Jul 23, 2024
1 parent e24b522 commit 4eb2035
Show file tree
Hide file tree
Showing 2 changed files with 682 additions and 11 deletions.
11 changes: 0 additions & 11 deletions plugins/rbac-backend/docs/apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,17 +396,6 @@ ex. <http://localhost:7007/api/permission/policies/role/default/test?permission=

Deletes a permission policy of a specified entity.

Request Parameters:

| Parameter name | Description | Type |
| -------------- | ----------------------------------------------------------------------------- | ------ |
| kind | Kind of the entity | String |
| namespace | Namespace of the entity | String |
| name | Username of the entity | String |
| permission | Permission from a specific plugin, Resource type or name | String |
| policy | Policy action for the permission, `create`, `read`, `update`, `delete`, `use` | String |
| effect | `allow` or `deny` | String |

Returns a status code of 204 upon success.

---
Expand Down
Loading

0 comments on commit 4eb2035

Please sign in to comment.