diff --git a/data/api/client-server/list_public_rooms.yaml b/data/api/client-server/list_public_rooms.yaml index ef71ca63..c3e54403 100644 --- a/data/api/client-server/list_public_rooms.yaml +++ b/data/api/client-server/list_public_rooms.yaml @@ -226,7 +226,7 @@ paths: type: boolean description: |- Whether or not to include all known networks/protocols from - application services on the homeserver. Defaults to false. + application services on the homeserver. Defaults to `false`. example: false third_party_instance_id: type: string @@ -277,4 +277,4 @@ components: accessTokenQuery: $ref: definitions/security.yaml#/accessTokenQuery accessTokenBearer: - $ref: definitions/security.yaml#/accessTokenBearer \ No newline at end of file + $ref: definitions/security.yaml#/accessTokenBearer diff --git a/data/api/client-server/login.yaml b/data/api/client-server/login.yaml index 7251d4ff..a668a6bc 100644 --- a/data/api/client-server/login.yaml +++ b/data/api/client-server/login.yaml @@ -148,7 +148,7 @@ paths: known client device, a new device will be created. The given device ID must not be the same as a [cross-signing](/client-server-api/#cross-signing) key ID. - The server will auto-generate a device_id + The server will auto-generate a `device_id` if this is not specified. initial_device_display_name: type: string diff --git a/data/api/client-server/password_management.yaml b/data/api/client-server/password_management.yaml index b2d60559..3a1a570e 100644 --- a/data/api/client-server/password_management.yaml +++ b/data/api/client-server/password_management.yaml @@ -57,7 +57,7 @@ paths: type: boolean description: |- Whether the user's other access tokens, and their associated devices, should be - revoked if the request succeeds. Defaults to true. + revoked if the request succeeds. Defaults to `true`. When `false`, the server can still take advantage of the [soft logout method](/client-server-api/#soft-logout) for the user's remaining devices. diff --git a/data/api/client-server/registration.yaml b/data/api/client-server/registration.yaml index acb0b135..2813c0c2 100644 --- a/data/api/client-server/registration.yaml +++ b/data/api/client-server/registration.yaml @@ -126,7 +126,7 @@ paths: description: |- ID of the client device. If this does not correspond to a known client device, a new device will be created. The server - will auto-generate a device_id if this is not specified. + will auto-generate a `device_id` if this is not specified. example: GHTYAJCE initial_device_display_name: type: string @@ -139,11 +139,11 @@ paths: description: |- If true, an `access_token` and `device_id` should not be returned from this call, therefore preventing an automatic - login. Defaults to false. + login. Defaults to `false`. example: false refresh_token: type: boolean - description: If true, the client supports refresh tokens. + description: If `true`, the client supports refresh tokens. x-addedInMatrixVersion: "1.3" required: true responses: diff --git a/data/api/server-server/public_rooms.yaml b/data/api/server-server/public_rooms.yaml index 8beaecb2..41835f5a 100644 --- a/data/api/server-server/public_rooms.yaml +++ b/data/api/server-server/public_rooms.yaml @@ -49,7 +49,7 @@ paths: name: include_all_networks description: |- Whether or not to include all networks/protocols defined by application - services on the homeserver. Defaults to false. + services on the homeserver. Defaults to `false`. example: false schema: type: boolean @@ -121,7 +121,7 @@ paths: type: boolean description: |- Whether or not to include all known networks/protocols from - application services on the homeserver. Defaults to false. + application services on the homeserver. Defaults to `false`. example: false third_party_instance_id: type: string diff --git a/data/event-schemas/schema/m.room.server_acl.yaml b/data/event-schemas/schema/m.room.server_acl.yaml index c2ecf805..da490452 100644 --- a/data/event-schemas/schema/m.room.server_acl.yaml +++ b/data/event-schemas/schema/m.room.server_acl.yaml @@ -54,7 +54,7 @@ properties: type: boolean description: |- True to allow server names that are IP address literals. False to - deny. Defaults to true if missing or otherwise not a boolean. + deny. Defaults to `true` if missing or otherwise not a boolean. This is strongly recommended to be set to `false` as servers running with IP literal names are strongly discouraged in order to require