Skip to content

GraphQL Backend

Anuj Verma edited this page Apr 17, 2020 · 9 revisions

Each each entity, GraphQL backend is expected to expose all attributes and relationships.

For each foreign key, expose a method with same name (without "_id"), which exposes the associated object.

For each "1-M" relationship, expose a pluralized method named after the related entity. It should return an array of objects.

Fot enums stored as "int", expose a method that return enum mapping.

In case for any entity, a custom method is required, it shall be explicity mentioned in corresponding github issue.

**NOTE: ** Each attribute in GraphQL needs to have:

  • data type defined
  • marked as required or optional

Example: For "users" following attributes will be exposed:

  • org (Organization entity attributes)
  • name
  • email
  • display_name
  • profile_image_url
  • status
  • role (Role object attributes)
  • timezone
  • hi_5_quota_balance
  • created_on
  • updated_on
  • updated_by (User object)
Clone this wiki locally