Merge branch 'master' into travis/m.ignored_user_list

pull/977/head
Travis Ralston 7 years ago committed by GitHub
commit d37ed0876f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

1
.gitignore vendored

@ -6,6 +6,7 @@
/scripts/continuserv/continuserv
/scripts/speculator/speculator
/scripts/swagger
/scripts/tmp
/templating/out
*.pyc
*.swp

@ -41,7 +41,7 @@ specs and event schemas in this repository.
Preparation
-----------
To use the scripts, it is best to create a Python virtualenv as follows::
To use the scripts, it is best to create a Python 2.x virtualenv as follows::
virtualenv env
env/bin/pip install -r scripts/requirements.txt

@ -0,0 +1,44 @@
# Copyright 2018 Kamax Sàrl
#
# 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.
swagger: "2.0"
info:
title: "Matrix Client-Identity Versions API"
version: "1.0.0"
host: localhost:8090
schemes:
- https
basePath: /_matrix/identity
produces:
- application/json
paths:
"/api/v1":
get:
summary: Checks that an Identity server is available at this API endpopint.
description: |-
Checks that an Identity server is available at this API endpopint.
To discover that an Identity server is available at a specific URL,
this endpoint can be queried and will return an empty object.
This is primarly used for auto-discovery and health check purposes
by entities acting as a client for the Identity server.
operationId: ping
responses:
200:
description: An Identity server is ready to serve requests.
examples:
application/json: {}
schema:
type: object

@ -21,6 +21,10 @@ Unreleased changes
(`#1109 <https://github.com/matrix-org/matrix-doc/pull/1109>`_).
- Add spec for ignoring users
(`#1142 <https://github.com/matrix-org/matrix-doc/pull/1142>`_).
- Fix the representation of ``m.presence`` events
(`#1137 <https://github.com/matrix-org/matrix-doc/pull/1137>`_).
- Clarify that ``m.tag`` ordering is done with numbers, not strings
(`#1139 <https://github.com/matrix-org/matrix-doc/pull/1139>`_).
- Changes to the API which will be backwards-compatible for clients:

@ -4,8 +4,7 @@
"last_active_ago": 2478593,
"presence": "online",
"currently_active": false,
"user_id": "@example:localhost"
},
"event_id": "$WLGTSEFSEF:localhost",
"sender": "@example:localhost",
"type": "m.presence"
}

@ -2,7 +2,7 @@
"type": "m.tag",
"content": {
"tags": {
"work": {"order": 1}
"u.work": {"order": 1}
}
}
}

@ -29,21 +29,17 @@
"currently_active": {
"type": boolean,
"description": "Whether the user is currently active"
},
"user_id": {
"type": "string",
"description": "The user's ID."
}
},
"required": ["presence", "user_id"]
"required": ["presence"]
},
"type": {
"type": "string",
"enum": ["m.presence"]
},
"event_id": {
"sender": {
"type": "string"
}
},
"required": ["event_id", "type", "content"]
"required": ["sender", "type", "content"]
}

@ -67,6 +67,11 @@ should allow a 3pid to be mapped to a Matrix user identity, but not in the other
direction (i.e. one should not be able to get all 3pids associated with a Matrix
user ID, or get all 3pids associated with a 3pid).
Status check
------------
{{ping_is_http_api}}
Key management
--------------

@ -35,12 +35,11 @@ the tags are for.
Each tag has an associated JSON object with information about the tag, e.g how
to order the rooms with a given tag.
Ordering information is given under the ``order`` key as a string. The string
are compared lexicographically by unicode codepoint to determine which should
displayed first. So a room with a tag with an ``order`` key of ``"apples"``
would appear before a room with a tag with an ``order`` key of ``"oranges"``.
If a room has a tag without an ``order`` key then it should appear after the
rooms with that tag that have an ``order`` key.
Ordering information is given under teh ``order`` key as a number between 0 and
1. The numbers are compared such that 0 is displayed first. Therefore a room
with an ``order`` of ``0.2`` would be displayed before a room with an ``order``
of ``0.7``. If a room has a tag without an ``order`` key then it should appear
after the rooms with that tag that have an ``order`` key.
The name of a tag MUST not exceed 255 bytes.

Loading…
Cancel
Save