From f2d02c9559339f51b7ed0f75d2b408132df7f757 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Wed, 29 Aug 2018 14:37:30 -0600 Subject: [PATCH] Take out device management section for now This will be handled by the implementation of https://github.com/matrix-org/matrix-doc/issues/1212 --- api/server-server/user_devices.yaml | 84 ----------------------------- specification/server_server_api.rst | 12 ----- 2 files changed, 96 deletions(-) delete mode 100644 api/server-server/user_devices.yaml diff --git a/api/server-server/user_devices.yaml b/api/server-server/user_devices.yaml deleted file mode 100644 index d1644270..00000000 --- a/api/server-server/user_devices.yaml +++ /dev/null @@ -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'] \ No newline at end of file diff --git a/specification/server_server_api.rst b/specification/server_server_api.rst index 9a68f33c..558a5f8d 100644 --- a/specification/server_server_api.rst +++ b/specification/server_server_api.rst @@ -891,18 +891,6 @@ nothing else. {{openid_ss_http_api}} -Device Management ------------------ - -.. TODO: TravisR - Incorporate https://github.com/matrix-org/matrix-doc/issues/1212 - -A user's devices may need to be queried over federation for different purposes, such -as end-to-end encryption or for utilizing send-to-device messaging. This section is -intended to compliment the `Device Management module`_ of the Client-Server API. - -{{user_devices_ss_http_api}} - - End-to-End Encryption ---------------------