Take out device management section for now
This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212pull/977/head
parent
8950f0b2cc
commit
f2d02c9559
@ -1,84 +0,0 @@
|
||||
# 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.
|
||||
|
||||
swagger: '2.0'
|
||||
info:
|
||||
title: "Matrix Federation User Device Management API"
|
||||
version: "1.0.0"
|
||||
host: localhost:8448
|
||||
schemes:
|
||||
- https
|
||||
basePath: /_matrix/federation/v1
|
||||
consumes:
|
||||
- application/json
|
||||
produces:
|
||||
- application/json
|
||||
securityDefinitions:
|
||||
$ref: definitions/security.yaml
|
||||
paths:
|
||||
"/user/devices/{userId}":
|
||||
get:
|
||||
summary: Gets all of the user's devices
|
||||
description: Gets information on all of the user's devices
|
||||
operationId: getUserDevices
|
||||
security:
|
||||
- signedRequest: []
|
||||
parameters:
|
||||
- in: path
|
||||
name: userId
|
||||
type: string
|
||||
required: true
|
||||
description: |-
|
||||
The user ID to retrieve devices for. Must be a user local to the
|
||||
receiving homeserver.
|
||||
required: true
|
||||
x-example: "@alice:example.org"
|
||||
responses:
|
||||
200:
|
||||
description: The user's devices.
|
||||
schema:
|
||||
type: object
|
||||
properties:
|
||||
user_id:
|
||||
type: string
|
||||
description: The user ID devices were requested for.
|
||||
example: "@alice:example.org"
|
||||
stream_id:
|
||||
type: integer
|
||||
description: |-
|
||||
An ID the requesting homeserver may use to detect changes in the
|
||||
device list. This should increase as time goes on, and always
|
||||
produce the same ``devices`` list if not incremented.
|
||||
example: 334608
|
||||
devices:
|
||||
type: array
|
||||
description: The user's devices. May be empty.
|
||||
items:
|
||||
type: object
|
||||
title: User Device
|
||||
properties:
|
||||
device_id:
|
||||
type: string
|
||||
description: The device ID.
|
||||
example: "JLAFKJWSCS"
|
||||
keys:
|
||||
type: object
|
||||
description: Identity keys for the device.
|
||||
$ref: "../client-server/definitions/device_keys.yaml"
|
||||
device_display_name:
|
||||
type: string
|
||||
description: Optional display name for the device.
|
||||
example: "Alice's Mobile Phone"
|
||||
required: ['device_id', 'keys']
|
||||
required: ['user_id', 'stream_id', 'devices']
|
Loading…
Reference in New Issue