summaryrefslogtreecommitdiffstats
path: root/protocol.txt
blob: 7e0f3c25d36d7e24e0b4ff984d3193c5a6831f88 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
ACF2 HTTP Protocol
==================

Load JavaScript client:
req: GET /

Start transaction:
req: POST /
resp: txn ID (in header as X-ACF-Transaction-ID)
      - use X-ACF-Transaction-ID in the header of any subsequent
      	request to process it in the transaction's context

Commit transaction:
req: POST /
     X-ACF-Transaction-ID: <txn_id>

Abort transaction:
req: DELETE /
     X-ACF-Transaction-ID: <txn_id>

Get object:
req: GET /config/<obj_path>
resp: JSON object, with the following attributes:
      data: JSON serialization of object
      	    - primitive types as JSON primitives
      	    - references as path names (relative to scope)
      	    - models and collections as JSON objects or arrays with
	      members as attributes:
      	    - primitive members as JSON primitives
      	    - reference, model, and collection members as path names
      meta: JSON object, with the following attributes
      	    - name (last component of path name)
      	    - ui-name (shown to user)
      	    - description (optional help text)
      	    - type (e.g. model, collection, reference, string, number,
	      boolean)
      	    - widget (name of client-side JS module used to display
	      the data)
      	    - required (boolean)
	    - default
      	    - max-length
      	    - choices (optional array of allowed values)
      	    - ui-choices (user-friendly choices to be shown in combo
	      boxes)
      	    - fields (model only): array of field metadata JSON
	      objects
      	    - members (collection only): metadata for members (JSON
	      object)
      	    - scope (references only): subtree where the reference can
	      refer to

Create/update object:
req: PUT /config/<obj_path>
     - body shall contain the object serialized as the data attribute
       in GET responses
     - undefined model attributes are deleted

Delete object:
req: DELETE /config/<obj_path>

Invoke object-specific action (not yet supported by server):
req: POST /config/<obj_path>/<action>
     - arguments passed as a JSON array in body; serialization as in
       GET responses
resp: action-specific JSON
      - for time-consuming actions, can return multiple JSON
      	documents, each containing a status update