hasura / hasura/graphql-engine

Document /v1/query api

Open
#8,997 0 comments 0 reactions 0 assignees View on GitHub
k/enhancement
Dominant language
TypeScript
Stars
32.1k
Forks
3k
PR merge metrics
PR metrics pending

Description

### Is your proposal related to a problem?

The console uses the /v1/query api to fetch and modify rows. This api is not documented.

**Note** this is not about the use of `run_sql` used for things like fetching information on database structure. That uses the `/v2/query` api.

### Describe the solution you'd like

The api should be documented.

### Describe alternatives you've considered

Alternatively, the use of this api should be deprecated alongside the api itself.

This is tracked in #8986

Contributor guide

Open the contributing guide

Research direction

Start by reviewing how the console uses the /v1/query API to fetch and modify rows, and compare that scope with the /v2/query distinction described in the issue. Check the related tracking issue #8986 before starting. Done means the /v1/query behavior is documented, or its deprecation status is clarified.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.