Skip to content

Improvement README.md #1

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 37 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,44 @@ GraphQL Types and interfaces for great response. The library provides types for
- Detailed error information including uuid, description, code, message and stacktrace
- Stacktrace can be disabled in any time. Example: production mode

**Success response:**

![image](https://i.ibb.co/BgXh0sC/photo-2021-11-24-16-55-43.jpg)

**Error response:**
**Example success response:**

```json
{
"data": {
"users": {
"createUser": {
"data": {
"id": "b9bec407-7f65-4586-869c-4d72b85c7624",
"name": "tema"
},
"error": null
}
}
}
}
```

![image](https://i.ibb.co/vzVJstR/photo-2021-11-24-16-57-17.jpg)
**Example error response:**

```json
{
"data": {
"users": {
"getUser": {
"data": null,
"error": {
"id": "c1b2e2fc-348a-4f14-96e0-5c196bf8e149",
"message": "USER_NOT_FOUND",
"code": 404,
"description": "User not found with id 6cb26c8d-f6ab-4b7f-9bfa-f6703cbc17e2",
"stack": null
}
}
}
}
}
```

## Installation

Expand Down