matrix-org / matrix-org/matrix-spec

Inconsistent OpenAPI titles

Open
#827 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

A-Tools aesthetic
Dominant language
HTML
Stars
330
Forks
150
Avg merge
2h 21m
Merged PRs (30d)
3

Description

The OpenAPI titles in data/api/ and data/schemas/ are suitable to use as class names in auto-generated code (after transformations such as remove spaces). They look like this (random selection):
```
Device List Update
KeyObject
PDU Processing Result
Account Data
Field Type
Event Container
Signatures
PaginationChunk
AssociatedMappings
ToDevice
CreationContent
ConnectionInfo
Membership Event Content
Groups
Results
```

Most titles in data/event-schemas/schema/ are similar. These titles are the exceptions:
```
Accepted Terms of Service URLs
An invitation to a room issued to a third party identifier, rather than a matrix user ID.
Controls visibility of history.
Controls whether guest users are allowed to join rooms.
Defines the power levels (privileges) of users in the room.
Describes how users are allowed to join the room.
Indication that the room has been upgraded.
Informs the room as to which alias is the canonical one.
Pinned events in a room
The current membership state of a user in the room.
The first event in the room.
```

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the OpenAPI title fields in data/api/, data/schemas/, and data/event-schemas/schema/, comparing the listed exceptions with the surrounding titles. Update the inconsistent titles so they are suitable for use as class names after normal transformations, then verify that the affected titles follow the same convention as the others.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.