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 (2,787 forks)batch import
c/actionsc/docshelp wanted

Repository metrics

Stars
 (31,371 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the existing actions documentation to understand the format and then create examples covering different use cases, response types, relationships, local instances, and URL templating.
Tech stack
typescript
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85