From 6cbb88f9df88bdd60e8ce841122708e80256f8e3 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 8 Nov 2022 18:53:36 +0000 Subject: [PATCH 1/2] Fix broken links A bunch of broken links I found --- content/client-server-api/_index.md | 2 +- content/client-server-api/modules/event_replacements.md | 4 ++-- content/client-server-api/modules/typing_notifications.md | 2 +- content/identity-service-api.md | 2 +- content/rooms/fragments/v1-auth-rules.md | 4 ++-- content/rooms/fragments/v3-auth-rules.md | 4 ++-- content/rooms/fragments/v8-auth-rules.md | 4 ++-- content/rooms/v10.md | 4 ++-- content/rooms/v6.md | 2 +- content/rooms/v7.md | 2 +- data/api/client-server/threads_list.yaml | 2 +- data/api/identity/v2_lookup.yaml | 2 +- data/api/server-server/space_hierarchy.yaml | 4 ++-- data/event-schemas/schema/m.room.encrypted.yaml | 3 ++- 14 files changed, 21 insertions(+), 20 deletions(-) diff --git a/content/client-server-api/_index.md b/content/client-server-api/_index.md index d6dec7a2b..6ab6f46a4 100644 --- a/content/client-server-api/_index.md +++ b/content/client-server-api/_index.md @@ -2527,7 +2527,7 @@ that profile. | [Instant Messaging](#instant-messaging) | Required | Required | Required | Required | Optional | | [Rich replies](#rich-replies) | Optional | Optional | Optional | Optional | Optional | | [Direct Messaging](#direct-messaging) | Required | Required | Required | Required | Optional | -| [Mentions](#user-room-and-group-mentions) | Required | Required | Required | Optional | Optional | +| [Mentions](#user-and-room-mentions) | Required | Required | Required | Optional | Optional | | [Presence](#presence) | Required | Required | Required | Required | Optional | | [Push Notifications](#push-notifications) | Optional | Required | Optional | Optional | Optional | | [Receipts](#receipts) | Required | Required | Required | Required | Optional | diff --git a/content/client-server-api/modules/event_replacements.md b/content/client-server-api/modules/event_replacements.md index 4fedf5016..a4257fc3a 100644 --- a/content/client-server-api/modules/event_replacements.md +++ b/content/client-server-api/modules/event_replacements.md @@ -256,8 +256,8 @@ unable to do so. This happens in the following situations: * The original event (and hence its replacement) are encrypted. Client authors are reminded to take note of the requirements for [Validity of -message edit events](#validity-of-message-edit-events), and to ignore any -invalid edit events that are received. +replacement events](#validity-of-replacement-events), and to ignore any +invalid replacement events that are received. ##### Permalinks diff --git a/content/client-server-api/modules/typing_notifications.md b/content/client-server-api/modules/typing_notifications.md index 3c09e9b30..55efc709f 100644 --- a/content/client-server-api/modules/typing_notifications.md +++ b/content/client-server-api/modules/typing_notifications.md @@ -4,7 +4,7 @@ Users may wish to be informed when another user is typing in a room. This can be achieved using typing notifications. These are ephemeral events, so they do not form part of the -[Event Graph](index.html#event-graphs). Typing notifications are scoped +[Event Graph](/#event-graphs). Typing notifications are scoped to a room. #### Events diff --git a/content/identity-service-api.md b/content/identity-service-api.md index 9c5a93c47..eac159b7c 100644 --- a/content/identity-service-api.md +++ b/content/identity-service-api.md @@ -31,7 +31,7 @@ not necessarily provide evidence that they have validated associations, but claim to have done so. Establishing the trustworthiness of an individual identity server is left as an exercise for the client. -3PID types are described in [3PID Types](/appendices#pid-types) +3PID types are described in [3PID Types](/appendices#3pid-types) Appendix. ## API standards diff --git a/content/rooms/fragments/v1-auth-rules.md b/content/rooms/fragments/v1-auth-rules.md index 4fd7faf4f..e15a93d5f 100644 --- a/content/rooms/fragments/v1-auth-rules.md +++ b/content/rooms/fragments/v1-auth-rules.md @@ -3,7 +3,7 @@ The types of state events that affect authorization are: - [`m.room.create`](/client-server-api#mroomcreate) - [`m.room.member`](/client-server-api#mroommember) -- [`m.room.join_rules`](/client-server-api#mroom) +- [`m.room.join_rules`](/client-server-api#mroomjoin_rules) - [`m.room.power_levels`](/client-server-api#mroompower_levels) - [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite) @@ -32,7 +32,7 @@ The rules are as follows: algorithm described in the server specification, reject. 3. If there are entries which were themselves rejected under the [checks performed on receipt of a - PDU](server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. + PDU](/server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. 4. If there is no `m.room.create` event among the entries, reject. 3. If the `content` of the `m.room.create` event in the room state has the property `m.federate` set to `false`, and the `sender` domain of the event diff --git a/content/rooms/fragments/v3-auth-rules.md b/content/rooms/fragments/v3-auth-rules.md index f69928445..05b8065a8 100644 --- a/content/rooms/fragments/v3-auth-rules.md +++ b/content/rooms/fragments/v3-auth-rules.md @@ -11,7 +11,7 @@ The types of state events that affect authorization are: - [`m.room.create`](/client-server-api#mroomcreate) - [`m.room.member`](/client-server-api#mroommember) -- [`m.room.join_rules`](/client-server-api#mroom) +- [`m.room.join_rules`](/client-server-api#mroomjoin_rules) - [`m.room.power_levels`](/client-server-api#mroompower_levels) - [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite) @@ -40,7 +40,7 @@ The complete list of rules, as of room version 3, is as follows: algorithm described in the server specification, reject. 3. If there are entries which were themselves rejected under the [checks performed on receipt of a - PDU](server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. + PDU](/server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. 4. If there is no `m.room.create` event among the entries, reject. 3. If the `content` of the `m.room.create` event in the room state has the property `m.federate` set to `false`, and the `sender` domain of the event diff --git a/content/rooms/fragments/v8-auth-rules.md b/content/rooms/fragments/v8-auth-rules.md index 07833ad68..98a88bf1c 100644 --- a/content/rooms/fragments/v8-auth-rules.md +++ b/content/rooms/fragments/v8-auth-rules.md @@ -11,7 +11,7 @@ The types of state events that affect authorization are: - [`m.room.create`](/client-server-api#mroomcreate) - [`m.room.member`](/client-server-api#mroommember) -- [`m.room.join_rules`](/client-server-api#mroom) +- [`m.room.join_rules`](/client-server-api#mroomjoin_rules) - [`m.room.power_levels`](/client-server-api#mroompower_levels) - [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite) @@ -40,7 +40,7 @@ The rules are as follows: algorithm described in the server specification, reject. 3. If there are entries which were themselves rejected under the [checks performed on receipt of a - PDU](server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. + PDU](/server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. 4. If there is no `m.room.create` event among the entries, reject. 3. If the `content` of the `m.room.create` event in the room state has the property `m.federate` set to `false`, and the `sender` domain of the event diff --git a/content/rooms/v10.md b/content/rooms/v10.md index 628f14e15..46bdb4c77 100644 --- a/content/rooms/v10.md +++ b/content/rooms/v10.md @@ -86,7 +86,7 @@ The types of state events that affect authorization are: - [`m.room.create`](/client-server-api#mroomcreate) - [`m.room.member`](/client-server-api#mroommember) -- [`m.room.join_rules`](/client-server-api#mroom) +- [`m.room.join_rules`](/client-server-api#mroomjoin_rules) - [`m.room.power_levels`](/client-server-api#mroompower_levels) - [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite) @@ -115,7 +115,7 @@ The rules are as follows: algorithm described in the server specification, reject. 3. If there are entries which were themselves rejected under the [checks performed on receipt of a - PDU](server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. + PDU](/server-server-api/#checks-performed-on-receipt-of-a-pdu), reject. 4. If there is no `m.room.create` event among the entries, reject. 3. If the `content` of the `m.room.create` event in the room state has the property `m.federate` set to `false`, and the `sender` domain of the event diff --git a/content/rooms/v6.md b/content/rooms/v6.md index bcacfef8a..977f5479d 100644 --- a/content/rooms/v6.md +++ b/content/rooms/v6.md @@ -61,7 +61,7 @@ The types of state events that affect authorization are: - [`m.room.create`](/client-server-api#mroomcreate) - [`m.room.member`](/client-server-api#mroommember) -- [`m.room.join_rules`](/client-server-api#mroom) +- [`m.room.join_rules`](/client-server-api#mroomjoin_rules) - [`m.room.power_levels`](/client-server-api#mroompower_levels) - [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite) diff --git a/content/rooms/v7.md b/content/rooms/v7.md index 3cc77bb31..40a9962cb 100644 --- a/content/rooms/v7.md +++ b/content/rooms/v7.md @@ -47,7 +47,7 @@ The types of state events that affect authorization are: - [`m.room.create`](/client-server-api#mroomcreate) - [`m.room.member`](/client-server-api#mroommember) -- [`m.room.join_rules`](/client-server-api#mroom) +- [`m.room.join_rules`](/client-server-api#mroomjoin_rules) - [`m.room.power_levels`](/client-server-api#mroompower_levels) - [`m.room.third_party_invite`](/client-server-api#mroomthird_party_invite) diff --git a/data/api/client-server/threads_list.yaml b/data/api/client-server/threads_list.yaml index c0c9cbd02..af875fbfd 100644 --- a/data/api/client-server/threads_list.yaml +++ b/data/api/client-server/threads_list.yaml @@ -51,7 +51,7 @@ paths: description: |- Optional (default `all`) flag to denote which thread roots are of interest to the caller. When `all`, all thread roots found in the room are returned. When `participated`, only - thread roots for threads the user has [participated in](/client-server-api/#server-side-aggreagtion-of-mthread-relationships) + thread roots for threads the user has [participated in](/client-server-api/#server-side-aggregation-of-mthread-relationships) will be returned. x-example: "all" - in: query diff --git a/data/api/identity/v2_lookup.yaml b/data/api/identity/v2_lookup.yaml index 66ac1a0a3..d5e9352c1 100644 --- a/data/api/identity/v2_lookup.yaml +++ b/data/api/identity/v2_lookup.yaml @@ -103,7 +103,7 @@ paths: hashed or formatted will lead to no matches. Note that addresses are case sensitive: review the - [3PID Types](/appendices#pid-types) to verify the intended case an + [3PID Types](/appendices#3pid-types) to verify the intended case an identifier should be prior to submission/hashing. example: [ "4kenr7N9drpCJ4AfalmlGQVsOn3o2RHjkADUpXJWZUc", diff --git a/data/api/server-server/space_hierarchy.yaml b/data/api/server-server/space_hierarchy.yaml index ccc7c6f14..296fb6579 100644 --- a/data/api/server-server/space_hierarchy.yaml +++ b/data/api/server-server/space_hierarchy.yaml @@ -36,7 +36,7 @@ paths: the space-room's children the requesting server could feasibly peek/join are returned. The requesting server is responsible for filtering the results further down for the user's request. - Only [`m.space.child`](#mspacechild) state events of the room are considered. Invalid child + Only [`m.space.child`](/client-server-api/#mspacechild) state events of the room are considered. Invalid child rooms and parent events are not covered by this endpoint. Responses to this endpoint should be cached for a period of time. @@ -55,7 +55,7 @@ paths: name: suggested_only description: |- Optional (default `false`) flag to indicate whether or not the server should only consider - suggested rooms. Suggested rooms are annotated in their [`m.space.child`](#mspacechild) event + suggested rooms. Suggested rooms are annotated in their [`m.space.child`](/client-server-api/#mspacechild) event contents. x-example: true responses: diff --git a/data/event-schemas/schema/m.room.encrypted.yaml b/data/event-schemas/schema/m.room.encrypted.yaml index 51024f7e2..84461013c 100644 --- a/data/event-schemas/schema/m.room.encrypted.yaml +++ b/data/event-schemas/schema/m.room.encrypted.yaml @@ -4,7 +4,8 @@ allOf: description: |- This event type is used when sending encrypted events. It can be used either - within a room (in which case it will have all of the [Room Event fields](/client-server-api/#room-event-fields)), or + within a room (in which case it will have all of the normal properties in + [Room events](/client-server-api/#room-event-format)), or as a [to-device](/client-server-api/#send-to-device-messaging) event. properties: From 4d0c912acf3d5d2d25e9a5dd274a379da21cdb73 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Tue, 8 Nov 2022 18:56:13 +0000 Subject: [PATCH 2/2] changelogs --- changelogs/client_server/newsfragments/1330.clarification | 1 + changelogs/identity_service/newsfragments/1330.clarification | 1 + changelogs/room_versions/newsfragments/1330.clarification | 1 + changelogs/server_server/newsfragments/1330.clarification | 1 + 4 files changed, 4 insertions(+) create mode 100644 changelogs/client_server/newsfragments/1330.clarification create mode 100644 changelogs/identity_service/newsfragments/1330.clarification create mode 100644 changelogs/room_versions/newsfragments/1330.clarification create mode 100644 changelogs/server_server/newsfragments/1330.clarification diff --git a/changelogs/client_server/newsfragments/1330.clarification b/changelogs/client_server/newsfragments/1330.clarification new file mode 100644 index 000000000..5c0e57d84 --- /dev/null +++ b/changelogs/client_server/newsfragments/1330.clarification @@ -0,0 +1 @@ +Fix a number of broken links in the specification. diff --git a/changelogs/identity_service/newsfragments/1330.clarification b/changelogs/identity_service/newsfragments/1330.clarification new file mode 100644 index 000000000..5c0e57d84 --- /dev/null +++ b/changelogs/identity_service/newsfragments/1330.clarification @@ -0,0 +1 @@ +Fix a number of broken links in the specification. diff --git a/changelogs/room_versions/newsfragments/1330.clarification b/changelogs/room_versions/newsfragments/1330.clarification new file mode 100644 index 000000000..5c0e57d84 --- /dev/null +++ b/changelogs/room_versions/newsfragments/1330.clarification @@ -0,0 +1 @@ +Fix a number of broken links in the specification. diff --git a/changelogs/server_server/newsfragments/1330.clarification b/changelogs/server_server/newsfragments/1330.clarification new file mode 100644 index 000000000..5c0e57d84 --- /dev/null +++ b/changelogs/server_server/newsfragments/1330.clarification @@ -0,0 +1 @@ +Fix a number of broken links in the specification.