Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-02-17 03:23:42 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Minor text changes to the query APIs; Keep OpenMarket copyright

Browse source 
The bulk of these APIs were copied from OpenMarket's work - we should preserve the copyright header.
This commit is contained in:
Travis Ralston 2018-08-17 15:44:46 -06:00
parent 0863c5452e
commit 60b8e72a67
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
api/application-service/query_room.yaml
View file

@ -1,3 +1,4 @@
# Copyright 2016 OpenMarket Ltd
# Copyright 2018 New Vector Ltd # Copyright 2018 New Vector Ltd
# #
# Licensed under the Apache License, Version 2.0 (the "License"); # Licensed under the Apache License, Version 2.0 (the "License");
@ -39,7 +40,7 @@ paths:
- in: path - in: path
name: roomAlias name: roomAlias
type: string type: string
description: The room alias being queried. description: The URL encoded room alias being queried.
required: true required: true
x-example: "#magicforest:example.com" x-example: "#magicforest:example.com"
responses: responses:
@ -51,8 +52,7 @@ paths:
information about the room such as its name and topic can be set information about the room such as its name and topic can be set
before responding. before responding.
examples: examples:
application/json: { application/json: {}
}
schema: schema:
type: object type: object
401: 401:

8
api/application-service/query_user.yaml
View file

@ -1,3 +1,4 @@
# Copyright 2016 OpenMarket Ltd
# Copyright 2018 New Vector Ltd # Copyright 2018 New Vector Ltd
# #
# Licensed under the Apache License, Version 2.0 (the "License"); # 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 the existence of a given user ID. The homeserver will only query user IDs
inside the application service's ``users`` namespace. The homeserver will inside the application service's ``users`` namespace. The homeserver will
send this request when it receives an event for an unknown user ID in 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 operationId: queryUserById
parameters: parameters:
- in: path - in: path
name: userId name: userId
type: string type: string
description: The user ID being queried. description: The URL encoded user ID being queried.
required: true required: true
x-example: "@alice:example.com" x-example: "@alice:example.com"
responses: responses:
@ -48,8 +49,7 @@ paths:
The application service indicates that this user exists. The application The application service indicates that this user exists. The application
service MUST create the user using the client-server API. service MUST create the user using the client-server API.
examples: examples:
application/json: { application/json: {}
}
schema: schema:
type: object type: object
401: 401: