From 396575977afcf060b63adb3187a8647e979ed973 Mon Sep 17 00:00:00 2001 From: Charlotte Sackett Date: Thu, 6 Feb 2025 16:04:08 -0500 Subject: [PATCH] Updating API User's Guide Updating API User's Guide per https://gdc-ctds.atlassian.net/browse/DOC-229 --- .secrets.baseline | 6 +++--- docs/API/Users_Guide/Search_and_Retrieval.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.secrets.baseline b/.secrets.baseline index 8f4e08b3..e3d1101e 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -144,7 +144,7 @@ "filename": "docs/API/Users_Guide/Search_and_Retrieval.md", "hashed_secret": "6b505580b5bc4fab5bd4b2e0e10d621fea0614ee", "is_verified": false, - "line_number": 475, + "line_number": 468, "is_secret": false }, { @@ -152,7 +152,7 @@ "filename": "docs/API/Users_Guide/Search_and_Retrieval.md", "hashed_secret": "98895ba87fa2e568b0f48b1afbddb9b45d8c8ec3", "is_verified": false, - "line_number": 519, + "line_number": 512, "is_secret": false }, { @@ -373,5 +373,5 @@ } ] }, - "generated_at": "2024-09-19T19:16:13Z" + "generated_at": "2025-02-06T21:01:04Z" } diff --git a/docs/API/Users_Guide/Search_and_Retrieval.md b/docs/API/Users_Guide/Search_and_Retrieval.md index b68d55f3..8d248963 100644 --- a/docs/API/Users_Guide/Search_and_Retrieval.md +++ b/docs/API/Users_Guide/Search_and_Retrieval.md @@ -3097,7 +3097,7 @@ The GDC API supports the use of the wildcard character, an asterisk (\*), in the ## Quicksearch Endpoint -The GDC Portal has a quicksearch functionality that allows for a project, case, or file to be queried from a search box. This function calls the `/v0/all` endpoint, which retrieves the top cases, files, and projects that match to the query. The quicksearch can also be used programmatically through the API. For example, a search term of 'TCGA' would produce the following query: +The GDC Portal has a quicksearch functionality that allows for a project, case, or file to be queried from a search box. This function calls the `/v0/all` endpoint, which retrieves the top cases, files, projects, genes, mutations, and annotations that match to the query. The quicksearch can also be used programmatically through the API. For example, a search term of 'TCGA' would produce the following query: === "Shell"