37 lines
1.3 KiB
YAML
37 lines
1.3 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.
|
|
type: object
|
|
title: Protocol Instance
|
|
properties:
|
|
desc:
|
|
type: string
|
|
description: A human-readable description for the protocol, such as the name.
|
|
example: "Freenode"
|
|
icon:
|
|
type: string
|
|
description: |-
|
|
An optional content URI representing the protocol. Overrides the one provided
|
|
at the higher level Protocol object.
|
|
example: "mxc://example.org/JkLmNoPq"
|
|
fields:
|
|
type: object
|
|
description: Preset values for `fields` the client may use to search by.
|
|
example: {
|
|
"network": "freenode"
|
|
}
|
|
network_id:
|
|
type: string
|
|
description: A unique identifier across all instances.
|
|
example: "freenode"
|
|
required: ['desc', 'fields', 'network_id']
|