Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add dedicated version and health api docs pages #3482

Merged
merged 3 commits into from
Dec 15, 2019
Merged

add dedicated version and health api docs pages #3482

merged 3 commits into from
Dec 15, 2019

Conversation

rikinsk
Copy link
Member

@rikinsk rikinsk commented Dec 4, 2019

Description

Affected components

  • Server
  • Console
  • CLI
  • Docs
  • Community Content
  • Build System
  • Tests
  • Other (list it)

Related Issues

Solution and Design

Server checklist

Catalog upgrade

Does this PR change Hasura Catalog version?

  • No
  • Yes
    • Updated docs with SQL for downgrading the catalog

Metadata

Does this PR add a new Metadata feature?

  • No
  • Yes
    • Does run_sql auto manages the new metadata through schema diffing?
      • Yes
      • Not required
    • Does run_sql auto manages the definitions of metadata on renaming?
      • Yes
      • Not required
    • Does export_metadata/replace_metadata supports the new metadata added?
      • Yes
      • Not required

GraphQL

  • No new GraphQL schema is generated
  • New GraphQL schema is being generated:
    • New types and typenames are correlated

Breaking changes

  • No Breaking changes

  • There are breaking changes:

    1. Metadata API

      Existing query types:

      • Modify args payload which is not backward compatible
      • Behavioural change of the API
      • Change in response JSON schema
      • Change in error code

    2. GraphQL API

      Schema Generation:

      • Change in any NamedType
      • Change in table field names

      Schema Resolve:-

      • Change in treatment of null value for any input fields

    3. Logging

      • Log JSON schema has changed
      • Log type names have changed

Steps to test and verify

Limitations, known bugs & workarounds

@rikinsk rikinsk added the c/docs Related to docs label Dec 4, 2019
@netlify
Copy link

netlify bot commented Dec 4, 2019 •
edited
Loading

Deploy preview for hasura-docs ready!

Built with commit 71ec6dc

https://deploy-preview-3482--hasura-docs.netlify.com

marionschleifer
marionschleifer requested changes Dec 4, 2019
View reviewed changes
Copy link
Contributor

@marionschleifer marionschleifer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

docs/graphql/manual/api-reference/version.rst Outdated Show resolved Hide resolved
@rikinsk @marionschleifer
Update docs/graphql/manual/api-reference/version.rst
a91f247 
Co-Authored-By: Marion Schleifer <marion@hasura.io>
@rikinsk rikinsk merged commit 2264db6 into hasura:master Dec 15, 2019
@hasura-bot
Copy link
Contributor

Review app https://hge-ci-pull-3482.herokuapp.com is deleted

@rikinsk rikinsk deleted the docs-api-ref branch December 15, 2019 13:00
polRk pushed a commit to polRk/graphql-engine that referenced this pull request Feb 12, 2020
@rikinsk @polRk
add dedicated version and health api docs pages (hasura#3482)
a532711
@sumodgeorge sumodgeorge mentioned this pull request Nov 28, 2023
Open
@Allymahmoud Allymahmoud mentioned this pull request Nov 28, 2023
Open
@ptakpatryk ptakpatryk mentioned this pull request Dec 19, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@marionschleifer marionschleifer marionschleifer approved these changes

Assignees
No one assigned
Labels
c/docs Related to docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rikinsk @hasura-bot @marionschleifer