Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document why /state_ids can respond with a 404 #1521

Merged
merged 5 commits into from
May 31, 2023
Merged

Document why /state_ids can respond with a 404 #1521

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b2e4318
Document why /state_ids can respond with a 404
MadLittleMods May 12, 2023
6ed4d10
Remove stray backtick
MadLittleMods May 12, 2023
b4f1f43
More clear
MadLittleMods May 12, 2023
9c75d7c
Add changelog
MadLittleMods May 30, 2023
8e9a830
Forgot 'not'
MadLittleMods May 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/server_server/newsfragments/1521.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document why `/state_ids` can respond with a 404.
11 changes: 11 additions & 0 deletions data/api/server-server/events.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,17 @@ paths:
type: string
example: ["$an_event:example.org"]
required: ['auth_chain_ids', 'pdu_ids']
404:
description: |-
The given `event_id` was not found or the server doesn't know about the state at
that event to return anything useful.
examples:
application/json: {
"errcode": "M_NOT_FOUND",
"error": "Could not find event $Rqnc-F-dvnEYJTyHq_iKxU2bZ1CI92-kuZq3a5lr5Zg"
}
Comment on lines +145 to +148
Copy link
Contributor Author

@MadLittleMods MadLittleMods May 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't actually experienced this response personally (because I'm not a server to observe) but Synapse does error with these in the logs:

SynapseError: 404 - State not known at event $-04o8ieIyqp4uhGC1u3RbrW_991wYR3Tp3jqeVLUAAM
SynapseError: 404 - Could not find event $2k0rFR9Msehfk9bNCWo3eTvT1QQUwEgOXlVsQ_FNEhM

schema:
"$ref": "../client-server/definitions/errors/error.yaml"
"/event/{eventId}":
get:
summary: Get a single event
Expand Down