From eb3000966b441d2c0bdcf6c95da43abd72913a36 Mon Sep 17 00:00:00 2001 From: matthewcfinnell Date: Wed, 28 Feb 2024 17:07:22 -0500 Subject: [PATCH 1/2] changes for V 1-3 deprecation Signed-off-by: matthewcfinnell --- _apidocs/exclusions-api.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/_apidocs/exclusions-api.md b/_apidocs/exclusions-api.md index 994d989c2..4e815db54 100644 --- a/_apidocs/exclusions-api.md +++ b/_apidocs/exclusions-api.md @@ -26,14 +26,8 @@ The response will be provided in the JSON format in a paginated manner. ## Getting Started -Exclusions API can be accessed from Production or Alpha via the following version 1, version 2 and version 3 endpoints: -* Production Version 1: https://api.sam.gov/entity-information/v1/exclusions?api_key=< value > -* Production Version 2: https://api.sam.gov/entity-information/v2/exclusions?api_key=< value > -* Production Version 3: https://api.sam.gov/entity-information/v3/exclusions?api_key=< value > +Exclusions API can be accessed from Production or Alpha with the following version 4 endpoints: * Production Version 4: https://api.sam.gov/entity-information/v4/exclusions?api_key=< value > -* Alpha Version 1: https://api-alpha.sam.gov/entity-information/v1/exclusions?api_key=< value > -* Alpha Version 2: https://api-alpha.sam.gov/entity-information/v2/exclusions?api_key=< value > -* Alpha Version 3: https://api-alpha.sam.gov/entity-information/v3/exclusions?api_key=< value > * Alpha Version 4: https://api-alpha.sam.gov/entity-information/v4/exclusions?api_key=< value >

Generating a personal API Key: @@ -921,5 +915,6 @@ Date | Version | Description 02/01/2022 | v2.9 | * Added exclusions V3 endpoint information to the Getting Started section.

* Updated the Query String Parameters and Expected Results sections to reflect available parameters and response fields in V3.

* Updated the Example 1 and Example 2 to indicate the V3 behavior.

* Updated the section, "HTTP Response Codes" to indicate the v3 behavior.

* Update the OpenAPI Specification File to include the V3 endpoints. 04/04/2022 | v3.0 | * Provided the v3 end point for Production.

* Removed ueiDUNS occurrences from the sections, Query String Parameters, Expected Result, HTTP Response Codes and Examples. 12/01/2023 | v3.1 | A new V4 Exclusions API has been created, enabling the search and response for FASCSA Order Exclusion records. As part of this change, below are the associated changes made to this OpenGSA page:

* Added exclusions V4 endpoint information to the Getting Started section.

* Updated the Query String Parameters and Expected Results sections to reflect available parameters and response fields in V4.

* Moved the existing Example 5 to Example 6; inserted a new Example 5 to indicate V4 behavior.

* Updated the section, “HTTP Response Codes” to indicate the v4 behavior.

* Updated the OpenAPI Specification File to include the V4 endpoints. +02/28/2024 | v3.2 | Updated Getting Started section to remove deprecated endpoint versions.

Back to top

From f39d2a550e6e7f97736d433567a06f8e0671f571 Mon Sep 17 00:00:00 2001 From: Jeff Fredrickson Date: Wed, 28 Feb 2024 15:52:21 -0700 Subject: [PATCH 2/2] add description of new security requirements Signed-off-by: matthewcfinnell --- README.md | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 73a5337d3..d50738eb7 100644 --- a/README.md +++ b/README.md @@ -6,24 +6,47 @@ This particular site is made for use with [cloud.gov Pages](https://cloud.gov/pa See the [wiki](https://github.com/GSA/open-gsa-redesign/wiki) for more info related to this site including a product roadmap, personas, and guides. -## Running locally +## Repository access for API documentation + +There are some security requirements governing your participation in editing the API documents hosted in this repository. Namely: + +* All commits must have a signature +* All pull requests must be reviewed and approved by someone other than the individual who opened the pull request + +### How to sign commits + +Commit signing provides an additional layer of verification, ensuring that changes are made by those who are authorized to do so. + +If you are making edits directly on the GitHub website, GitHub will automatically handle signing your commits. If you are pushing your change from your local system, then you will have to ensure that you are correctly signing your commits using your Git application. To get started with commit signing, [GitHub's documentation on commit signature verification](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification) for instructions on how to configure your Git client and GitHub account. You may use any signing method (GPG, SSH, or S/MIME). + +### How to approve pull requests + +Reviews help provide additional confirmation that changes to the website are acceptable. + +If you are opening a pull request to make a change, please arrange for another person on your team to review and approve your change. That reviewer will need to have the proper access to this repository. Please see the [list of API Documentation Editors](https://github.com/orgs/GSA/teams/open-gsa-gov-api-documentation-editors) to make sure the reviewer already has access to this repository. If not, please contact us to have them added. Reviewers can refer to [GitHub's documentation on approving a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/approving-a-pull-request-with-required-reviews) for instructions. + +## Running a local development server This is a statically generated site built using Jekyll. ### Before you start -You will need to have the following installed on your machine: +You will need to have Ruby version 3 following installed on your machine. See the `.ruby-version` file for the current version this project uses. + +To install Bundler and then the dependencies: -* Ruby 3 (see the `.ruby-version` file for the current version this project uses) -* Bundler +``` +gem install bundler +bundle install +``` ### Running Jekyll -The preferred method for running Jekyll is with `bundle exec jekyll serve`. +The preferred method for running Jekyll is with `bundle exec rake serve`. -Note that this method will rebuild the entire site every time you make a change to any file. If you want faster builds, you can use `bundle exec jekyll incrementalserve`, which comes with [some caveats](https://jekyllrb.com/docs/configuration/incremental-regeneration/), notably only changed files will be rebuilt. This means if you change a data file, HTML pages that use that data file won't be updated. +Note that this method will rebuild the entire site every time you make a change to any file. If you want faster builds, you can use `bundle exec rake incrementalserve`, which comes with [some caveats](https://jekyllrb.com/docs/configuration/incremental-regeneration/), notably only changed files will be rebuilt. This means if you change a data file, HTML pages that use that data file won't be updated. -### Public domain +## License This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):