mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
7d2de48cb4
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr> Co-authored-by: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
45 lines
2 KiB
YAML
45 lines
2 KiB
YAML
# 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.
|
|
allOf:
|
|
- $ref: ../../application-service/definitions/protocol_base.yaml
|
|
- type: object
|
|
properties:
|
|
instances:
|
|
description: |-
|
|
A list of objects representing independent instances of configuration.
|
|
For example, multiple networks on IRC if multiple are provided by the
|
|
same application service.
|
|
|
|
The instances are modified by the homeserver from the response of
|
|
[`GET /_matrix/app/v1/thirdparty/protocol/{protocol}`](/application-service-api/#get_matrixappv1thirdpartyprotocolprotocol)
|
|
to include an `instance_id` to serve as a unique identifier for each
|
|
instance on the homeserver.
|
|
type: array
|
|
items:
|
|
allOf:
|
|
- $ref: ../../application-service/definitions/protocol_instance.yaml
|
|
- type: object
|
|
properties:
|
|
instance_id:
|
|
type: string
|
|
description: |-
|
|
A unique identifier for this instance on the homeserver. This field is added
|
|
to the response of [`GET /_matrix/app/v1/thirdparty/protocol/{protocol}`](/application-service-api/#get_matrixappv1thirdpartyprotocolprotocol)
|
|
by the homeserver.
|
|
|
|
This is the identifier to use as the `third_party_instance_id` in a request to
|
|
[`POST /_matrix/client/v3/publicRooms`](/client-server-api/#post_matrixclientv3publicrooms).
|
|
example: "irc-freenode"
|
|
required: ['instances']
|