mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-04 19:29:49 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add a driveStatus value to the spaces object.

Browse Source 
It indicates the status if the user has accepted the space or if
it is mandatory like shares or personal.
This commit is contained in:
Klaas Freitag
2021-04-19 17:25:25 +02:00
parent 95035af06d
commit 10ed8a6903
1 changed files with 14 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/adr/0005-api-for-spaces.md
View File

@@ -63,7 +63,8 @@ The reply to both calls is either one or a list of [Drive representation objects
"id": "string",
"createdDateTime": "string (timestamp)",
"description": "string",
"driveType": "personal | business | documentLibrary",
"driveType": "personal | projectSpaces | shares",
"driveStatus": "accepted | pending | mandatory",
"eTag": "string",
"lastModifiedDateTime": "string (timestamp)",
"name": "string",
@@ -78,12 +79,13 @@ The meaning of the object are in ownClouds context:
1. **id** - a unique ID identifying the space
2. **driveType** - describing the type of the space.
3. **eTag** - the current ETag of the space
4. **owner** - an owner object to whom the space belongs
5. **webUrl** - the relative Webdav path in ownCloud. It must include the `remote.php` part in oC10 installations.
6. **coowner** - optional array owner objects of the co-owners of a space (*)
3. **driveStatus** - telling the status
4. **eTag** - the current ETag of the space
5. **owner** - an owner object to whom the space belongs
6. **webUrl** - the relative Webdav path in ownCloud. It must include the `remote.php` part in oC10 installations.
7. **coowner** - optional array owner objects of the co-owners of a space (*)
The following driveType values are available in the first step, but might be enhanced later:
The following *driveType* values are available in the first step, but might be enhanced later:
* **personal**: The users home space
* **projectSpaces**: The project spaces available for the user (*)
@@ -91,6 +93,12 @@ The following driveType values are available in the first step, but might be enh
The (*) marked types are not defined in the official MS API.
The following *driveStatus* values are available:
* **accepted**: The user has accepted the space and uses it
* **pending**: The user has not yet accepted the space , but can use it after having it accepted.
* **mandatory**: This is an mandatory space. Used for the personal- and shares-space. The user can not influence if it is visible or not, it is always available.
### Positive Consequences
- A well understood and mature API from Microsoft adopted to our needs.