From 5a9667a5bd6e3f58b40629523eaf889a29eb8ae7 Mon Sep 17 00:00:00 2001 From: Amani Farooque Date: Mon, 23 Jan 2023 16:10:26 -0500 Subject: [PATCH 1/4] Add new sitelimit parameter --- _apidocs/searchgov-results.md | 1 + _apidocs/searchgov-results/v2/openapi.yml | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/_apidocs/searchgov-results.md b/_apidocs/searchgov-results.md index 9936993e9..5b9712b4a 100644 --- a/_apidocs/searchgov-results.md +++ b/_apidocs/searchgov-results.md @@ -64,6 +64,7 @@ Sites indexed via sitemaps or crawling will use the `/i14y` endpoint. Because mo | limit (optional) | Defines the number of results to return. The default is 20, but you can specify between 1 and 50 results.
Example: `limit=5` | offset (optional) | Defines the number of results you want to skip from the first result. The offset is used for implementing pagination. The default is 0 and the maximum is 999.
Example: `offset=20` | sort\_by (optional) | Allowed variables are date and relevance. The default sort is relevance. Add `sort_by=date` to sort by date. + | sitelimit (optional) | Limits the results to the subdomains and/or subfolders provided. Multiple values can be passed using a space-separated list. Example: `sitelimit=search.gov/about search.gov/get-started` ## Expected Results diff --git a/_apidocs/searchgov-results/v2/openapi.yml b/_apidocs/searchgov-results/v2/openapi.yml index f2b2acd99..1abbb54f2 100644 --- a/_apidocs/searchgov-results/v2/openapi.yml +++ b/_apidocs/searchgov-results/v2/openapi.yml @@ -63,6 +63,13 @@ paths: type: string format: string default: relevance + - name: sitelimit + in: query + description: 'Allows you to limit the results by subdomains or subfolders. You can enter multiple allowed limits using a space-separated list (ex. `sitelimit=search.gov/about search.gov/get-started`)' + required: false + schema: + type: string + format: string tags: - search responses: From bac6bc96fd077446595a3e0f10a334c2a48687fa Mon Sep 17 00:00:00 2001 From: Amani Farooque Date: Tue, 24 Jan 2023 08:44:12 -0500 Subject: [PATCH 2/4] Clarify description --- _apidocs/searchgov-results/v2/openapi.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_apidocs/searchgov-results/v2/openapi.yml b/_apidocs/searchgov-results/v2/openapi.yml index 1abbb54f2..2a81198a7 100644 --- a/_apidocs/searchgov-results/v2/openapi.yml +++ b/_apidocs/searchgov-results/v2/openapi.yml @@ -65,7 +65,7 @@ paths: default: relevance - name: sitelimit in: query - description: 'Allows you to limit the results by subdomains or subfolders. You can enter multiple allowed limits using a space-separated list (ex. `sitelimit=search.gov/about search.gov/get-started`)' + description: 'Allows you to limit the results by subdomains or subfolders. You can limit to multiple locations using a space-separated list (ex. `sitelimit=search.gov/about search.gov/get-started`)' required: false schema: type: string From 442d4b514dd9c6eb37208ba3d55f0cac8da9843b Mon Sep 17 00:00:00 2001 From: Amani Farooque Date: Tue, 24 Jan 2023 10:48:53 -0500 Subject: [PATCH 3/4] Add clarification on API access key --- _apidocs/searchgov-results.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/_apidocs/searchgov-results.md b/_apidocs/searchgov-results.md index 5b9712b4a..71f2ac4d5 100644 --- a/_apidocs/searchgov-results.md +++ b/_apidocs/searchgov-results.md @@ -21,9 +21,9 @@ This API exposes all relevant Search.gov results “modules” in a single JSON ## Getting Started -The endpoint is `https://api.gsa.gov/technology/searchgov/v2/results/i14y`. +The endpoint is `https://api.gsa.gov/technology/searchgov/v2/results/i14y`. You must use https. -You must use https. You can find your access key on the API Access Key page of the Search.gov Admin Center. +You can find your access key in the [Search.gov Admin Center](https://search.usa.gov/login). On the left side navigation, click the "Activate" (``) icon, and select the API Access Key page.

Back to top

From de2ea45aa427ce4a33bbe586a0455fcdadaaab6e Mon Sep 17 00:00:00 2001 From: Amani Farooque Date: Mon, 30 Jan 2023 12:01:24 -0500 Subject: [PATCH 4/4] Add domain scope information --- _apidocs/searchgov-results.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_apidocs/searchgov-results.md b/_apidocs/searchgov-results.md index 71f2ac4d5..555404913 100644 --- a/_apidocs/searchgov-results.md +++ b/_apidocs/searchgov-results.md @@ -64,7 +64,7 @@ Sites indexed via sitemaps or crawling will use the `/i14y` endpoint. Because mo | limit (optional) | Defines the number of results to return. The default is 20, but you can specify between 1 and 50 results.
Example: `limit=5` | offset (optional) | Defines the number of results you want to skip from the first result. The offset is used for implementing pagination. The default is 0 and the maximum is 999.
Example: `offset=20` | sort\_by (optional) | Allowed variables are date and relevance. The default sort is relevance. Add `sort_by=date` to sort by date. - | sitelimit (optional) | Limits the results to the subdomains and/or subfolders provided. Multiple values can be passed using a space-separated list. Example: `sitelimit=search.gov/about search.gov/get-started` + | sitelimit (optional) | Limits the results to the subdomains and/or subfolders provided. Multiple values can be passed using a space-separated list. Example: `sitelimit=search.gov/about search.gov/get-started`. The values passed in the sitelimit must be in scope of the Domains list in the Search.gov Admin Center for your search site. ## Expected Results