Merge pull request #1552 from turt2live/travis/as/normal-events

Specify that application services receive events in the CSAPI format

api/application-service/transactions.yaml

@@ -21,8 +21,6 @@ schemes:
   - https
   - http
 basePath: "/"
-consumes:
-  - application/json
 produces:
   - application/json
 paths:
@@ -53,37 +51,16 @@ paths:
             type: object
             example: {
               "events": [
-                {
-                  "age": 32,
-                  "content": {
-                      "body": "incoming message",
-                      "msgtype": "m.text"
-                  },
-                  "event_id": "$14328055551tzaee:localhost",
-                  "origin_server_ts": 1432804485886,
-                  "room_id": "!TmaZBKYIFrIPVGoUYp:localhost",
-                  "type": "m.room.message",
-                  "user_id": "@bob:localhost"
-                },
-                {
-                  "age": 1984,
-                  "content": {
-                      "body": "another incoming message",
-                      "msgtype": "m.text"
-                  },
-                  "event_id": "$1228055551ffsef:localhost",
-                  "origin_server_ts": 1432804485886,
-                  "room_id": "!TmaZBKYIFrIPVGoUYp:localhost",
-                  "type": "m.room.message",
-                  "user_id": "@bob:localhost"
-                }
+                {"$ref": "../../event-schemas/examples/m.room.member"},
+                {"$ref": "../../event-schemas/examples/m.room.message#m.text"}
               ]
             }
-            description: "Transaction informations"
+            description: Transaction information
             properties:
               events:
                 type: array
-                description: A list of events
+                description: |-
+                  A list of events, formatted as per the Client-Server API.
                 items:
                   type: object
                   title: Event
@@ -92,7 +69,6 @@ paths:
         200:
           description: The transaction was processed successfully.
           examples:
-            application/json: {
-            }
+            application/json: {}
           schema:
             type: object

specification/application_service_api.rst

@@ -198,6 +198,8 @@ be made without blocking other aspects of the homeserver. Homeservers MUST NOT
 alter (e.g. add more) events they were going to send within that transaction ID
 on retries, as the AS may have already processed the events.
 
+{{transactions_as_http_api}}
+
 Querying
 ++++++++
 
@@ -244,15 +246,6 @@ application service for filtering.
 {{protocols_as_http_api}}
 
 
-HTTP APIs
-+++++++++
-
-This contains application service APIs which are used by the homeserver. All
-application services MUST implement these APIs. These APIs are defined below.
-
-{{application_service_as_http_api}}
-
-
 .. _create the user: `sect:asapi-permissions`_
 
 Client-Server API Extensions