mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-17 04:24:35 +03:00
a21f6cd648
Changes compared to `/v1alpha1/graphql` * Changed all graphql responses in **/v1/graphql** endpoint to be 200. All graphql clients expect responses to be HTTP 200. Non-200 responses are considered transport layer errors. * Errors in http and websocket layer are now consistent and have similar structure.
37 lines
833 B
ReStructuredText
37 lines
833 B
ReStructuredText
GraphQL API Reference
|
|
=====================
|
|
|
|
.. contents:: Table of contents
|
|
:backlinks: none
|
|
:depth: 1
|
|
:local:
|
|
|
|
All GraphQL requests for queries, subscriptions and mutations are made to the GraphQL API.
|
|
|
|
Endpoint
|
|
--------
|
|
|
|
All requests are ``POST`` requests to ``/v1/graphql`` (or ``/v1alpha1/graphql``) endpoint.
|
|
|
|
.. note::
|
|
|
|
``/v1/graphql`` endpoint returns HTTP 200 status codes for all responses.
|
|
This is a **breaking** change from ``/v1alpha1/graphql`` behaviour, where
|
|
request errors and internal errors were responded with 4xx and 5xx status
|
|
codes.
|
|
|
|
Request types
|
|
-------------
|
|
|
|
The following types of requests can be made using the GraphQL API:
|
|
|
|
- :doc:`Query / Subscription <query>`
|
|
- :doc:`Mutation <mutation>`
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:hidden:
|
|
|
|
Query / Subscription <query>
|
|
Mutation <mutation>
|