API docs show incorrect example error responses
Open
Nobody has claimed this yet.
bug
- Dominant language
- Shell
- Stars
- 96
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Preflight checklist
- I could not find a solution in the existing issues, docs, nor discussions.
- I agree to follow this project's Code of Conduct.
- I have read and am following this repository's Contribution Guidelines.
- I have joined the Ory Community Slack.
- I am signed up to the Ory Security Patch Newsletter.
Ory Network Project
Describe the bug
It seems the only error example available, no matter the status code, is always a 404. Seems to me that it's not just a 404 that's available.
Reproducing the bug
- Go to https://www.ory.sh/docs/reference/api#tag/identity/operation/listIdentities (for example)
- Click error code buttons and note the difference between status codes.
Relevant log output
Relevant configuration
Version
Not relevant
On which operating system are you observing this issue?
None
In which environment are you deploying?
None
Additional Context
No response
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the Identity API reference page linked in the issue and compare the error-code buttons with their displayed examples. Done means each documented status code shows the corresponding error response rather than the same 404 example.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100