diff --git a/docs/client-server/swagger_matrix/api-docs-directory b/docs/client-server/swagger_matrix/api-docs-directory
index 98109a0fbc..ce12be8c96 100644
--- a/docs/client-server/swagger_matrix/api-docs-directory
+++ b/docs/client-server/swagger_matrix/api-docs-directory
@@ -1,7 +1,7 @@
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"resourcePath": "/directory",
"produces": [
"application/json"
@@ -13,6 +13,7 @@
{
"method": "GET",
"summary": "Get the room ID corresponding to this room alias.",
+ "notes": "Volatile: This API is likely to change.",
"type": "DirectoryResponse",
"nickname": "get_room_id_for_alias",
"parameters": [
@@ -28,6 +29,7 @@
{
"method": "PUT",
"summary": "Create a new mapping from room alias to room ID.",
+ "notes": "Volatile: This API is likely to change.",
"type": "void",
"nickname": "add_room_alias",
"parameters": [
diff --git a/docs/client-server/swagger_matrix/api-docs-events b/docs/client-server/swagger_matrix/api-docs-events
index e5dd3a6113..1bdb9b034a 100644
--- a/docs/client-server/swagger_matrix/api-docs-events
+++ b/docs/client-server/swagger_matrix/api-docs-events
@@ -1,7 +1,7 @@
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"resourcePath": "/events",
"produces": [
"application/json"
diff --git a/docs/client-server/swagger_matrix/api-docs-login b/docs/client-server/swagger_matrix/api-docs-login
index 8cc598b3c1..d6f8d84f29 100644
--- a/docs/client-server/swagger_matrix/api-docs-login
+++ b/docs/client-server/swagger_matrix/api-docs-login
@@ -8,7 +8,7 @@
"nickname": "get_login_info",
"notes": "All login stages MUST be mentioned if there is >1 login type.",
"summary": "Get the login mechanism to use when logging in.",
- "type": "LoginInfo"
+ "type": "LoginFlows"
},
{
"method": "POST",
@@ -40,17 +40,31 @@
"path": "/login"
}
],
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"consumes": [
"application/json"
],
"models": {
+ "LoginFlows": {
+ "id": "LoginFlows",
+ "properties": {
+ "flows": {
+ "description": "A list of valid login flows.",
+ "type": "array",
+ "items": {
+ "$ref": "LoginInfo"
+ }
+ }
+ }
+ },
"LoginInfo": {
"id": "LoginInfo",
"properties": {
"stages": {
"description": "Multi-stage login only: An array of all the login types required to login.",
- "format": "string",
+ "items": {
+ "$ref": "string"
+ },
"type": "array"
},
"type": {
@@ -65,6 +79,10 @@
"access_token": {
"description": "The access token for this user's login if this is the final stage of the login process.",
"type": "string"
+ },
+ "user_id": {
+ "description": "The user's fully-qualified user ID.",
+ "type": "string"
},
"next": {
"description": "Multi-stage login only: The next login type to submit.",
diff --git a/docs/client-server/swagger_matrix/api-docs-presence b/docs/client-server/swagger_matrix/api-docs-presence
index d52ce2164a..6b22446024 100644
--- a/docs/client-server/swagger_matrix/api-docs-presence
+++ b/docs/client-server/swagger_matrix/api-docs-presence
@@ -1,7 +1,7 @@
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"resourcePath": "/presence",
"produces": [
"application/json"
@@ -106,7 +106,7 @@
"PresenceUpdate": {
"id": "PresenceUpdate",
"properties": {
- "state": {
+ "presence": {
"type": "string",
"description": "Enum: The presence state.",
"enum": [
@@ -128,10 +128,10 @@
"Presence": {
"id": "Presence",
"properties": {
- "mtime_age": {
+ "last_active_ago": {
"type": "integer",
"format": "int64",
- "description": "The last time this user's presence state changed, in milliseconds."
+ "description": "The last time this user performed an action on their home server."
},
"user_id": {
"type": "string",
diff --git a/docs/client-server/swagger_matrix/api-docs-profile b/docs/client-server/swagger_matrix/api-docs-profile
index 188259fa3d..d2fccaa67d 100644
--- a/docs/client-server/swagger_matrix/api-docs-profile
+++ b/docs/client-server/swagger_matrix/api-docs-profile
@@ -1,7 +1,7 @@
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"resourcePath": "/profile",
"produces": [
"application/json"
diff --git a/docs/client-server/swagger_matrix/api-docs-registration b/docs/client-server/swagger_matrix/api-docs-registration
index 2048aec1d2..f4669ea2f0 100644
--- a/docs/client-server/swagger_matrix/api-docs-registration
+++ b/docs/client-server/swagger_matrix/api-docs-registration
@@ -37,7 +37,7 @@
"path": "/register"
}
],
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"consumes": [
"application/json"
],
@@ -52,6 +52,10 @@
"user_id": {
"description": "The fully-qualified user ID.",
"type": "string"
+ },
+ "home_server": {
+ "description": "The name of the home server.",
+ "type": "string"
}
}
},
diff --git a/docs/client-server/swagger_matrix/api-docs-rooms b/docs/client-server/swagger_matrix/api-docs-rooms
index 0a8bb3c2a5..0e1fa452a2 100644
--- a/docs/client-server/swagger_matrix/api-docs-rooms
+++ b/docs/client-server/swagger_matrix/api-docs-rooms
@@ -1,7 +1,7 @@
{
"apiVersion": "1.0.0",
"swaggerVersion": "1.2",
- "basePath": "http://localhost:8080/_matrix/client/api/v1",
+ "basePath": "http://localhost:8008/_matrix/client/api/v1",
"resourcePath": "/rooms",
"produces": [
"application/json"
@@ -181,6 +181,59 @@
]
},
{
+ "path": "/rooms/{roomId}/state/m.room.name",
+ "operations": [
+ {
+ "method": "PUT",
+ "summary": "Set the name of this room.",
+ "notes": "Set the name of this room.",
+ "type": "void",
+ "nickname": "set_room_name",
+ "consumes": [
+ "application/json"
+ ],
+ "parameters": [
+ {
+ "name": "body",
+ "description": "The name contents",
+ "required": true,
+ "type": "RoomName",
+ "paramType": "body"
+ },
+ {
+ "name": "roomId",
+ "description": "The room to set the name of.",
+ "required": true,
+ "type": "string",
+ "paramType": "path"
+ }
+ ]
+ },
+ {
+ "method": "GET",
+ "summary": "Get the room's name.",
+ "notes": "",
+ "type": "RoomName",
+ "nickname": "get_room_name",
+ "parameters": [
+ {
+ "name": "roomId",
+ "description": "The room to get the name of.",
+ "required": true,
+ "type": "string",
+ "paramType": "path"
+ }
+ ],
+ "responseMessages": [
+ {
+ "code": 404,
+ "message": "Name not found."
+ }
+ ]
+ }
+ ]
+ },
+ {
"path": "/rooms/{roomId}/send/m.room.message.feedback",
"operations": [
{
@@ -267,6 +320,12 @@
"required": true,
"type": "string",
"paramType": "path"
+ },
+ {
+ "name": "body",
+ "required": true,
+ "type": "JoinRequest",
+ "paramType": "body"
}
]
}
@@ -291,6 +350,12 @@
"required": true,
"type": "string",
"paramType": "path"
+ },
+ {
+ "name": "body",
+ "required": true,
+ "type": "LeaveRequest",
+ "paramType": "body"
}
]
}
@@ -424,10 +489,10 @@
"path": "/join/{roomAliasOrId}",
"operations": [
{
- "method": "PUT",
+ "method": "POST",
"summary": "Join a room via a room alias or room ID.",
"notes": "Join a room via a room alias or room ID.",
- "type": "RoomInfo",
+ "type": "JoinRoomInfo",
"nickname": "join",
"consumes": [
"application/json"
@@ -574,7 +639,7 @@
{
"method": "GET",
"summary": "Get a list of all the current state events for this room.",
- "notes": "Get a list of all the current state events for this room.",
+ "notes": "NOT YET IMPLEMENTED.",
"type": "array",
"items": {
"$ref": "Event"
@@ -598,7 +663,7 @@
{
"method": "GET",
"summary": "Get all the current information for this room, including messages and state events.",
- "notes": "Get all the current information for this room, including messages and state events.",
+ "notes": "NOT YET IMPLEMENTED.",
"type": "InitialSyncRoomData",
"nickname": "get_room_sync_data",
"parameters": [
@@ -624,6 +689,15 @@
}
}
},
+ "RoomName": {
+ "id": "RoomName",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "The human-readable name for the room. Can contain spaces."
+ }
+ }
+ },
"Message": {
"id": "Message",
"properties": {
@@ -640,6 +714,16 @@
"Feedback": {
"id": "Feedback",
"properties": {
+ "target_event_id": {
+ "type": "string",
+ "description": "The event ID being acknowledged.",
+ "required": true
+ },
+ "type": {
+ "type": "string",
+ "description": "The type of feedback. Either 'delivered' or 'read'.",
+ "required": true
+ }
}
},
"Member": {
@@ -652,7 +736,7 @@
"invite",
"join",
"leave",
- "knock"
+ "ban"
]
}
}
@@ -672,6 +756,16 @@
}
}
},
+ "JoinRoomInfo": {
+ "id": "JoinRoomInfo",
+ "properties": {
+ "room_id": {
+ "type": "string",
+ "description": "The room ID joined, if joined via a room alias only.",
+ "required": true
+ }
+ }
+ },
"RoomConfig": {
"id": "RoomConfig",
"properties": {
@@ -830,6 +924,14 @@
}
}
},
+ "JoinRequest": {
+ "id": "JoinRequest",
+ "properties": {}
+ },
+ "LeaveRequest": {
+ "id": "LeaveRequest",
+ "properties": {}
+ },
"BanRequest": {
"id": "BanRequest",
"properties": {
|
