Skip to content

Commit

Permalink
Update sl-graphql.md (#3914)
Browse files Browse the repository at this point in the history
Update with some of Will's graphql content

## What are you changing in this pull request and why?
<!---
Adding more documentation to graphql (not public yet but also released)

To learn more about the writing conventions used in the dbt Labs docs,
see the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md).
-->

## Checklist
<!--
Uncomment if you're publishing docs for a prerelease version of dbt
(delete if not applicable):
- [ ] Add versioning components, as described in [Versioning
Docs](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#versioning-entire-pages)
- [ ] Add a note to the prerelease version [Migration
Guide](https://github.com/dbt-labs/docs.getdbt.com/tree/current/website/docs/guides/migration/versions)
-->
- [ ] Review the [Content style
guide](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/content-style-guide.md)
and [About
versioning](https://github.com/dbt-labs/docs.getdbt.com/blob/current/contributing/single-sourcing-content.md#adding-a-new-version)
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."

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](https://github.com/dbt-labs/docs.getdbt.com#running-the-cypress-tests-locally)
to update the links that point to the deleted page
  • Loading branch information
mirnawong1 authored Oct 2, 2023
2 parents e86d50a + 184e874 commit d8574d0
Show file tree
Hide file tree
Showing 13 changed files with 406 additions and 53 deletions.
4 changes: 2 additions & 2 deletions website/docs/docs/build/sl-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Learn how to create your first semantic model and metric."
sidebar_label: Get started with MetricFlow
tags: [Metrics, Semantic Layer]
meta:
api_name: dbt Semantic Layer API
api_name: dbt Semantic Layer APIs
---

import InstallMetricFlow from '/snippets/_sl-install-metricflow.md';
Expand Down Expand Up @@ -85,7 +85,7 @@ You can query your metrics in a JDBC-enabled tool or use existing first-class in

You must have a dbt Cloud Team or Enterprise [multi-tenant](/docs/cloud/about-cloud/regions-ip-addresses) deployment, hosted in North America. (Additional region support coming soon)

- <span>To learn how to use the JDBC API and what tools you can query it with, refer to the <a href="https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview" target="_self">{frontMatter.meta.api_name}</a></span>.<br />
- <span>To learn how to use the JDBC or GraphQL API and what tools you can query it with, refer to the <a href="https://docs.getdbt.com/docs/dbt-cloud-apis/sl-api-overview" target="_self">{frontMatter.meta.api_name}</a></span>.<br />

* To authenticate, you need to [generate a service token](/docs/dbt-cloud-apis/service-tokens) with Semantic Layer Only and Metadata Only permissions.
* Refer to the [SQL query syntax](/docs/dbt-cloud-apis/sl-jdbc#querying-the-api-for-metric-metadata) to query metrics using the API.
Expand Down
12 changes: 4 additions & 8 deletions website/docs/docs/dbt-cloud-apis/sl-api-overview.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Semantic Layer API"
title: "Semantic Layer APIs"
id: sl-api-overview
description: "Integrate and query using the Semantic Layer API."
description: "Integrate and query metrics and dimensions in downstream tools using the Semantic Layer APIs"
tags: [Semantic Layer, API]
hide_table_of_contents: true
---
Expand Down Expand Up @@ -36,24 +36,20 @@ product="dbt Semantic Layer"
plan="dbt Cloud Team and Enterprise"
instance="hosted in North America"
/>
<br /><br />

<div className="grid--2-col">
<div className="grid--3-col">

<Card
title="JDBC API"
body="Use a JDBC driver to query metrics and dimensions in downstream tools, while also providing standard metadata functionality."
link="/docs/dbt-cloud-apis/sl-jdbc"
icon="dbt-bit"/>

<!--
commenting out until it's available
<Card
title="GraphQL API"
body="Use GraphQL to query metrics in downstream tools."
body="Use GraphQL to query metrics and dimensions in downstream tools."
link="/docs/dbt-cloud-apis/sl-graphql"
icon="dbt-bit"/>
-->

<Card
title="Semantic manifest"
Expand Down
Loading

0 comments on commit d8574d0

Please sign in to comment.