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.

Sign up for GitHub

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

Fix description of 'update' operation #5

Open
wants to merge 1 commit into
base: 2.0
Choose a base branch
from
Open

Fix description of 'update' operation #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions includes/_update-permission.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,19 @@ This request updates the operations for a permission keeping the same path and a

### HTTP Request

`POST: https://example.com/api/v2/permissions`
`PUT: https://example.com/api/v2/permissions`

`PATCH: https://example.com/api/v2/permissions`

### Request Parameters

Parameter | Default | Required | Type | Description
--------- | --------- | --------- | --------- | -----------
uuid | none | yes | string | The permission uuid that was returned when a permission was created
path | none | yes | string | The path of the permission you would like to update the operations for
actor | none | yes | string | The actor that you would like to update the operations for
path | none | yes<sup>1</sup> | string | The path of the permission you would like to update the operations for
actor | none | yes<sup>1</sup> | string | The actor that you would like to update the operations for
operations | none | yes | array of strings | The new list of operations you would like to update this permission for

<sup>1</sup> Authentication-specific identities [explained here.](https://github.com/cloudfoundry-incubator/credhub/blob/master/docs/authentication-identities.md) <br>
<sup>2</sup> Supported operations: read, write, delete, read_acl, write_acl
<sup>1</sup> Value required for a PUT request but forbidden for a PATCH request.