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

feat: add docs links to error responses #403

Merged
merged 3 commits into from
Jul 27, 2023
Merged

feat: add docs links to error responses #403

merged 3 commits into from
Jul 27, 2023

Conversation

MartinKolarik
Copy link
Member

@MartinKolarik MartinKolarik commented Jul 25, 2023

  • Deletes the old docs.
  • Adds links to the new docs into all error responses (logic reused from the jsDelivr API):
{
  "error": {
    "type": "validation_error",
    "message": "Parameter validation failed.",
    "params": {
      "limit": "\"limit\" must be less than or equal to 500"
    }
  },
  "links": {
    "documentation": "https://www.jsdelivr.com/docs/api.globalping.io#post-/v1/measurements"
  }
}

docs/README.md Outdated Show resolved Hide resolved
@MartinKolarik MartinKolarik changed the title Delete MD docs docs: add links to error responses Jul 25, 2023
@MartinKolarik MartinKolarik changed the title docs: add links to error responses feat: add docs links to error responses Jul 25, 2023
@MartinKolarik MartinKolarik marked this pull request as ready for review July 25, 2023 14:53
@MartinKolarik MartinKolarik merged commit 7526181 into master Jul 27, 2023
2 checks passed
@MartinKolarik MartinKolarik deleted the docs branch July 27, 2023 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants