lablup / lablup/backend.ai

Improve REST & GraphQL response readability

Open
#3,431 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
670
Forks
183
Avg merge
17h 7m
Merged PRs (30d)
358

Description

## Motivation  

- To enable more detailed error handling of GQL mutation failures on the frontend, the current method of relying on `ok` and `msg` needs to be improved.
- Not only must the return type of all GQL mutations be modified, but the corresponding SDK, WebUI, and Control Panel logic that utilizes them also need to be updated.

## Objective

- Improve GQL mutation's common return type
- Improve GQL Mutation exception handling Logic on the Client Side
- The issue itself is relatively easy in complexity, but since this change introduces a big breaking change, care must be taken to avoid conflicts with the client side.

## Expected Sub Issue

- Remove `ok`, `msg` from the current codebase’s GQL mutations.
- Raise `GraphQLError` instead of using `ok`, `msg`.

JIRA Issue: BA-498

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.