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

Discovery API: update docs #3894

Merged
merged 71 commits into from
Aug 15, 2023
Merged

Conversation

eddowh
Copy link
Contributor

@eddowh eddowh commented Aug 9, 2023

What are you changing in this pull request and why?

I'm updating the docs of Discovery API because we have breaking changes to the API and we need to update the docs to better reflect the current state of our API, since the docs point to legacy endpoints we plan to deprecate soon.

  • update use case queries to use bigints and new apis
  • update other queries to use bigints and new apis
  • docs parity with legacy vs new endpoints
  • fix bug where schemas and types weren't retrieved properly
  • update or remove screenshots (we're keeping it)
  • verify that Python code works (no bandwidth -- if it breaks it breaks, not the most urgent for getting docs out)

Some common mistakes I found while going through each query and executing it to make sure it's valid.

  • Fields were snake_case when they should be camelCase
  • Typos in filters and fields
  • Nested nodes were not updated so ... on syntaxes were invalid
  • Querying non-nested-allowed fields of a nested node, like children, tests, etc.

Checklist

  • Review the Content style guide and About versioning so my content adheres to these guidelines.
  • Add a checklist item for anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

(Below might be a separate PR, but leaving it for now)

Adding new pages (delete if not applicable):

  • Add page to website/sidebars.js
  • Provide a unique filename for the new page

Removing or renaming existing pages (delete if not applicable):

  • Remove page from website/sidebars.js
  • Add an entry website/static/_redirects
  • Ran link testing to update the links that point to the deleted page

@eddowh eddowh self-assigned this Aug 9, 2023
@welcome
Copy link

welcome bot commented Aug 9, 2023

Hello!👋 Thanks for contributing to the dbt product documentation and opening this pull request! ✨
We use Markdown and some HTML to write the dbt product documentation. When writing content, you can use our style guide and content types to understand our writing standards and how we organize information in the dbt product docs.
We'll review your contribution and respond as soon as we can. 😄

@netlify
Copy link

netlify bot commented Aug 9, 2023

Deploy Preview for docs-getdbt-com ready!

Name Link
🔨 Latest commit bb7f63d
🔍 Latest deploy log https://app.netlify.com/sites/docs-getdbt-com/deploys/64dbdbd0532d390008e8efb2
😎 Deploy Preview https://deploy-preview-3894--docs-getdbt-com.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions github-actions bot added new contributor Label for first-time contributors content Improvements or additions to content size: large This change will more than a week to address and might require more than one person labels Aug 9, 2023
@eddowh eddowh force-pushed the meta-1482/update-discovery-api-docs branch from cd62a71 to 7eec141 Compare August 9, 2023 00:18
@runleonarun runleonarun enabled auto-merge (squash) August 15, 2023 19:07
@runleonarun runleonarun merged commit 795d743 into current Aug 15, 2023
6 checks passed
@runleonarun runleonarun deleted the meta-1482/update-discovery-api-docs branch August 15, 2023 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto update content Improvements or additions to content new contributor Label for first-time contributors size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants