protocol/json/gregor1/incoming.json - master - githubmirror/client

protocol/json/gregor1/incoming.json
202 строки4 KB
Joshua Blum
Drop compression on ping calls (#14955)
06 дек 2018, 19:08
06 дек 2018, 19:086755f5a
{
  "protocol": "incoming",
  "imports": [],
  "types": [
    {
      "type": "record",
      "name": "SyncResult",
      "fields": [
        {
          "type": {
            "type": "array",
            "items": "InBandMessage"
          },
          "name": "msgs"
        },
        {
          "type": "bytes",
          "name": "hash"
        }
      ]
    },
    {
      "type": "record",
      "name": "ConnectedDevice",
      "fields": [
        {
          "type": "DeviceID",
          "name": "deviceID"
        },
        {
          "type": "string",
          "name": "deviceType"
        },
        {
          "type": "string",
          "name": "devicePlatform"
        },
        {
          "type": "string",
          "name": "userAgent"
        }
      ],
      "doc": "DescribeConnectedUsers will take a list of users, and return the list of users\n    which are connected to any Gregor in the cluster, and what devices (and device type)\n    those users are connected with."
    },
    {
      "type": "record",
      "name": "ConnectedUser",
      "fields": [
        {
          "type": "UID",
          "name": "uid"
        },
        {
          "type": {
            "type": "array",
            "items": "ConnectedDevice"
          },
          "name": "devices"
        }
      ]
    }
  ],
  "messages": {
    "sync": {
      "request": [
        {
          "name": "uid",
          "type": "UID"
        },
        {
          "name": "deviceid",
          "type": "DeviceID"
        },
        {
          "name": "ctime",
          "type": "Time"
        }
      ],
      "response": "SyncResult"
    },
    "consumeMessage": {
      "request": [
        {
          "name": "m",
          "type": "Message"
        }
      ],
      "response": null
    },
    "consumePublishMessage": {
      "request": [
        {
          "name": "m",
          "type": "Message"
        }
      ],
      "response": null
    },
    "consumeMessageMulti": {
      "request": [
        {
          "name": "msg",
          "type": "Message"
        },
        {
          "name": "uids",
          "type": {
            "type": "array",
            "items": "UID"
          }
        }
      ],
      "response": null,
      "doc": "consumeMessageMulti will take msg and consume it for all the users listed\n    in uids. This is so a gregor client can send the same message to many UIDs\n    with one call, as opposed to calling consumeMessage for each UID."
    },
    "ping": {
      "request": [],
      "response": "string",
      "compression_type": "none"
    },
    "version": {
      "request": [
        {
          "name": "uid",
          "type": "UID"
        }
      ],
      "response": "string"
    },
    "state": {
      "request": [
        {
          "name": "uid",
          "type": "UID"
        },
        {
          "name": "deviceid",
          "type": "DeviceID"
        },
        {
          "name": "timeOrOffset",
          "type": "TimeOrOffset"
        }
      ],
      "response": "State"
    },
    "stateByCategoryPrefix": {
      "request": [
        {
          "name": "uid",
          "type": "UID"
        },
        {
          "name": "deviceid",
          "type": "DeviceID"
        },
        {
          "name": "timeOrOffset",
          "type": "TimeOrOffset"
        },
        {
          "name": "categoryPrefix",
          "type": "Category"
        }
      ],
      "response": "State",
      "doc": "StateByCategoryPrefix loads the messages of the user's state whose\n    categories are prefixed by the given prefix"
    },
    "describeConnectedUsers": {
      "request": [
        {
          "name": "uids",
          "type": {
            "type": "array",
            "items": "UID"
          }
        }
      ],
      "response": {
        "type": "array",
        "items": "ConnectedUser"
      }
    },
    "describeConnectedUsersInternal": {
      "request": [
        {
          "name": "uids",
          "type": {
            "type": "array",
            "items": "UID"
          }
        }
      ],
      "response": {
        "type": "array",
        "items": "ConnectedUser"
      }
    }
  },
  "namespace": "gregor.1",
  "compression_type": "gzip"
}