This documentation is a work in progress and will be updated periodically to match the current website

API Documentation For OurJSEditor

Credits

This a documentation template that was designed for GSA APIs provided by GSA Digital Services and used under the following public ___domain license: https://github.com/GSA/open-gsa-redesign/blob/master/LICENSE.md

All thanks, credits, and instructions are reproduced from the public ___domain readme file

Thanks

The original list of credits and thanks from the cloned repository is included below:

"Thanks to CFPB team for creating this model and for furthering open source in government. Additional thanks to the 18F and SAM (IAE) teams as well as several in the private sector."

Original Source URL

The source URL for the original repository is: https://github.com/GSA/api-documentation-template.git

Running the Repository Locally (may need to update this to use bundler)

• This repository requires a local Jekyll environment to run locally. Full instructions are available on the Jekyll website here
• Once installed, navigate to the /docs folder in the terminal and enter bundle exec jekyll serve

Note About The API Calls

The "API Calls" tab of this documentation is a demonstration of the Swagger UI to provide interactive sample calls to the API. Most of this resides in the "console" sub-folder.

This is using the Open API Specification. Other options provide similar modeling and tooling, including RAML, API Blueprint, and several more.