Third party lookup module. Fix wording
This commit is contained in:
parent
8999887245
commit
291a4dfc76
12 changed files with 34 additions and 42 deletions
|
@ -226,7 +226,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: The protocol was found and metadata returned.
|
description: The protocol was found and metadata returned.
|
||||||
schema:
|
schema:
|
||||||
$ref: definitions/schema/protocol_metadata.yaml
|
$ref: definitions/protocol_metadata.yaml
|
||||||
401:
|
401:
|
||||||
description: |-
|
description: |-
|
||||||
The homeserver has not supplied credentials to the application service.
|
The homeserver has not supplied credentials to the application service.
|
||||||
|
@ -279,7 +279,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: The Matrix User IDs found with the given parameters.
|
description: The Matrix User IDs found with the given parameters.
|
||||||
schema:
|
schema:
|
||||||
$ref: definitions/schema/user_batch.yaml
|
$ref: definitions/user_batch.yaml
|
||||||
401:
|
401:
|
||||||
description: |-
|
description: |-
|
||||||
The homeserver has not supplied credentials to the application service.
|
The homeserver has not supplied credentials to the application service.
|
||||||
|
@ -330,7 +330,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: At least one portal room was found.
|
description: At least one portal room was found.
|
||||||
schema:
|
schema:
|
||||||
$ref: definitions/schema/location_batch.yaml
|
$ref: definitions/location_batch.yaml
|
||||||
401:
|
401:
|
||||||
description: |-
|
description: |-
|
||||||
The homeserver has not supplied credentials to the application service.
|
The homeserver has not supplied credentials to the application service.
|
||||||
|
@ -375,7 +375,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
All found third party locations.
|
All found third party locations.
|
||||||
schema:
|
schema:
|
||||||
$ref: definitions/schema/location_batch.yaml
|
$ref: definitions/location_batch.yaml
|
||||||
401:
|
401:
|
||||||
description: |-
|
description: |-
|
||||||
The homeserver has not supplied credentials to the application service.
|
The homeserver has not supplied credentials to the application service.
|
||||||
|
@ -419,7 +419,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
An array of third party users.
|
An array of third party users.
|
||||||
schema:
|
schema:
|
||||||
$ref: definitions/schema/user_batch.yaml
|
$ref: definitions/user_batch.yaml
|
||||||
401:
|
401:
|
||||||
description: |-
|
description: |-
|
||||||
The homeserver has not supplied credentials to the application service.
|
The homeserver has not supplied credentials to the application service.
|
||||||
|
|
|
@ -39,7 +39,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: The protocols supported by the homeserver.
|
description: The protocols supported by the homeserver.
|
||||||
schema:
|
schema:
|
||||||
$ref: ../application-service/definitions/schema/protocol_metadata.yaml
|
$ref: ../application-service/definitions/protocol_metadata.yaml
|
||||||
"/thirdparty/protocol/{protocol}":
|
"/thirdparty/protocol/{protocol}":
|
||||||
get:
|
get:
|
||||||
summary: Retrieve metadata about a specific protocol that the homeserver supports.
|
summary: Retrieve metadata about a specific protocol that the homeserver supports.
|
||||||
|
@ -58,7 +58,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: The protocol was found and metadata returned.
|
description: The protocol was found and metadata returned.
|
||||||
schema:
|
schema:
|
||||||
$ref: ../application-service/definitions/schema/protocol.yaml
|
$ref: ../application-service/definitions/protocol.yaml
|
||||||
404:
|
404:
|
||||||
description: The protocol is unknown.
|
description: The protocol is unknown.
|
||||||
examples:
|
examples:
|
||||||
|
@ -97,7 +97,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: At least one portal room was found.
|
description: At least one portal room was found.
|
||||||
schema:
|
schema:
|
||||||
$ref: ../application-service/definitions/schema/location_batch.yaml
|
$ref: ../application-service/definitions/location_batch.yaml
|
||||||
404:
|
404:
|
||||||
description: No portal rooms were found.
|
description: No portal rooms were found.
|
||||||
examples:
|
examples:
|
||||||
|
@ -130,7 +130,7 @@ paths:
|
||||||
200:
|
200:
|
||||||
description: The Matrix User IDs found with the given parameters.
|
description: The Matrix User IDs found with the given parameters.
|
||||||
schema:
|
schema:
|
||||||
$ref: ../application-service/definitions/schema/user_batch.yaml
|
$ref: ../application-service/definitions/user_batch.yaml
|
||||||
404:
|
404:
|
||||||
description: The Matrix User ID was not found
|
description: The Matrix User ID was not found
|
||||||
examples:
|
examples:
|
||||||
|
@ -157,7 +157,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
All found third party locations.
|
All found third party locations.
|
||||||
schema:
|
schema:
|
||||||
$ref: ../application-service/definitions/schema/location_batch.yaml
|
$ref: ../application-service/definitions/location_batch.yaml
|
||||||
404:
|
404:
|
||||||
description: The Matrix room alias was not found
|
description: The Matrix room alias was not found
|
||||||
examples:
|
examples:
|
||||||
|
@ -183,7 +183,7 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
An array of third party users.
|
An array of third party users.
|
||||||
schema:
|
schema:
|
||||||
$ref: ../application-service/definitions/schema/user_batch.yaml
|
$ref: ../application-service/definitions/user_batch.yaml
|
||||||
404:
|
404:
|
||||||
description: The Matrix User ID was not found
|
description: The Matrix User ID was not found
|
||||||
examples:
|
examples:
|
||||||
|
|
|
@ -42,7 +42,7 @@ Summary
|
||||||
`Server Side Search`_ Optional Optional Optional Optional Optional
|
`Server Side Search`_ Optional Optional Optional Optional Optional
|
||||||
`Server Administration`_ Optional Optional Optional Optional Optional
|
`Server Administration`_ Optional Optional Optional Optional Optional
|
||||||
`Event Context`_ Optional Optional Optional Optional Optional
|
`Event Context`_ Optional Optional Optional Optional Optional
|
||||||
`Application Services`_ Optional Optional Optional Optional Optional
|
`Third Party Networks`_ Optional Optional Optional Optional Optional
|
||||||
===================================== ========== ========== ========== ========== ==========
|
===================================== ========== ========== ========== ========== ==========
|
||||||
|
|
||||||
*Please see each module for more details on what clients need to implement.*
|
*Please see each module for more details on what clients need to implement.*
|
||||||
|
@ -58,7 +58,7 @@ Summary
|
||||||
.. _Server Side Search: `module:search`_
|
.. _Server Side Search: `module:search`_
|
||||||
.. _Server Administration: `module:admin`_
|
.. _Server Administration: `module:admin`_
|
||||||
.. _Event Context: `module:event-context`_
|
.. _Event Context: `module:event-context`_
|
||||||
.. _Application Services: `module:application-services`_
|
.. _Third Party Networks: `module:third-party-networks`_
|
||||||
|
|
||||||
Clients
|
Clients
|
||||||
-------
|
-------
|
||||||
|
|
|
@ -1,28 +0,0 @@
|
||||||
Application Services
|
|
||||||
====================
|
|
||||||
|
|
||||||
.. _module:application-services:
|
|
||||||
|
|
||||||
An application service is a separate program that interacts with a homeserver
|
|
||||||
and provides various bits of functionality that would otherwise not make
|
|
||||||
sense to include directly in the homeserver. This ranges from bots, which can
|
|
||||||
often be interacted with, to bridges, which allow Matrix users to communicate
|
|
||||||
with users on third party networks. The following describes endpoints that a
|
|
||||||
Matrix client can use to interact with an application service through the
|
|
||||||
facilitation of the homeserver.
|
|
||||||
|
|
||||||
Third Party Lookups
|
|
||||||
-------------------
|
|
||||||
|
|
||||||
Application services can provide access to third party networks via bridging.
|
|
||||||
This allows Matrix users to communicate with users on other communication
|
|
||||||
platforms, with messages ferried back and forth by the application service. A
|
|
||||||
single application service may bridge multiple third party networks, and many
|
|
||||||
individual locations within those networks. A single third party network
|
|
||||||
location may be bridged to multiple Matrix rooms.
|
|
||||||
|
|
||||||
In order for a client to join one of these bridged rooms, or communicate
|
|
||||||
directly with a user on a third party network, the following endpoints can be
|
|
||||||
used.
|
|
||||||
|
|
||||||
{{third_party_lookup_cs_http_api}}
|
|
20
specification/modules/third_party_networks.rst
Normal file
20
specification/modules/third_party_networks.rst
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
Third Party Networks
|
||||||
|
====================
|
||||||
|
|
||||||
|
.. _module:third-party-networks:
|
||||||
|
|
||||||
|
Application services can provide access to third party networks via bridging.
|
||||||
|
This allows Matrix users to communicate with users on other communication
|
||||||
|
platforms, with messages ferried back and forth by the application service. A
|
||||||
|
single application service may bridge multiple third party networks, and many
|
||||||
|
individual locations within those networks. A single third party network
|
||||||
|
location may be bridged to multiple Matrix rooms.
|
||||||
|
|
||||||
|
Third Party Lookups
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
A client may wish to provide a rich interface for joining third party
|
||||||
|
locations and connecting with third party users. Information necessary for
|
||||||
|
such an interface is provided by third party lookups.
|
||||||
|
|
||||||
|
{{third_party_lookup_cs_http_api}}
|
|
@ -68,7 +68,7 @@ groups: # reusable blobs of files when prefixed with 'group:'
|
||||||
- modules/ignore_users.rst
|
- modules/ignore_users.rst
|
||||||
- modules/stickers.rst
|
- modules/stickers.rst
|
||||||
- modules/report_content.rst
|
- modules/report_content.rst
|
||||||
- modules/application_services.rst
|
- modules/third_party_networks.rst
|
||||||
|
|
||||||
|
|
||||||
title_styles: ["=", "-", "~", "+", "^", "`", "@", ":"]
|
title_styles: ["=", "-", "~", "+", "^", "`", "@", ":"]
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue