Skip to content

[gql] Add boolean endpoint for whether a location has integrated docs #29216

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

Merged
merged 2 commits into from
Apr 11, 2025

Conversation

benpankow
Copy link
Member

@benpankow benpankow commented Apr 11, 2025

Summary

Adds a boolean hasLocationDocs endpoint which returns whether a location has integrated docs. Nested under GrapheneRepository, along with moving the endpoint from #29167

How I Tested These Changes

Update unit test.

@benpankow
Copy link
Member Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link

github-actions bot commented Apr 11, 2025

Deploy preview for dagit-core-storybook ready!

✅ Preview
https://dagit-core-storybook-934u0d75w-elementl.vercel.app
https://benpankow-gql-has-docs.core-storybook.dagster-docs.io

Built with commit 58a024a.
This pull request is being automatically deployed with vercel-action

@OwenKephart
Copy link
Contributor

seems fine but what's the point of this vs. just querying for the docs directly and seeing if you get anything back?

@hellendag
Copy link
Member

seems fine but what's the point of this vs. just querying for the docs directly and seeing if you get anything back?

For the list view of code locations (/deployment/locations), I'd rather not query for the entire JSON blob for every location when I just need to know whether to render a link to the docs. Similarly, when I'm rendering the tabs on the code location overview page, I just need a boolean to know whether to render/enable/disable the tab.

@hellendag hellendag merged commit 508cca6 into master Apr 11, 2025
7 checks passed
@hellendag hellendag deleted the benpankow/gql-has-docs branch April 11, 2025 16:50
benpankow added a commit that referenced this pull request Apr 11, 2025
## Summary

Fixes dg docs test, which #29216 broke (offending test didn't trigger on
branch)
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.

3 participants