Skip to content

Commit

Permalink
Merge pull request #3227 from rhafer/graph-user-doc
Browse files Browse the repository at this point in the history
[docs-only] Fix typos in graph user and groups docs
  • Loading branch information
rhafer authored Feb 23, 2022
2 parents 917ae0b + 7d34f0a commit 9702292
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions docs/extensions/graph/groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -142,12 +142,12 @@ Example:
curl -k --request DELETE 'https://localhost:9200/graph/v1.0/groups/7a20f238-8a22-4458-902d-47674c317e5f' -u user:password
```

When successful the API returns no Response Body and the HTTP status code 204 (No Content)
When successful the API returns no response body and the HTTP status code 204 (No Content)

#### `PATCH /groups/{id}`

Updating attributes of a single group is supposed to be done with a patch request. This is however currently not fully
implemented for our write-enabled backends. The PATCH request can however to used to add multiple members to a group at once.
implemented for our write-enabled backends. The PATCH request can however be used to add multiple members to a group at once.
See below.

### Adding a single member to a group
Expand All @@ -164,7 +164,7 @@ curl -k --header "Content-Type: application/json" \
```

When successful the API returns no Response Body and the HTTP status code 204 (No Content)
When successful the API returns no response body and the HTTP status code 204 (No Content)

### Adding multiple members in a single request

Expand All @@ -182,11 +182,11 @@ Example:
}
```

When successful the API returns no Response Body and the HTTP status code 204 (No Content)
When successful the API returns no response body and the HTTP status code 204 (No Content)

### Removing a member

#### `DELETE /groups/{groupid}/members/{id}/$ret`
#### `DELETE /groups/{groupid}/members/{id}/$ref`

Example

Expand All @@ -196,4 +196,4 @@ curl -k --request DELETE \
-u user:password
```

When successful the API returns no Response Body and the HTTP status code 204 (No Content)
When successful the API returns no response body and the HTTP status code 204 (No Content)
2 changes: 1 addition & 1 deletion docs/extensions/graph/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Example:
curl -k --request DELETE 'https://localhost:9200/graph/v1.0/users/c067b139-c91c-4e47-8be6-669156a0587b' -u user:password
```

When successful the API returns no Response Body and the HTTP status code 204 (No Content)
When successful the API returns no response body and the HTTP status code 204 (No Content)


#### `PATCH /users/{id}`
Expand Down

0 comments on commit 9702292

Please sign in to comment.