hasura/graphql-engine

docs: add page with action examples

Open

#4,713 创建于 2020年5月8日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)TypeScript (31,371 star) (2,787 fork)batch import
c/actionsc/docshelp wanted

描述

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

贡献者指南

技术栈
graphqlrest api
领域
documentationapi
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Hasura actionsGraphQLMarkdown
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
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