hasura/graphql-engine

docs: add page with action examples

Open

#4.713 geöffnet am 8. Mai 2020

Auf GitHub ansehen
 (5 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)TypeScript (31.371 Stars) (2.787 Forks)batch import
c/actionsc/docshelp wanted

Beschreibung

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
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
stale
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
clear
Voraussetzungen
Hasura actionsGraphQLMarkdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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.