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

Switch to using $ instead of # for sub-types

Browse source 
# is reserved by the swagger validator as a way to include partial content from a JSON object (eg: "#/path" would include {"test": true} from the object {"path":{"test":true}}). Instead of trying to convince the validator that it is wrong, we'll just use a different character.

Note that our rendering tools do not care about #-style references to objects. It's still somewhat worth changing the character though.
This commit is contained in:
Travis Ralston 2019-05-29 15:23:45 -06:00
parent c25afa663e
commit d6d74c4cbe
37 changed files with 29 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

16
scripts/templating/matrix_templates/sections.py
View file

@ -115,7 +115,7 @@ class MatrixSections(Sections):
schemas = self.units.get("event_schemas")
renders = {}
for event_type in schemas:
underscored_event_type = event_type.replace(".", "_").replace("#", "_")
underscored_event_type = event_type.replace(".", "_").replace("$", "_")
renders[underscored_event_type + "_event"] = self._render_events(
lambda x: x == event_type, sorted
)
@ -125,7 +125,7 @@ class MatrixSections(Sections):
def filterFn(eventType):
return (
eventType.startswith("m.room") and
not eventType.startswith("m.room.message#m.")
not eventType.startswith("m.room.message$m.")
)
return self._render_events(filterFn, sorted)
@ -138,22 +138,22 @@ class MatrixSections(Sections):
]["subtitle"]
sections = []
msgtype_order = [
"m.room.message#m.text", "m.room.message#m.emote",
"m.room.message#m.notice", "m.room.message#m.image",
"m.room.message#m.file"
"m.room.message$m.text", "m.room.message$m.emote",
"m.room.message$m.notice", "m.room.message$m.image",
"m.room.message$m.file"
]
excluded_types = [
# We exclude server notices from here because we handle them in a
# dedicated module. We do not want to confuse developers this early
# in the spec.
"m.room.message#m.server_notice",
"m.room.message$m.server_notice",
]
other_msgtypes = [
k for k in schemas.keys() if k.startswith("m.room.message#") and
k for k in schemas.keys() if k.startswith("m.room.message$") and
k not in msgtype_order and k not in excluded_types
]
for event_name in (msgtype_order + other_msgtypes):
if not event_name.startswith("m.room.message#m."):
if not event_name.startswith("m.room.message$m."):
continue
sections.append(template.render(
example=examples[event_name][0],

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

@ -795,7 +795,7 @@ class MatrixUnits(Units):
if not filename.startswith("m."):
continue
event_name = filename.split("#")[0]
event_name = filename.split("$")[0]
filepath = os.path.join(path, filename)
logger.info("Reading event example: %s" % filepath)
try: