Skip to content

GET /_matrix/federation/v1/query/profile response violates OpenAPI schema #18442

Open
@harri-han

Description

@harri-han

https://spec.matrix.org/v1.11/server-server-api/#get_matrixfederationv1queryprofile states that the response fields avatar_url and displayname shall be either string valued or omitted altogether, but never null.

The code at https://github.com/element-hq/synapse/blob/44ae5362fd952dbb209f4b52ee9c96641163f032/synapse/handlers/profile.py#L539C1-L546C1 however leaks through NULL values from the SQL database and so may result in null values being emitted in the JSON response where none are allowed by the OpenAPI schema.

A trival fix would be to simply add is not None if-clauses before setting the respective key in the response: JsonDict, i.e. something along the lines of

         response: JsonDict = {}
         try:
             if just_field is None or just_field == ProfileFields.DISPLAYNAME:
                tmp = await self.store.get_profile_displayname(user)
                if tmp is not None:
                    response["displayname"] = tmp
             if just_field is None or just_field == ProfileFields.AVATAR_URL:
                tmp = await self.store.get_profile_avatar_url(user)
                if tmp is not None:
                    response["avatar_url"] = tmp

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions