hasura/graphql-engine

docs: add page with action examples

Open

#4,713 opened on May 8, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)TypeScript (31,371 stars) (2,787 forks)batch import
c/actionsc/docshelp wanted

Description

We should create a section on actions docs where we show examples.

These examples can include:

  • Different use cases
  • Different response types
    • array vs object
  • Different types of relationships
    • array vs object
  • Working with local instance of an action handler
  • URL templating of action handler

Contributor guide

Tech stack
graphqlrest api
Domain
documentationapi
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Hasura actionsGraphQLMarkdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing Hasura docs on actions (e.g., https://hasura.io/docs/latest/actions/). Identify the format and style used. Then, create examples covering the listed scenarios: different use cases, response types (array vs object), relationship types, local instance, and URL templating. Consider adding code snippets and explanations.
docs: add page with action examples · hasura/graphql-engine#4713 | Good First Issue