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.

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

[core] Add "Document" query field, returning any document with given ID #2033

Merged
merged 1 commit into from
Oct 1, 2020

Conversation

rexxars
Copy link
Member

@rexxars rexxars commented Oct 1, 2020

Type of change (check at least one)

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation (fix or update to documentation)
  • Maintenance
  • Other, please describe:

Does this change require a documentation update? (Check one)

  • Yes
  • No

Current behavior

Currently you have to know which type a document is before querying for it with a DocumentTypeName query.

Description

This PR introduces a Document field (matches the interface name, is a reserved type for Sanity Studio, and matches the other DocumentTypeName queries). It has the same, single argument of a document ID, and has the return type of Document, which means you'll have to use conditional fragments to query on non-document properties.

In time we should also see if we can make some kind of psuedo-filter for all types, which would allow allDocument(...), but that's a much larger task.

Note for release

  • Introduce new Document field on GraphQL APIs for fetching any document by ID.

Checklist

  • I have read the Contributing Guidelines
  • The PR title includes a link to the relevant issue
  • The PR title is appropriately formatted: [some-package] PR title (#123)
  • The code is linted
  • The test suite is passing
  • Corresponding changes to the documentation have been made

@rexxars rexxars requested a review from saasen October 1, 2020 15:58
@vercel
Copy link

vercel bot commented Oct 1, 2020

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/sanity-io/test-studio/pqwhlywd2
✅ Preview: https://test-studio-git-graphql-document-field.sanity-io.vercel.app

Copy link
Contributor

@saasen saasen left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants