From 60b8e72a67cb81b868cc74640d35455cd23c8bd1 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 17 Aug 2018 15:44:46 -0600 Subject: [PATCH] Minor text changes to the query APIs; Keep OpenMarket copyright The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header. --- api/application-service/query_room.yaml | 6 +++--- api/application-service/query_user.yaml | 8 ++++---- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/api/application-service/query_room.yaml b/api/application-service/query_room.yaml index e898f103..7a5a7e54 100644 --- a/api/application-service/query_room.yaml +++ b/api/application-service/query_room.yaml @@ -1,3 +1,4 @@ +# Copyright 2016 OpenMarket Ltd # Copyright 2018 New Vector Ltd # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -39,7 +40,7 @@ paths: - in: path name: roomAlias type: string - description: The room alias being queried. + description: The URL encoded room alias being queried. required: true x-example: "#magicforest:example.com" responses: @@ -51,8 +52,7 @@ paths: information about the room such as its name and topic can be set before responding. examples: - application/json: { - } + application/json: {} schema: type: object 401: diff --git a/api/application-service/query_user.yaml b/api/application-service/query_user.yaml index 4f699ad6..4d1e9f44 100644 --- a/api/application-service/query_user.yaml +++ b/api/application-service/query_user.yaml @@ -1,3 +1,4 @@ +# Copyright 2016 OpenMarket Ltd # Copyright 2018 New Vector Ltd # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -33,13 +34,13 @@ paths: the existence of a given user ID. The homeserver will only query user IDs inside the application service's ``users`` namespace. The homeserver will send this request when it receives an event for an unknown user ID in - the application service's namespace. + the application service's namespace, such as a room invite. operationId: queryUserById parameters: - in: path name: userId type: string - description: The user ID being queried. + description: The URL encoded user ID being queried. required: true x-example: "@alice:example.com" responses: @@ -48,8 +49,7 @@ paths: The application service indicates that this user exists. The application service MUST create the user using the client-server API. examples: - application/json: { - } + application/json: {} schema: type: object 401: