Document new Sharee API

[rullzer]

owncloud/core#18234

@nickvergessen

[SergioBertolinSG]

Mobile apps are going to start to develop using this today. Would be nice to have docs ready. At least a first draft.
cc @ggdiez @davivel

[nickvergessen]

This is the URL to be used:
http://localhost/owncloud/ocs/v2.php/apps/files_sharing/api/v1/sharees?format=json

Allowed method: GET

Query strings:

Key	type	description	default
search	string	the search string
itemType	string	the type which is shared (e.g. file or folder)
shareType[]	integer	any of the shareTypes (0,1, 4, 6)
page	integer	the page number to be returned	1
perPage	integer	the number of items per page	200

Result:
For each sharee there will be on entry in this form:

{
  "label": "admin",
  "value": {
    "shareType": 1,
    "shareWith": "admin"
  }
}

or

   <element>
    <label>admin</label>
    <value>
     <shareType>0</shareType>
     <shareWith>admin</shareWith>
    </value>
   </element>

Depending on the request.

The complete response looks like this:

{
  "ocs": {
    "meta": {
      "status": "ok",
      "statuscode": 100,
      "message": null
    },
    "data": {
      "exact": {
        "users": [

        ],
        "groups": [

        ],
        "remotes": [

        ]
      },
      "users": [
        {
          "label": "admin",
          "value": {
            "shareType": 0,
            "shareWith": "admin"
          }
        },
        {
          "label": "test1",
          "value": {
            "shareType": 0,
            "shareWith": "test1"
          }
        }
      ],
      "groups": [
        {
          "label": "admin",
          "value": {
            "shareType": 1,
            "shareWith": "admin"
          }
        },
        {
          "label": "tester",
          "value": {
            "shareType": 1,
            "shareWith": "tester"
          }
        }
      ],
      "remotes": [

      ]
    }
  }
}

The exact list holds an array of exact matches. those should be presented first.

Sharees that have the item already shared need to be filtered out.

[SergioBertolinSG]

@nickvergessen thanks!

[ggdiez]

@SergioBertolinSG @nickvergessen
I go to start with the Sharees in the iOS app

Thanks!!!

[davivel]

cc @masensio @rperezb

[PVince81]

I don't see this in any dev doc, @carlaschroder did you close this by mistake ?

[carlaschroder]

I don't see this in any dev doc, @carlaschroder did you close this by mistake ?

No idea. That was a year ago.

[carlaschroder]

Ah, closed in April. Still no idea.

[hodyroff]

Share API is currently here: https://doc.owncloud.org/server/9.1/developer_manual/core/ocs-share-api.html
Whats wrong with it?

[PVince81]

Sharee, extra "e" 😉

I prefer to call it "recipients" instead of "sharee".
There's a new OCS endpoint that is used by the share dialog autocomplete when you pick a user/group to share to. That's the one.

[pmaier1]

Well, 'sharee' is a common term in the 'internet/cloud dictionary'. Since 'recipient' is way more clear and easier to understand I vote for it.

[davivel]

There's a new OCS endpoint

Ayayayay, endpoint update incoming?