hasura/graphql-engine

docs: add page with action examples

Open

#4 713 ouverte le 8 mai 2020

Voir sur GitHub
 (5 commentaires) (0 réactions) (0 assignés)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

Guide contributeur

Stack technique
graphqlrest api
Domaine
documentationapi
Type d'issue
documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 hours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
Hasura actionsGraphQLMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70
Direction de recherche
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.