hasura/graphql-engine

docs: schema download without admin secret

Open

#5,450 opened on Jul 22, 2020

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

Description

The download schema docs should mention the differences between downloading with and without an explicit X-Hasura-Admin-Secret. E.g. the mutationType is null when the schema is downloaded without passing the admin secret.

Contributor guide

Tech stack
typescriptgraphql
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.
under 1 hour
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 documentation structureGraphQL schema basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Look at the Hasura docs page for exporting schema (https://hasura.io/docs/1.0/graphql/manual/schema/export graphql schema.html). Identify where to explain that without X Hasura Admin Secret, mutationType is null. Check issue comments for more details. Add a concise note. Ensure style matches existing docs.