From 750d4f9fdaaafac8b52c05828f2675d03c10df51 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Fri, 17 Aug 2018 10:53:47 -0600 Subject: [PATCH] Rename the presence EDU files to be accurate to their types; Misc cleanup of titles --- api/server-server/definitions/event-schemas/m.presence.yaml | 2 +- .../{m.presence.accept.yaml => m.presence_accept.yaml} | 2 +- .../{m.presence.deny.yaml => m.presence_deny.yaml} | 2 +- .../{m.presence.invite.yaml => m.presence_invite.yaml} | 2 +- api/server-server/definitions/event-schemas/m.receipt.yaml | 2 +- api/server-server/definitions/event-schemas/m.typing.yaml | 2 +- .../matrix_templates/templates/schema-definition.tmpl | 2 +- scripts/templating/matrix_templates/units.py | 1 - 8 files changed, 7 insertions(+), 8 deletions(-) rename api/server-server/definitions/event-schemas/{m.presence.accept.yaml => m.presence_accept.yaml} (97%) rename api/server-server/definitions/event-schemas/{m.presence.deny.yaml => m.presence_deny.yaml} (98%) rename api/server-server/definitions/event-schemas/{m.presence.invite.yaml => m.presence_invite.yaml} (97%) diff --git a/api/server-server/definitions/event-schemas/m.presence.yaml b/api/server-server/definitions/event-schemas/m.presence.yaml index f9e0499b..8d4ef6e8 100644 --- a/api/server-server/definitions/event-schemas/m.presence.yaml +++ b/api/server-server/definitions/event-schemas/m.presence.yaml @@ -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: diff --git a/api/server-server/definitions/event-schemas/m.presence.accept.yaml b/api/server-server/definitions/event-schemas/m.presence_accept.yaml similarity index 97% rename from api/server-server/definitions/event-schemas/m.presence.accept.yaml rename to api/server-server/definitions/event-schemas/m.presence_accept.yaml index 72f932d2..4c39989b 100644 --- a/api/server-server/definitions/event-schemas/m.presence.accept.yaml +++ b/api/server-server/definitions/event-schemas/m.presence_accept.yaml @@ -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. diff --git a/api/server-server/definitions/event-schemas/m.presence.deny.yaml b/api/server-server/definitions/event-schemas/m.presence_deny.yaml similarity index 98% rename from api/server-server/definitions/event-schemas/m.presence.deny.yaml rename to api/server-server/definitions/event-schemas/m.presence_deny.yaml index 3264a5af..1b9bff7d 100644 --- a/api/server-server/definitions/event-schemas/m.presence.deny.yaml +++ b/api/server-server/definitions/event-schemas/m.presence_deny.yaml @@ -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. diff --git a/api/server-server/definitions/event-schemas/m.presence.invite.yaml b/api/server-server/definitions/event-schemas/m.presence_invite.yaml similarity index 97% rename from api/server-server/definitions/event-schemas/m.presence.invite.yaml rename to api/server-server/definitions/event-schemas/m.presence_invite.yaml index 8ae84872..4cdc58eb 100644 --- a/api/server-server/definitions/event-schemas/m.presence.invite.yaml +++ b/api/server-server/definitions/event-schemas/m.presence_invite.yaml @@ -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: diff --git a/api/server-server/definitions/event-schemas/m.receipt.yaml b/api/server-server/definitions/event-schemas/m.receipt.yaml index 210988f9..58f47e3a 100644 --- a/api/server-server/definitions/event-schemas/m.receipt.yaml +++ b/api/server-server/definitions/event-schemas/m.receipt.yaml @@ -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 diff --git a/api/server-server/definitions/event-schemas/m.typing.yaml b/api/server-server/definitions/event-schemas/m.typing.yaml index 101d8d79..34b39529 100644 --- a/api/server-server/definitions/event-schemas/m.typing.yaml +++ b/api/server-server/definitions/event-schemas/m.typing.yaml @@ -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 diff --git a/scripts/templating/matrix_templates/templates/schema-definition.tmpl b/scripts/templating/matrix_templates/templates/schema-definition.tmpl index 42a7ae47..e2be12e8 100644 --- a/scripts/templating/matrix_templates/templates/schema-definition.tmpl +++ b/scripts/templating/matrix_templates/templates/schema-definition.tmpl @@ -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 %} diff --git a/scripts/templating/matrix_templates/units.py b/scripts/templating/matrix_templates/units.py index c1481430..90a87cd4 100644 --- a/scripts/templating/matrix_templates/units.py +++ b/scripts/templating/matrix_templates/units.py @@ -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")