digitalocean / digitalocean/api-v2

Document all possible Id's and Message for API errors/unsuccessful's scenarios

Open
#74 5 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
No language data
Stars
138
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Documentation doesn't reflect the v2 API behavior. Which is correct one?

**[As per document](https://developers.digitalocean.com/#statuses)**

HTTP/1.1403 Forbidden

{
"error": "forbidden",
"description": "You do not have access for the attempted action."
}

**My v2 API client development interaction/testing**



Http Code 404: This is for incorrect REST resource URL scenario
{
"id": "not_found",
"message": "The resource you were accessing could not be found."
}

http code 422: This is for unique name exception while domain creation
{
"id":"unprocessable_entity",
"message":"Name has already been taken"
}

Http Code 401: This is for incorrect token & read-only access token performing write operation
{
"id":"unauthorized",
"message":"Unable to authenticate you."
}

- First thing response structure is incorrect as per document
- **_For read-only access token performing write operation:**_ I should be getting 403 with message; either one format. But API is responding with Http code 401 & saying unauthorized.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.