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.

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

better API error codes handling documentation #1573

Open
wants to merge 2 commits into
base: master
from

Conversation

@scottinet
Copy link
Member

scottinet commented Feb 14, 2020

Description

Partial rewrite of the API > Essentials > Errors > Handling documentation page, to make it clearer + fix typos.

scottinet added 2 commits Feb 14, 2020
@sonarcloud

This comment has been minimized.

Copy link

sonarcloud bot commented Feb 14, 2020

Kudos, SonarCloud Quality Gate passed!

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities (and Security Hotspot 0 Security Hotspots to review)
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@codecov

This comment has been minimized.

Copy link

codecov bot commented Feb 14, 2020

Codecov Report

Merging #1573 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1573   +/-   ##
=======================================
  Coverage   93.69%   93.69%           
=======================================
  Files         102      102           
  Lines        6898     6898           
=======================================
  Hits         6463     6463           
  Misses        435      435

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 6f31ddb...eda5aaa. Read the comment docs.

@Aschen
Aschen approved these changes Feb 14, 2020
Copy link
Contributor

Aschen left a comment

I know it's not related to that PR but if you want/have time there is an issue actually because Algolia doesn't index the complete subcode list because the page is too big and it has to be chunked

Copy link
Member

alexandrebouthinon left a comment

Much clearer that way 👍

Clients can detect the error type based on the `status` and process the error accordingly.
| `status` | <pre>number</pre> | HTTP status code |
| `message` | <pre>string</pre> | Short description of the error |
| `stack` | <pre>string</pre> | (Available in development mode only) Error stack trace |

This comment has been minimized.

Copy link
@alexandrebouthinon

alexandrebouthinon Feb 15, 2020

Member

Formatting suggestion

Suggested change
| `stack` | <pre>string</pre> | (Available in development mode only) Error stack trace |
| `stack` | <pre>string</pre> | Error stack trace (Available in development mode only) |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.