Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions development_notes/meetings.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
draft field — likely not needed (but we will need internal deployments)

tags -> keywords
> Update (06/09/2023): Removed `status` and `tags` per our discussion [here](https://github.com/Ensembl/ensembl-website-help-and-docs/pull/59#discussion_r1314847058)

references
- get from api
Expand Down
48 changes: 48 additions & 0 deletions docs/about-ensembl/accessing-data/apis/graphql.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
slug: about-graphql
title: About Ensembl GraphQL service
description: Information about Ensembl's GraphQL service
---
# Ensembl GraphQL service

Ensembl offers access to its data via a GraphQL service, allowing you to access the data you want by tailoring the responses from the service.

## What is GraphQL?

GraphQL is a query language. GraphQL services typically have one end point (as opposed to REST APIs which have multiple end points), and they allow you to specify exactly what data is returned to you.

For example, the following query requests the `symbol` of a particular gene based on its `stable_id`.

```json
query{
gene(by_id: {
genome_id: "<insert valid genome ID>",
stable_id: "ENSG00000101384.12"})
{
symbol
}
}

```
The JSON results contain only the symbol as requested.
```json
{
"data": {
"gene": {
"symbol": "JAG1"
}
}
}
```

Additional information about GraphQL can be found on the [official GraphQL site](https://graphql.org/).

## Why is Ensembl using GraphQL?

GraphQL offers flexibility through allowing you to specify the data that are returned from each query. This reduces superfluous data transmission and, coupled with the graph traversal inherent to GraphQL, will provide a method of exploring and extracting the elements of the connected data offered by Ensembl. The Ensembl project believes that this will be an improvement to the experience offered by REST APIs.

Ensembl's new website also utilises the GraphQL services offered to the public, ensuring consistency of data across the project.


## Documentation
If you wish to interrogate the service and explore the documentation, a GraphQL [playground](/data/graphql) can be accessed via your browser.
2 changes: 2 additions & 0 deletions docs/about-ensembl/accessing-data/apis/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: GraphQL
href: graphql.md
2 changes: 2 additions & 0 deletions docs/about-ensembl/accessing-data/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: APIs
href: apis/toc.yml
2 changes: 2 additions & 0 deletions docs/about-ensembl/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@
href: annotation-and-prediction/toc.yml
- name: Legal & privacy
href: legal-and-privacy/toc.yml
- name: Accessing data
href: accessing-data/toc.yml
3 changes: 0 additions & 3 deletions docs/ensembl-help/getting-started/ensembl-website-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ description: Here is how to use the apps in Ensembl
related_articles:
- href: ../using-ensembl/ensembl-apps/entity-viewer/entity-viewer.md
- href: ../using-ensembl/ensembl-apps/genome-browser/browser.md
tags:
- gene
status: draft
---

# How to get started with the Ensembl website
Expand Down
3 changes: 0 additions & 3 deletions docs/ensembl-help/getting-started/gene-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ description: Here is how to find out about a gene
related_articles:
- href: ../using-ensembl/ensembl-apps/entity-viewer/entity-viewer.md
- href: ../using-ensembl/ensembl-apps/genome-browser/browser.md
tags:
- gene
status: draft
---

# Find out about a gene
Expand Down
3 changes: 0 additions & 3 deletions docs/ensembl-help/getting-started/protein-info.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ description: Here is how to find out about a protein
related_articles:
- href: ../using-ensembl/ensembl-apps/entity-viewer/entity-viewer.md
- href: ../using-ensembl/ensembl-apps/genome-browser/browser.md
tags:
- protein
status: draft
---

# Get protein information
Expand Down
3 changes: 0 additions & 3 deletions docs/ensembl-help/getting-started/sequences.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ related_articles:
- href: ../using-ensembl/the-basics/sequence-download.md
- href: ../using-ensembl/ensembl-apps/entity-viewer/entity-viewer.md
- href: ../using-ensembl/ensembl-apps/genome-browser/browser.md
tags:
- sequence
status: draft
---

# How to download sequences
Expand Down
3 changes: 0 additions & 3 deletions docs/ensembl-help/getting-started/species.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,6 @@ title: Choosing a species to work with
description: Here is how to select a species
related_articles:
- href: ../using-ensembl/ensembl-apps/species-selector/species-selector-intro.md
tags:
- gene
status: draft
---

# Choosing a species genome to work with
Expand Down
3 changes: 0 additions & 3 deletions docs/ensembl-help/getting-started/using-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ description: Here is how to use the apps in Ensembl
related_articles:
- href: ../using-ensembl/ensembl-apps/entity-viewer/entity-viewer.md
- href: ../using-ensembl/ensembl-apps/genome-browser/browser.md
tags:
- gene
status: draft
---
# Using the Ensembl apps

Expand Down
3 changes: 0 additions & 3 deletions docs/ensembl-help/using-ensembl/ensembl-apps/blast/blast.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
slug: blast
title: How to run BLAST
description: How to run BLAST queries
tags:
- blast
status: draft
---

# How to run BLAST
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ related_articles:
- href: gene-function.md
- href: overview.md
- href: external-references.md
tags:
- entity
status: draft
---

# What is the Entity viewer?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ related_articles:
- href: transcripts.md
- href: gene-function.md
- href: overview.md
tags:
- entity
status: draft
---

# What’s in the external references tab?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ related_articles:
- href: transcripts.md
- href: overview.md
- href: external-references.md
tags:
- entity
status: draft
---

# What’s in the gene function panel?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
slug: looking-at-genes-and-transcripts
title: Looking at genes and transcripts
description: Overview of Ensembl genome browser
tags:
- genes
- transcripts
status: draft
---

# Looking at genes and transcripts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ related_articles:
- href: transcripts.md
- href: gene-function.md
- href: external-references.md
tags:
- entity
status: draft
---

# What’s in the overview panel?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ related_articles:
- href: gene-function.md
- href: overview.md
- href: external-references.md
tags:
- entity
status: draft
---

# What’s in the Transcript panel?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ related_articles:
- href: navigation.md
- href: tracks.md
- href: focus-entity.md
tags:
- browser
status: draft
---

# What is the Genome browser?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,6 @@ related_articles:
- href: browser.md
- href: navigation.md
- href: tracks.md
tags:
- browser
status: draft
---

# What is a Focus entity?
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ related_articles:
- href: browser.md
- href: tracks.md
- href: focus-entity.md
tags:
- browser
status: draft
---

# Genome browser navigation
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ related_articles:
- href: navigation.md
- href: browser.md
- href: focus-entity.md
tags:
- browser
status: draft
---

# Tracks in the Genome browser
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@
slug: species-homepage
title: Species homepage
description: How to navigate the species homepage
tags:
- species homepage
status: draft
---

# Species homepage
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,8 @@
slug: species-selector
title: How do I add or remove a species?
description: How to select a species and genome assembly of interest to visualise in the Genome browser and Entity viewer
tags:
- species selector
related_articles:
- href: species-homepage.md
status: draft
---

# How do I add or remove a species?
Expand Down
2 changes: 2 additions & 0 deletions docs/ensembl-help/using-ensembl/getting-ensembl-data/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Tools and APIs
href: tools-and-apis/toc.yml
Loading