-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1311 from GSA/apidocs-gsa-content-20241010
Added disclaimer GSA Content API
- Loading branch information
Showing
1 changed file
with
10 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -3,17 +3,22 @@ title: GSA.gov Content API | |
| banner-heading: GSA.gov Content API | ||
| --- | ||
|
|
||
|
|
||
| ## Overview | ||
|
|
||
| <div class="usa-alert usa-alert-warning usa-alert--slim"> | ||
| <div class="usa-alert-body"> | ||
| <p class="usa-alert-text"> | ||
| <strong>Disclaimer:</strong> This page contains outdated information and users may receive unexpected responses. We are currently working on updating the API endpoints. | ||
| </p> | ||
| </div> | ||
| </div> | ||
|
|
||
| The GSA.gov content API is an XML feed which supplies the public with a means to extract data out of the GSA.gov website. When the API returns multiple content items, it list them with the newest item(s) first, and oldest last. | ||
|
|
||
| <p><small><a href="#">Back to top</a></small></p> | ||
|
|
||
| <!-- | ||
| ## Getting Started | ||
|
|
||
|
|
||
|
|
||
| To begin using this API, you will need to register for an API Key. You can sign up for an API key below. After registration, you will need to provide this API key in the `x-api-key` HTTP header with every API request. | ||
|
|
@@ -96,8 +101,7 @@ To begin using this API, you will need to register for an API Key. You can sign | |
| <p><small><a href="#">Back to top</a></small></p> | ||
|
|
||
|
|
||
| --> | ||
| ## OpenAPI Specification File | ||
|
|
||
| You can view the full details of this API in the OpenAPI Specification file available here: | ||
|
|
@@ -107,8 +111,6 @@ You can view the full details of this API in the OpenAPI Specification file avai | |
|
|
||
| ## API Description | ||
|
|
||
|
|
||
|
|
||
| This API has two primary endpoints: | ||
|
|
||
| **Endpoint 1:** https://api.gsa.gov/technology/gsa-content/v2/by-type/{type} | ||
|
|
@@ -124,7 +126,6 @@ This API has two primary endpoints: | |
| | Content Types | There are three options: Events - `event`; Topic Pages (meta data about GSA.gov web pages) - `cmp_page`; or Text Assets (snippets which display on pages of the site) - `text_asset` | | ||
| | Page Number | Each page displays 25 items, to get more results, you can goto "page 2" by adding a `/2` to the end of the URL, or "page 3" by adding a `/3`, etc. | | ||
|
|
||
|
|
||
| **Expected Result** | ||
|
|
||
| | Name | Description | | ||
|
|
@@ -168,7 +169,6 @@ This API has two primary endpoints: | |
| | owner | A numerical identifier that indicates who owns this content in this system. This is a reference to another items content_id | | ||
| | owner | A numerical identifier that indicates who the POC is for this content in this system. This is a reference to another items content_id | | ||
|
|
||
|
|
||
| <p><small><a href="#">Back to top</a></small></p> | ||
|
|
||
| ## HTTP Response Codes | ||
|
|
@@ -184,7 +184,6 @@ The API will return one of the following responses: | |
|
|
||
| <p><small><a href="#">Back to top</a></small></p> | ||
|
|
||
|
|
||
| ## Contact Us | ||
|
|
||
| If you have questions or need help, please email us at [[email protected]](mailto:[email protected]) or file an issue in this [GitHub issue tracker](https://github.com/gsa/gsa-apis/issues). | ||
|
|
||