Deduplicate Invite3pid
(#2074)
* Deduplicate Invite3pid Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
parent
02a1aeefbc
commit
1916e53f8c
4 changed files with 48 additions and 57 deletions
1
changelogs/internal/newsfragments/2074.clarification
Normal file
1
changelogs/internal/newsfragments/2074.clarification
Normal file
|
@ -0,0 +1 @@
|
||||||
|
Deduplicate the definitions of `Invite3pid`.
|
|
@ -131,32 +131,7 @@ paths:
|
||||||
A list of objects representing third-party IDs to invite into
|
A list of objects representing third-party IDs to invite into
|
||||||
the room.
|
the room.
|
||||||
items:
|
items:
|
||||||
type: object
|
$ref: definitions/invite_3pid.yaml
|
||||||
title: Invite3pid
|
|
||||||
properties:
|
|
||||||
id_server:
|
|
||||||
type: string
|
|
||||||
description: The hostname+port of the identity server which should be used for
|
|
||||||
third-party identifier lookups.
|
|
||||||
id_access_token:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
An access token previously registered with the identity server. Servers
|
|
||||||
can treat this as optional to distinguish between r0.5-compatible clients
|
|
||||||
and this specification version.
|
|
||||||
medium:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
The kind of address being passed in the address field, for example `email`
|
|
||||||
(see [the list of recognised values](/appendices/#3pid-types)).
|
|
||||||
address:
|
|
||||||
type: string
|
|
||||||
description: The invitee's third-party identifier.
|
|
||||||
required:
|
|
||||||
- id_server
|
|
||||||
- id_access_token
|
|
||||||
- medium
|
|
||||||
- address
|
|
||||||
room_version:
|
room_version:
|
||||||
type: string
|
type: string
|
||||||
description: |-
|
description: |-
|
||||||
|
|
45
data/api/client-server/definitions/invite_3pid.yaml
Normal file
45
data/api/client-server/definitions/invite_3pid.yaml
Normal file
|
@ -0,0 +1,45 @@
|
||||||
|
# Copyright 2025 The Matrix.org Foundation C.I.C.
|
||||||
|
#
|
||||||
|
# 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: Invite3pid
|
||||||
|
properties:
|
||||||
|
id_server:
|
||||||
|
type: string
|
||||||
|
description: The hostname+port of the identity server which should be used for
|
||||||
|
third-party identifier lookups.
|
||||||
|
id_access_token:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
An access token previously registered with the identity server. Servers
|
||||||
|
can treat this as optional to distinguish between r0.5-compatible clients
|
||||||
|
and this specification version.
|
||||||
|
medium:
|
||||||
|
type: string
|
||||||
|
description: |-
|
||||||
|
The kind of address being passed in the address field, for example `email`
|
||||||
|
(see [the list of recognised values](/appendices/#3pid-types)).
|
||||||
|
address:
|
||||||
|
type: string
|
||||||
|
description: The invitee's third-party identifier.
|
||||||
|
required:
|
||||||
|
- id_server
|
||||||
|
- id_access_token
|
||||||
|
- medium
|
||||||
|
- address
|
||||||
|
example: {
|
||||||
|
"id_server": "matrix.org",
|
||||||
|
"id_access_token": "abc123_OpaqueString",
|
||||||
|
"medium": "email",
|
||||||
|
"address": "cheeky@monkey.com"
|
||||||
|
}
|
|
@ -76,37 +76,7 @@ paths:
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
type: object
|
$ref: definitions/invite_3pid.yaml
|
||||||
example: {
|
|
||||||
"id_server": "matrix.org",
|
|
||||||
"id_access_token": "abc123_OpaqueString",
|
|
||||||
"medium": "email",
|
|
||||||
"address": "cheeky@monkey.com"
|
|
||||||
}
|
|
||||||
properties:
|
|
||||||
id_server:
|
|
||||||
type: string
|
|
||||||
description: The hostname+port of the identity server which should be used for
|
|
||||||
third-party identifier lookups.
|
|
||||||
id_access_token:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
An access token previously registered with the identity server. Servers
|
|
||||||
can treat this as optional to distinguish between r0.5-compatible clients
|
|
||||||
and this specification version.
|
|
||||||
medium:
|
|
||||||
type: string
|
|
||||||
description: |-
|
|
||||||
The kind of address being passed in the address field, for example
|
|
||||||
`email` (see [the list of recognised values](/appendices/#3pid-types)).
|
|
||||||
address:
|
|
||||||
type: string
|
|
||||||
description: The invitee's third-party identifier.
|
|
||||||
required:
|
|
||||||
- id_server
|
|
||||||
- id_access_token
|
|
||||||
- medium
|
|
||||||
- address
|
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue