matrix-spec/api/server-server/definitions/edu.yaml

# Copyright 2018 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

# TODO: Address any concerns about this being inaccurate (flagged as such in the EDUs section)

type: object
title: Ephemeral Data Unit
description: An ephemeral data unit
example:
  $ref: "../examples/edu.json"
properties:
  edu_type:
    type: string
    description: The type of ephemeral message.
    example: "m.presence"
  origin:
    type: string
    description: The server name sending the ephemeral message.
    example: "matrix.org"    
  destination:
    type: string
    description: The server name receiving the ephemeral message.
    example: "elsewhere.com"
  content:
    type: object
    description: The content of the ephemeral message.