[DGR-2399] Update errors section #116
Merged
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
- Simplify v1/v2 documentation to unified approach focusing on common patterns - Document real bulk operation differences between API versions - Update OpenAPI schemas to match current controller implementations - V1 bulk: all-or-nothing with ActiveRecord error arrays - V2 bulk: mixed results with structured errors and 207 Multi-Status Fixes documentation accuracy and reduces developer confusion.
Deploying accredible-api-documentation with
|
| Latest commit: |
12be98b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://2e20ca7d.accredible-api-documentation.pages.dev |
| Branch Preview URL: | https://docs-dgr-2399-update-errors.accredible-api-documentation.pages.dev |
fb387e3 to
43633c1
Compare
43633c1 to
12be98b
Compare
albertpaulp
approved these changes
Aug 18, 2025
There was a problem hiding this comment.
@sandilya91 Our Public API Errors are not standardized. Were you able to verify that these structures are correct?
abhisheksarka
approved these changes
Aug 18, 2025
@abhisheksarka Yeah so went through this document https://accredible.atlassian.net/wiki/x/BYBY8g along with API responses from our accredible-credential-api repo. The context was one of the clients wanted more information on our errors so tried to provide example responses for each HTTP status code as possible |
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.
Updated the Public API documentation errors section to accurately reflect the current error response formats found in the codebase and in this documentation https://accredible.atlassian.net/wiki/x/BYBY8g
Current Errors page:
https://docs.api.accredible.com/#section/Errors
New Errors page:
https://2e20ca7d.accredible-api-documentation.pages.dev/#section/Errors
Ordered in ascending order of HTTP status code