Merge branch 'master' into travis/server-name-join
This commit is contained in:
commit
4485b2f025
9 changed files with 91 additions and 34 deletions
|
@ -100,6 +100,7 @@ paths:
|
||||||
name: allow_remote
|
name: allow_remote
|
||||||
x-example: false
|
x-example: false
|
||||||
required: false
|
required: false
|
||||||
|
default: true
|
||||||
description: |
|
description: |
|
||||||
Indicates to the server that it should not attempt to fetch the media if it is deemed
|
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
|
remote. This is to prevent routing loops where the server contacts itself. Defaults to
|
||||||
|
@ -154,6 +155,7 @@ paths:
|
||||||
name: allow_remote
|
name: allow_remote
|
||||||
x-example: false
|
x-example: false
|
||||||
required: false
|
required: false
|
||||||
|
default: true
|
||||||
description: |
|
description: |
|
||||||
Indicates to the server that it should not attempt to fetch the media if it is deemed
|
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
|
remote. This is to prevent routing loops where the server contacts itself. Defaults to
|
||||||
|
@ -221,6 +223,7 @@ paths:
|
||||||
name: allow_remote
|
name: allow_remote
|
||||||
x-example: false
|
x-example: false
|
||||||
required: false
|
required: false
|
||||||
|
default: true
|
||||||
description: |
|
description: |
|
||||||
Indicates to the server that it should not attempt to fetch the media if it is deemed
|
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
|
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
|
for this room. If all users on a homeserver forget a room, the room is
|
||||||
eligible for deletion from that homeserver.
|
eligible for deletion from that homeserver.
|
||||||
|
|
||||||
If the user is currently joined to the room, they will implicitly leave
|
If the user is currently joined to the room, they must leave the room
|
||||||
the room as part of this API call.
|
before calling this API.
|
||||||
operationId: forgetRoom
|
operationId: forgetRoom
|
||||||
security:
|
security:
|
||||||
- accessToken: []
|
- accessToken: []
|
||||||
|
@ -99,6 +99,15 @@ paths:
|
||||||
}
|
}
|
||||||
schema:
|
schema:
|
||||||
type: object
|
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:
|
429:
|
||||||
description: This request was rate-limited.
|
description: This request was rate-limited.
|
||||||
schema:
|
schema:
|
||||||
|
|
|
@ -28,6 +28,42 @@ securityDefinitions:
|
||||||
$ref: definitions/security.yaml
|
$ref: definitions/security.yaml
|
||||||
paths:
|
paths:
|
||||||
"/login":
|
"/login":
|
||||||
|
get:
|
||||||
|
summary: Get the supported login types to authenticate users
|
||||||
|
description: |-
|
||||||
|
Gets the homeserver's supported login types to authenticate users. Clients
|
||||||
|
should pick one of these and supply it as the ``type`` when logging in.
|
||||||
|
operationId: getLoginFlows
|
||||||
|
responses:
|
||||||
|
200:
|
||||||
|
description: The login types the homeserver supports
|
||||||
|
examples:
|
||||||
|
application/json: {
|
||||||
|
"flows": [
|
||||||
|
{"type": "m.login.password"}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
flows:
|
||||||
|
type: array
|
||||||
|
description: The homeserver's supported login types
|
||||||
|
items:
|
||||||
|
type: object
|
||||||
|
title: LoginFlow
|
||||||
|
properties:
|
||||||
|
type:
|
||||||
|
description: |-
|
||||||
|
The login type. This is supplied as the ``type`` when
|
||||||
|
logging in.
|
||||||
|
type: string
|
||||||
|
429:
|
||||||
|
description: This request was rate-limited.
|
||||||
|
schema:
|
||||||
|
"$ref": "definitions/error.yaml"
|
||||||
|
tags:
|
||||||
|
- Session management
|
||||||
post:
|
post:
|
||||||
summary: Authenticates the user.
|
summary: Authenticates the user.
|
||||||
description: |-
|
description: |-
|
||||||
|
|
|
@ -107,6 +107,7 @@ paths:
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
title: RoomEvent
|
title: RoomEvent
|
||||||
|
"$ref": "definitions/event-schemas/schema/core-event-schema/room_event.yaml"
|
||||||
examples:
|
examples:
|
||||||
application/json: {
|
application/json: {
|
||||||
"start": "t47429-4392820_219380_26003_2265",
|
"start": "t47429-4392820_219380_26003_2265",
|
||||||
|
|
|
@ -74,7 +74,7 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
room_events:
|
room_events:
|
||||||
type: object
|
type: object
|
||||||
title: "Room Events"
|
title: Room Events Criteria
|
||||||
description: Mapping of category name to search criteria.
|
description: Mapping of category name to search criteria.
|
||||||
properties:
|
properties:
|
||||||
search_term:
|
search_term:
|
||||||
|
@ -103,7 +103,7 @@ paths:
|
||||||
The order in which to search for results.
|
The order in which to search for results.
|
||||||
By default, this is ``"rank"``.
|
By default, this is ``"rank"``.
|
||||||
event_context:
|
event_context:
|
||||||
title: "Event Context"
|
title: Include Event Context
|
||||||
type: object
|
type: object
|
||||||
description: |-
|
description: |-
|
||||||
Configures whether any context for the events
|
Configures whether any context for the events
|
||||||
|
@ -169,13 +169,13 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
search_categories:
|
search_categories:
|
||||||
type: object
|
type: object
|
||||||
title: Categories
|
title: Result Categories
|
||||||
description: Describes which categories to search in and
|
description: Describes which categories to search in and
|
||||||
their criteria.
|
their criteria.
|
||||||
properties:
|
properties:
|
||||||
room_events:
|
room_events:
|
||||||
type: object
|
type: object
|
||||||
title: Room Event Results
|
title: Result Room Events
|
||||||
description: Mapping of category name to search criteria.
|
description: Mapping of category name to search criteria.
|
||||||
properties:
|
properties:
|
||||||
count:
|
count:
|
||||||
|
|
|
@ -17,6 +17,24 @@ Unreleased changes
|
||||||
(`#1158 <https://github.com/matrix-org/matrix-doc/pull/1158>`_).
|
(`#1158 <https://github.com/matrix-org/matrix-doc/pull/1158>`_).
|
||||||
- Document the ``server_name`` parameter on ``/join/{roomIdOrAlias}``
|
- Document the ``server_name`` parameter on ``/join/{roomIdOrAlias}``
|
||||||
(`#1364 <https://github.com/matrix-org/matrix-doc/pull/1364>`_).
|
(`#1364 <https://github.com/matrix-org/matrix-doc/pull/1364>`_).
|
||||||
|
- 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>`_).
|
||||||
|
|
||||||
- Spec clarifications:
|
- Spec clarifications:
|
||||||
|
|
||||||
|
@ -39,27 +57,14 @@ Unreleased changes
|
||||||
(`#1152 <https://github.com/matrix-org/matrix-doc/pull/1152>`_).
|
(`#1152 <https://github.com/matrix-org/matrix-doc/pull/1152>`_).
|
||||||
- Mark ``GET /rooms/{roomId}/members`` as requiring authentication
|
- Mark ``GET /rooms/{roomId}/members`` as requiring authentication
|
||||||
(`#1245 <https://github.com/matrix-org/matrix-doc/pull/1244>`_).
|
(`#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``
|
- Describe ``StateEvent`` for ``/createRoom``
|
||||||
(`#1329 <https://github.com/matrix-org/matrix-doc/pull/1329>`_).
|
(`#1329 <https://github.com/matrix-org/matrix-doc/pull/1329>`_).
|
||||||
|
- Clarify that clients must leave rooms before forgetting them
|
||||||
- Changes to the API which will be backwards-compatible for clients:
|
(`#1378 <https://github.com/matrix-org/matrix-doc/pull/1378>`_).
|
||||||
|
- Clarify the request and result types on ``/search``
|
||||||
- Add 'token' parameter to /keys/query endpoint
|
(`#1381 <https://github.com/matrix-org/matrix-doc/pull/1381>`_).
|
||||||
(`#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
|
r0.3.0
|
||||||
======
|
======
|
||||||
|
|
|
@ -98,8 +98,10 @@ func makeWalker(base string, w *fsnotify.Watcher) filepath.WalkFunc {
|
||||||
log.Fatalf("Failed to get relative path of %s: %v", path, err)
|
log.Fatalf("Failed to get relative path of %s: %v", path, err)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Normalize slashes
|
||||||
|
rel = filepath.ToSlash(rel)
|
||||||
|
|
||||||
// skip a few things that we know don't form part of the spec
|
// skip a few things that we know don't form part of the spec
|
||||||
rel = strings.Replace(rel, "\\", "/", -1) // normalize slashes (thanks to windows)
|
|
||||||
if rel == "api/node_modules" ||
|
if rel == "api/node_modules" ||
|
||||||
rel == "scripts/gen" ||
|
rel == "scripts/gen" ||
|
||||||
rel == "scripts/tmp" {
|
rel == "scripts/tmp" {
|
||||||
|
@ -127,7 +129,7 @@ func filter(e fsnotify.Event) bool {
|
||||||
}
|
}
|
||||||
|
|
||||||
// Forcefully ignore directories we don't care about (Windows, at least, tries to notify about some directories)
|
// Forcefully ignore directories we don't care about (Windows, at least, tries to notify about some directories)
|
||||||
filePath := strings.Replace(e.Name, "\\", "/", -1) // normalize slashes (thanks to windows)
|
filePath := filepath.ToSlash(e.Name) // normalize slashes
|
||||||
if strings.Contains(filePath, "/scripts/tmp") ||
|
if strings.Contains(filePath, "/scripts/tmp") ||
|
||||||
strings.Contains(filePath, "/scripts/gen") ||
|
strings.Contains(filePath, "/scripts/gen") ||
|
||||||
strings.Contains(filePath, "/api/node_modules") {
|
strings.Contains(filePath, "/api/node_modules") {
|
||||||
|
@ -156,11 +158,7 @@ func serve(w http.ResponseWriter, req *http.Request) {
|
||||||
if file[0] == '/' {
|
if file[0] == '/' {
|
||||||
file = file[1:]
|
file = file[1:]
|
||||||
}
|
}
|
||||||
b, ok = m.bytes[file]
|
b, ok = m.bytes[filepath.FromSlash(file)] // de-normalize slashes
|
||||||
|
|
||||||
if !ok {
|
|
||||||
b, ok = m.bytes[strings.Replace(file, "/", "\\", -1)] // Attempt a Windows lookup
|
|
||||||
}
|
|
||||||
|
|
||||||
if ok && file == "api-docs.json" {
|
if ok && file == "api-docs.json" {
|
||||||
w.Header().Set("Access-Control-Allow-Origin", "*")
|
w.Header().Set("Access-Control-Allow-Origin", "*")
|
||||||
|
|
|
@ -8,8 +8,11 @@ cd `dirname $0`/..
|
||||||
|
|
||||||
mkdir -p assets
|
mkdir -p assets
|
||||||
|
|
||||||
# generate specification/proposals.rst
|
if [ "$TRAVIS" != "true" ]
|
||||||
./scripts/proposals.py
|
then
|
||||||
|
# generate specification/proposals.rst
|
||||||
|
./scripts/proposals.py
|
||||||
|
fi
|
||||||
|
|
||||||
# generate the spec docs
|
# generate the spec docs
|
||||||
./scripts/gendoc.py -d assets/spec
|
./scripts/gendoc.py -d assets/spec
|
||||||
|
|
|
@ -713,6 +713,8 @@ func main() {
|
||||||
"ara4n": true,
|
"ara4n": true,
|
||||||
"leonerd": true,
|
"leonerd": true,
|
||||||
"rxl881": true,
|
"rxl881": true,
|
||||||
|
"uhoreg": true,
|
||||||
|
"turt2live": true,
|
||||||
}
|
}
|
||||||
if err := initCache(); err != nil {
|
if err := initCache(); err != nil {
|
||||||
log.Fatal(err)
|
log.Fatal(err)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue