Add a REST-like API to webservice

See https://en.wikipedia.org/wiki/Representational_state_transfer

changed milestone to %FusionDirectory 1.4

added plugin-webservice label

We need to look into what is commonly used for auth on REST APIs.

Basic ideas regarding the API itself once logged in:

• /objects/<type>
  • GET: list objects of <type>
  • POST: create an object
• /objects/<type>/<dn>
  • GET: Get an objects fields from main tab
  • PATCH: Update an object fields values
  • DELETE: Delete the object
• /objects/<type>/<dn>/<tab>
  • GET: Get an objects fields from a tab
  • PATCH: Update an object tab fields values
  • DELETE: Deactivate the tab
• /objects/<type>/<dn>/<tab>/<field>
  • GET: Get a field value(s)
  • PUT: Replace value(s) of the field
  • DELETE: Reset the field to its default value
• /objects/<type>/<dn>/<tab>/<field>/values
  • PATCH: Add values to multivaluated field
  • DELETE: Remove values from multivaluated field
• /search
  • GET/POST: Complex search, possibly of several types
• /user/<dn>/lock
  • GET/POST: Get/Set lock status?
• /types
  • GET: List types
• /types/<type>
  • GET: Get type info

I think the login process should involve specifying which API version we want, so that future updates are possible.

added 3h 30m of time spent at 2019-02-26

mentioned in commit add41c1d

mentioned in commit 91f80b69

New files:

• webservice/include/webservice/class_fdRPCService.inc
• webservice/html/rest.php
• webservice/html/openapi.yaml

added packaging label

added 7h of time spent at 2019-02-28

added 5h of time spent at 2019-02-28

mentioned in commit aac9f713

mentioned in commit 7b78fce5

added user-manual label

hello @MCMic,

following some discussion at telecom :

• have webservice call to update images in user profile (binary case)
• have webservice call to create/update supannrefid (multivaluated case)
• have webservice call to use template at user creation

Cheers

This should now all be possible:

1. have webservice call to update images in user profile (binary case)
   PUT /objects/user/<dn>/user/jpegPhoto
   with as body the image content, base64 encoded in a json string.
2. have webservice call to create/update supannrefid (multivaluated case)
   PUT /objects/user/<dn>/supannAccount/supannRefId
   with as body the list of all wanted values (json-encoded)
   POST /objects/user/<dn>/supannAccount/supannRefId
   with as body the list of values to add to existing ones (json-encoded)
   DELETE /objects/user/<dn>/supannAccount/supannRefId
   with as body the list of values to remove from existing ones (json-encoded)
3. have webservice call to use template at user creation
   POST /objects/user
   with as body a JSON objects with two fields:
   attrs: contains field values, grouped by tab.
   template: contains the dn of the template to use, if any.
   Example in our test: https://gitlab.fusiondirectory.org/automated-testing/automated-testing/blob/1.4-dev/plugins/webservice/webserviceRestTest.php#L54