From 3e693495fb33f36507b6ccc66bb0ed831dd1cc27 Mon Sep 17 00:00:00 2001 From: Michael Barz Date: Sun, 12 Dec 2021 21:57:38 +0100 Subject: [PATCH] adapt the docs --- docs/extensions/storage/spaces.md | 6 +++--- docs/ocis/adr/0007-api-for-spaces.md | 6 ++---- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/extensions/storage/spaces.md b/docs/extensions/storage/spaces.md index e877171727..45b445c79c 100644 --- a/docs/extensions/storage/spaces.md +++ b/docs/extensions/storage/spaces.md @@ -47,16 +47,16 @@ This is an extract of an element of the list spaces response. An entire object h Having introduced the above, one can refer to a Drive with the following URL format: ```console -'https://localhost:9200/graph/v1.0/Drive(1284d238-aa92-42ce-bdc4-0b0000009157!07c26b3a-9944-4f2b-ab33-b0b326fc7570") +'https://localhost:9200/graph/v1.0/drives/1284d238-aa92-42ce-bdc4-0b0000009157!07c26b3a-9944-4f2b-ab33-b0b326fc7570 ``` Updating an entity attribute: ```console -curl -X PATCH 'https://localhost:9200/graph/v1.0/Drive("1284d238-aa92-42ce-bdc4-0b0000009157!07c26b3a-9944-4f2b-ab33-b0b326fc7570)' -d '{"name":"42"}' -v +curl -X PATCH 'https://localhost:9200/graph/v1.0/drives/1284d238-aa92-42ce-bdc4-0b0000009157!07c26b3a-9944-4f2b-ab33-b0b326fc7570' -d '{"name":"42"}' -v ``` -The previous URL resource path segment (`Drive(1284d238-aa92-42ce-bdc4-0b0000009157!07c26b3a-9944-4f2b-ab33-b0b326fc7570)`) is parsed and handed over to the storage registry in order to apply the patch changes in the body, in this case update the space name attribute to `42`. Since space names are not unique we only support addressing them by their unique identifiers, any other query would render too ambiguous and explode in complexity. +The previous URL resource path segment (`1284d238-aa92-42ce-bdc4-0b0000009157!07c26b3a-9944-4f2b-ab33-b0b326fc7570`) is parsed and handed over to the storage registry in order to apply the patch changes in the body, in this case update the space name attribute to `42`. Since space names are not unique we only support addressing them by their unique identifiers, any other query would render too ambiguous and explode in complexity. ### Updating a space description diff --git a/docs/ocis/adr/0007-api-for-spaces.md b/docs/ocis/adr/0007-api-for-spaces.md index 0058a8bd48..7d4d42f4a5 100644 --- a/docs/ocis/adr/0007-api-for-spaces.md +++ b/docs/ocis/adr/0007-api-for-spaces.md @@ -45,7 +45,7 @@ This the DRAFT for the API. ownCloud servers provide an API to query for available spaces of an user. -See the openAPI Specification for the [open Graph API](https://owncloud.dev/open-graph-api/). +See the openAPI Specification for the [Libre Graph API](https://owncloud.dev/libre-graph-api/). Most important, the API returns the WebDAV endpoint for each space. With that, clients do not have to make assumptions about WebDAV routes any more. @@ -80,8 +80,7 @@ The reply to both calls is either one or a list of [Drive representation objects "owner": { "@odata.type": "microsoft.graph.identitySet" }, "quota": { "@odata.type": "microsoft.graph.quota" }, "root": { "@odata.type": "microsoft.graph.driveItem" }, - "webUrl": "url", - "ocCoOwner": [ { "@odata.type": "microsoft.graph.identitySet" } ] + "webUrl": "url" } ``` @@ -93,7 +92,6 @@ The meaning of the objects in Open Graph API context are: 4. **quota** - quota information about this space 5. **root** - the root driveItem object. 6. **webUrl** - The URL to make this space visible in the browser. -7. **ocCoOwner** - 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: