Skip to content
This repository has been archived by the owner on Aug 18, 2021. It is now read-only.

GSA/code-gov-adapters

Repository files navigation

Code.gov Adapters

CircleCI Maintainability Test Coverage

A collection of adapters used by Code.gov.

Adapters

Any number of adapters can be added, for any use. Primary adapters will be for Elasticsearch and databases.

Elasticsearch

The primary adapter for Code.gov. This adapter will expose a limited amount of Elasticsearch's API.

  1. createIndex
  2. deleteIndex
  3. indexExists
  4. indexDocument
  5. updateDocument
  6. deleteDocument
  7. getIndexesForAlias
  8. initIndexMapping
  9. initIndexSettings
  10. search

Install

npm i @code.gov/code-gov-adapters

Contributing

Here’s how you can help contribute to code.gov:

Generating License Data

To update the dependency_licenses.json file, run npm run licenses.

License

As stated in CONTRIBUTING:

[..] this project is in the worldwide public domain (in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the CC0 1.0 Universal public domain dedication).

All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.