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

RFC: V3 add descriptions to open dd objects #10117

Closed
wants to merge 1 commit into from
Closed

RFC: V3 add descriptions to open dd objects #10117

wants to merge 1 commit into from

Conversation

codingkarthik
Copy link
Contributor

@codingkarthik codingkarthik commented Jan 25, 2024 •
edited
Loading

Description

Rendered

Changelog

Component : server / cli / console / build

Type: bugfix / feature / enhancement

Product: community-edition

Short Changelog

Long Changelog

Related Issues

Solution and Design

Steps to test and verify

Limitations, known bugs & workarounds

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

@codingkarthik codingkarthik requested a review from a team as a code owner January 25, 2024 09:21
@codingkarthik codingkarthik changed the title rfc: add descriptions to open dd objects rfc: V3 add descriptions to open dd objects Jan 25, 2024
@codingkarthik codingkarthik changed the title rfc: V3 add descriptions to open dd objects RFC: V3 add descriptions to open dd objects Jan 25, 2024
hasura-bot added a commit that referenced this pull request Jan 29, 2024
@hasura-bot @codingkarthik
rfc: add descriptions to open dd objects
7fac541 
GITHUB_PR_NUMBER: 10117
GITHUB_PR_URL: #10117

PR-URL: hasura/graphql-engine-mono#10648
Co-authored-by: Karthikeyan Chinnakonda <15602904+codingkarthik@users.noreply.github.com>
GitOrigin-RevId: 2fa07eb479bb2e4dbb112dbba703a08ded87b009
@hasura-bot hasura-bot closed this Jan 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
merged
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@codingkarthik @hasura-bot