Historical note: this was originally a series of several commits, spread out over several weeks. They have been squashed together to make `git annotate` work properly. The original commits were: * 91ab3934 <Will> 2021-01-25 21:16:42 -0800 Add raw API end event schemas into /data directory * aae22f47 <Will> 2021-01-25 21:33:06 -0800 Remove non-data files * 1092d4ca <Will> 2021-01-26 20:41:33 -0800 Add data-compatiuble extension (.yaml) to all data files that currently omit one * 21060109 <Will> 2021-01-26 20:57:28 -0800 Remove symlink to event-schemas, and update openAPI schema paths accordingly * 4f633845 <Travis Ralston> 2021-04-12 21:54:54 -0600 Fix event schema examples too * 301c7b2f <Will> 2021-02-05 10:15:42 -0800 Restore docs describing OpenAPI extensions that we use
44 lines
1.4 KiB
YAML
44 lines
1.4 KiB
YAML
# Copyright 2016 OpenMarket 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.
|
|
|
|
type: object
|
|
description: A client device
|
|
title: Device
|
|
properties:
|
|
device_id:
|
|
type: string
|
|
description: Identifier of this device.
|
|
example: QBUAZIFURK
|
|
display_name:
|
|
type: string
|
|
description: |-
|
|
Display name set by the user for this device. Absent if no name has been
|
|
set.
|
|
example: android
|
|
last_seen_ip:
|
|
type: string
|
|
description: |-
|
|
The IP address where this device was last seen. (May be a few minutes out
|
|
of date, for efficiency reasons).
|
|
example: 1.2.3.4
|
|
last_seen_ts:
|
|
type: integer
|
|
format: int64
|
|
description: |-
|
|
The timestamp (in milliseconds since the unix epoch) when this devices
|
|
was last seen. (May be a few minutes out of date, for efficiency
|
|
reasons).
|
|
example: 1474491775024
|
|
required:
|
|
- device_id
|