-
Notifications
You must be signed in to change notification settings - Fork 58
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
166 changed files
with
902 additions
and
3,966 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 |
---|---|---|
|
@@ -6,11 +6,11 @@ A live example of this is available here: | |
- Without the Swagger UI interactive documentation: https://open.gsa.gov/api/sample-api-basic/ | ||
- With the Swagger UI interactive documentation: https://open.gsa.gov/api/sample-api/ | ||
|
||
The API documentation on open.gsa.gov is managed by the Cloud Integration Shared Services (CISS) team. | ||
The API documentation on open.gsa.gov is managed by the GSA Office of the CTO. | ||
|
||
## Steps to add you API documentation to the GSA API Directory | ||
|
||
1. [Contact CISS](mailto:api.ciss@gsa.gov) and ask for access to manage API docs, sharing your GitHub ID. Your GitHub ID will have to be in the GSA GitHub organization; follow the instructions in the [GitHub Administration repository](https://github.com/GSA/GitHub-Administration) if you haven't done so yet. | ||
1. [Contact the CTO team](mailto:cto@gsa.gov) and ask for access to manage API docs, sharing your GitHub ID. Your GitHub ID will have to be in the GSA GitHub organization; follow the instructions in the [GitHub Administration repository](https://github.com/GSA/GitHub-Administration) if you haven't done so yet. | ||
|
||
2. Create a branch of the site from the `master` branch. Naming convention for new branch: `apidocs-apiname-YYYYMMDD` (replace `apiname` with the name of your API without spaces) | ||
|
||
|
@@ -34,12 +34,12 @@ The API documentation on open.gsa.gov is managed by the Cloud Integration Shared | |
4. Edit the `apiname.md` file with all of the information about your API. When you commit your changes to your repo in GitHub, a preview will be available of the site (with your doco) at this URL after waiting 5 min or so for the preview to build: | ||
|
||
https://federalist-ecc58765-2903-48b3-920c-5d93318ad084.app.cloud.gov/preview/gsa/open-gsa-redesign/YOUR_BRANCH_NAME/api/YOUR_API_NAME/ (insert your branch name and API name where indicated) | ||
|
||
5. When you are ready to publish in the API directory, [open a pull request (PR)](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the `master` branch. Email the [CISS API team](mailto:[email protected]) with your PR number or a link to your PR, informing them that your branch is ready to be merged. | ||
|
||
6. The CISS team will merge your branch with `master`, resulting in your doco going to the live website. At this point, you will see your API doco at: https://open.gsa.gov/api/YOUR_API_NAME/ | ||
5. When you are ready to publish in the API directory, [open a pull request (PR)](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the `master` branch. Email the [CTO team](mailto:[email protected]) with your PR number or a link to your PR, informing them that your branch is ready to be merged. | ||
|
||
You can also ask the CISS team to add your API to the `/_data/api-list.yml` file, which will add your API to the directory page: https://open.gsa.gov/api/ | ||
6. The CTO team will merge your branch with `master`, resulting in your doco going to the live website. At this point, you will see your API doco at: https://open.gsa.gov/api/YOUR_API_NAME/ | ||
|
||
You can also ask the CTO team to add your API to the `/_data/api-list.yml` file, which will add your API to the directory page: https://open.gsa.gov/api/ | ||
|
||
## Adding Swagger UI to your existing API documentation (with Try It Out functionality) | ||
|
||
|
@@ -101,5 +101,5 @@ In order to remove the API documentation: | |
2. In that branch, delete the relevant markdown file in the `_apidocs` [folder](https://github.com/GSA/open-gsa-redesign/tree/master/_apidocs). | ||
3. In that branch, delete the relevant openapi yml file that is in a subfolder of the `_apidocs` [folder](https://github.com/GSA/open-gsa-redesign/tree/master/_apidocs). | ||
4. In that branch, delete the reference to your API in [the api-list.yml file](https://github.com/GSA/open-gsa-redesign/blob/master/_data/api-list.yml) which populates the [directory page](https://open.gsa.gov/api/). | ||
5. When you are ready to complete the removal, [open a pull request](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the master branch. [Email the CISS API team](mailto:api.ciss@gsa.gov) with your PR number or a link to your PR, informing them that your branch is ready to be merged. | ||
6. The CISS team will merge your branch with master, resulting in your documentation being deleted from the live website, and the reference to it on the directory page being removed. | ||
5. When you are ready to complete the removal, [open a pull request](https://github.com/GSA/open-gsa-redesign/pulls) to merge your branch with the master branch. [Email the CTO team](mailto:cto@gsa.gov) with your PR number or a link to your PR, informing them that your branch is ready to be merged. | ||
6. The CTO team will merge your branch with master, resulting in your documentation being deleted from the live website, and the reference to it on the directory page being removed. |
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
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.