Fix error in API errors article regarding RFC 9457 [CUS-177] #24
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![devin-ai-integration[bot]](https://avatars.githubusercontent.com/in/811515?s=60&v=4){kind=small}
Co-Authored-By: Nolan Sullivan <[email protected]>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix error in API errors article regarding RFC 9457
This PR corrects an error in the Speakeasy article about API errors. The article incorrectly refers to 'title' and 'description' when discussing RFC 9457, but the RFC actually defines 'title' and 'detail' (not 'description').
Additionally, adds clarification about how the title should be the same for all responses with the same type, while the detail can include specifics about the problem instance/occurrence.
Fixes: CUS-177 (https://linear.app/speakeasy/issue/CUS-177)
Link to Devin run: https://app.devin.ai/sessions/27fef5b9d8054bf78a58d06b18498291
Requested by: Nolan Sullivan ([email protected])