Merge branch 'master' into travis/better-errors
This commit is contained in:
commit
55c27d6212
7 changed files with 52 additions and 27 deletions
|
@ -100,6 +100,7 @@ paths:
|
|||
name: allow_remote
|
||||
x-example: false
|
||||
required: false
|
||||
default: true
|
||||
description: |
|
||||
Indicates to the server that it should not attempt to fetch the media if it is deemed
|
||||
remote. This is to prevent routing loops where the server contacts itself. Defaults to
|
||||
|
@ -154,6 +155,7 @@ paths:
|
|||
name: allow_remote
|
||||
x-example: false
|
||||
required: false
|
||||
default: true
|
||||
description: |
|
||||
Indicates to the server that it should not attempt to fetch the media if it is deemed
|
||||
remote. This is to prevent routing loops where the server contacts itself. Defaults to
|
||||
|
@ -221,6 +223,7 @@ paths:
|
|||
name: allow_remote
|
||||
x-example: false
|
||||
required: false
|
||||
default: true
|
||||
description: |
|
||||
Indicates to the server that it should not attempt to fetch the media if it is deemed
|
||||
remote. This is to prevent routing loops where the server contacts itself. Defaults to
|
||||
|
|
|
@ -78,8 +78,8 @@ paths:
|
|||
for this room. If all users on a homeserver forget a room, the room is
|
||||
eligible for deletion from that homeserver.
|
||||
|
||||
If the user is currently joined to the room, they will implicitly leave
|
||||
the room as part of this API call.
|
||||
If the user is currently joined to the room, they must leave the room
|
||||
before calling this API.
|
||||
operationId: forgetRoom
|
||||
security:
|
||||
- accessToken: []
|
||||
|
@ -99,6 +99,15 @@ paths:
|
|||
}
|
||||
schema:
|
||||
type: object
|
||||
400:
|
||||
description: The user has not left the room
|
||||
examples:
|
||||
application/json: {
|
||||
"errcode": "M_UNKNOWN",
|
||||
"error": "User @example:matrix.org is in room !au1ba7o:matrix.org"
|
||||
}
|
||||
schema:
|
||||
"$ref": "definitions/error.yaml"
|
||||
429:
|
||||
description: This request was rate-limited.
|
||||
schema:
|
||||
|
|
|
@ -107,6 +107,7 @@ paths:
|
|||
items:
|
||||
type: object
|
||||
title: RoomEvent
|
||||
"$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
|
||||
examples:
|
||||
application/json: {
|
||||
"start": "t47429-4392820_219380_26003_2265",
|
||||
|
|
|
@ -74,7 +74,7 @@ paths:
|
|||
properties:
|
||||
room_events:
|
||||
type: object
|
||||
title: "Room Events"
|
||||
title: Room Events Criteria
|
||||
description: Mapping of category name to search criteria.
|
||||
properties:
|
||||
search_term:
|
||||
|
@ -103,7 +103,7 @@ paths:
|
|||
The order in which to search for results.
|
||||
By default, this is ``"rank"``.
|
||||
event_context:
|
||||
title: "Event Context"
|
||||
title: Include Event Context
|
||||
type: object
|
||||
description: |-
|
||||
Configures whether any context for the events
|
||||
|
@ -169,13 +169,13 @@ paths:
|
|||
properties:
|
||||
search_categories:
|
||||
type: object
|
||||
title: Categories
|
||||
title: Result Categories
|
||||
description: Describes which categories to search in and
|
||||
their criteria.
|
||||
properties:
|
||||
room_events:
|
||||
type: object
|
||||
title: Room Event Results
|
||||
title: Result Room Events
|
||||
description: Mapping of category name to search criteria.
|
||||
properties:
|
||||
count:
|
||||
|
|
|
@ -15,6 +15,22 @@ Unreleased changes
|
|||
- Sticker messages:
|
||||
- Add sticker message event definition.
|
||||
(`#1158 <https://github.com/matrix-org/matrix-doc/pull/1158>`_).
|
||||
- Add 'token' parameter to /keys/query endpoint
|
||||
(`#1104 <https://github.com/matrix-org/matrix-doc/pull/1104>`_).
|
||||
- Add the room visibility options for the room directory
|
||||
(`#1141 <https://github.com/matrix-org/matrix-doc/pull/1141>`_).
|
||||
- Add spec for ignoring users
|
||||
(`#1142 <https://github.com/matrix-org/matrix-doc/pull/1142>`_).
|
||||
- Add the ``/register/available`` endpoint for username availability
|
||||
(`#1151 <https://github.com/matrix-org/matrix-doc/pull/1151>`_).
|
||||
- Add ``allow_remote`` to the content repo to avoid routing loops
|
||||
(`#1265 <https://github.com/matrix-org/matrix-doc/pull/1265>`_).
|
||||
- Add report content API
|
||||
(`#1264 <https://github.com/matrix-org/matrix-doc/pull/1264>`_).
|
||||
- Document ``/logout/all`` endpoint
|
||||
(`#1263 <https://github.com/matrix-org/matrix-doc/pull/1263>`_).
|
||||
- Document `highlights` field in /search response
|
||||
(`#1274 <https://github.com/matrix-org/matrix-doc/pull/1274>`_).
|
||||
- Document the GET version of ``/login``
|
||||
(`#1361 <https://github.com/matrix-org/matrix-doc/pull/1361>`_).
|
||||
|
||||
|
@ -39,30 +55,17 @@ Unreleased changes
|
|||
(`#1152 <https://github.com/matrix-org/matrix-doc/pull/1152>`_).
|
||||
- Mark ``GET /rooms/{roomId}/members`` as requiring authentication
|
||||
(`#1245 <https://github.com/matrix-org/matrix-doc/pull/1244>`_).
|
||||
- Define what a ``RoomEvent`` is on ``/rooms/{roomId}/messages``
|
||||
(`#1380 <https://github.com/matrix-org/matrix-doc/pull/1380>`_).
|
||||
- Describe ``StateEvent`` for ``/createRoom``
|
||||
(`#1329 <https://github.com/matrix-org/matrix-doc/pull/1329>`_).
|
||||
- Clarify that clients must leave rooms before forgetting them
|
||||
(`#1378 <https://github.com/matrix-org/matrix-doc/pull/1378>`_).
|
||||
- Clarify the request and result types on ``/search``
|
||||
(`#1381 <https://github.com/matrix-org/matrix-doc/pull/1381>`_).
|
||||
- Describe the rate limit error response schema
|
||||
(`#1373 <https://github.com/matrix-org/matrix-doc/pull/1373>`_).
|
||||
|
||||
- Changes to the API which will be backwards-compatible for clients:
|
||||
|
||||
- Add 'token' parameter to /keys/query endpoint
|
||||
(`#1104 <https://github.com/matrix-org/matrix-doc/pull/1104>`_).
|
||||
- Add the room visibility options for the room directory
|
||||
(`#1141 <https://github.com/matrix-org/matrix-doc/pull/1141>`_).
|
||||
- Add spec for ignoring users
|
||||
(`#1142 <https://github.com/matrix-org/matrix-doc/pull/1142>`_).
|
||||
- Add the ``/register/available`` endpoint for username availability
|
||||
(`#1151 <https://github.com/matrix-org/matrix-doc/pull/1151>`_).
|
||||
- Add ``allow_remote`` to the content repo to avoid routing loops
|
||||
(`#1265 <https://github.com/matrix-org/matrix-doc/pull/1265>`_).
|
||||
- Add report content API
|
||||
(`#1264 <https://github.com/matrix-org/matrix-doc/pull/1264>`_).
|
||||
- Document ``/logout/all`` endpoint
|
||||
(`#1263 <https://github.com/matrix-org/matrix-doc/pull/1263>`_).
|
||||
- Document `highlights` field in /search response
|
||||
(`#1274 <https://github.com/matrix-org/matrix-doc/pull/1274>`_).
|
||||
|
||||
r0.3.0
|
||||
======
|
||||
|
||||
|
|
|
@ -701,8 +701,8 @@ func ignoreExitCodeOne(err error) error {
|
|||
|
||||
func main() {
|
||||
flag.Parse()
|
||||
// It would be great to read this from github, but there's no convenient way to do so.
|
||||
// Most of these memberships are "private", so would require some kind of auth.
|
||||
// It would be great to read this from github
|
||||
// cf https://github.com/matrix-org/matrix-doc/issues/1384
|
||||
allowedMembers = map[string]bool{
|
||||
"dbkr": true,
|
||||
"erikjohnston": true,
|
||||
|
@ -715,6 +715,11 @@ func main() {
|
|||
"rxl881": true,
|
||||
"uhoreg": true,
|
||||
"turt2live": true,
|
||||
"Half-Shot": true,
|
||||
"anoadragon453": true,
|
||||
"mujx": true,
|
||||
"benparsons": true,
|
||||
"KitsuneRal": true,
|
||||
}
|
||||
if err := initCache(); err != nil {
|
||||
log.Fatal(err)
|
||||
|
|
|
@ -16,6 +16,10 @@
|
|||
Federation API
|
||||
==============
|
||||
|
||||
.. WARNING::
|
||||
This API is unstable and will change without warning or discussion while
|
||||
we work towards a r0 release (scheduled for August 2018).
|
||||
|
||||
Matrix homeservers use the Federation APIs (also known as server-server APIs)
|
||||
to communicate with each other. Homeservers use these APIs to push messages to
|
||||
each other in real-time, to
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue