sevenhill/QSfera
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #3227 from rhafer/graph-user-doc

Browse Source 
[docs-only] Fix typos in graph user and groups docs
This commit is contained in:
Ralf Haferkamp
2022-02-23 10:49:55 +01:00
committed by GitHub
parent 917ae0b184 7d34f0a1bd
commit 97022928ca
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/extensions/graph/groups.md
+6 -6
View File
@@ -142,12 +142,12 @@ Example:
curl -k --request DELETE 'https://localhost:9200/graph/v1.0/groups/7a20f238-8a22-4458-902d-47674c317e5f' -u user:password 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}` #### `PATCH /groups/{id}`
Updating attributes of a single group is supposed to be done with a patch request. This is however currently not fully 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. See below.
### Adding a single member to a group ### Adding a single member to a group
@@ -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 ### Adding multiple members in a single request
@@ -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 ### Removing a member
#### `DELETE /groups/{groupid}/members/{id}/$ret` #### `DELETE /groups/{groupid}/members/{id}/$ref`
Example Example
@@ -196,4 +196,4 @@ curl -k --request DELETE \
-u user:password -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)
docs/extensions/graph/users.md
+1 -1
View File
@@ -148,7 +148,7 @@ Example:
curl -k --request DELETE 'https://localhost:9200/graph/v1.0/users/c067b139-c91c-4e47-8be6-669156a0587b' -u user:password 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}` #### `PATCH /users/{id}`