wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Rename the presence EDU files to be accurate to their types; Misc cleanup of titles

Browse source
This commit is contained in:
Travis Ralston 2018-08-17 10:53:47 -06:00
parent ebca4c7d86
commit 750d4f9fda
8 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

2
api/server-server/definitions/event-schemas/m.presence.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
type: object
title: Presence EDU
title: ``m.presence`` EDU
description: |-
An EDU representing presence updates for users of the sending homeserver.
allOf:

2
api/server-server/definitions/event-schemas/m.presence.accept.yaml → api/server-server/definitions/event-schemas/m.presence_accept.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
type: object
title: Presence Invite Accept EDU
title: ``m.presence_accept`` EDU
description: |-
An EDU representing approval for the observing user to subscribe to the
presence of the the observed user.

2
api/server-server/definitions/event-schemas/m.presence.deny.yaml → api/server-server/definitions/event-schemas/m.presence_deny.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
type: object
title: Presence Invite Deny EDU
title: ``m.presence_deny`` EDU
description: |-
An EDU representing a declination or revocation for the observing user
to subscribe to the presence of the observed user.

2
api/server-server/definitions/event-schemas/m.presence.invite.yaml → api/server-server/definitions/event-schemas/m.presence_invite.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
type: object
title: Presence Invite EDU
title: ``m.presence_invite`` EDU
description: |-
An EDU representing a request to subscribe to a user's presence.
allOf:

2
api/server-server/definitions/event-schemas/m.receipt.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
type: object
title: Receipt EDU
title: ``m.receipt`` EDU
description: |-
An EDU representing receipt updates for users of the sending homeserver.
When receiving receipts, the server should only update entries that are

2
api/server-server/definitions/event-schemas/m.typing.yaml
View file

@ -13,7 +13,7 @@
# limitations under the License.
type: object
title: Typing Notification EDU
title: ``m.typing`` EDU
description: A typing notification EDU for a user in a room.
allOf:
- $ref: ../edu.yaml

2
scripts/templating/matrix_templates/templates/schema-definition.tmpl
View file

@ -1,6 +1,6 @@
{% import 'tables.tmpl' as tables -%}
``{{definition.title}}`` Schema
``{{definition.title}}`` schema
{{(11 + definition.title | length) * title_kind}}
{% if 'description' in definition %}

1
scripts/templating/matrix_templates/units.py
View file

@ -49,7 +49,6 @@ SWAGGER_DEFINITIONS = {
os.path.join(matrix_doc_dir, "api/identity/definitions"): "is",
os.path.join(matrix_doc_dir, "api/push-gateway/definitions"): "push",
os.path.join(matrix_doc_dir, "api/server-server/definitions"): "ss",
os.path.join(matrix_doc_dir, "api/server-server/definitions/presence"): "ss_presence",
}
EVENT_EXAMPLES = os.path.join(matrix_doc_dir, "event-schemas/examples")
EVENT_SCHEMA = os.path.join(matrix_doc_dir, "event-schemas/schema")