data/api/client-server/definitions/protocol.yaml - main - Undeadguy/matrix-spec

data/api/client-server/definitions/protocol.yaml

44 строки2 KB

Kévin Commaille

Fix new redocly lints (#2182)

29 июл 2025, 20:22

29 июл 2025, 20:227d2de48

# 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']