honeybadger-schemas

JSON schemas for public Honeybadger API resources.

APIs

• Data Access
  • docs
  • schemas
• Exceptions
  • docs
  • schemas

How these are currently used

• Remote download

  The schemas are hosted remotely on s3. honeybadger-services currently uses this method to download the latest schemas and verify our test fixture data. See Deployment

• Testing in the Rails app

  These schemas are currently copied manually into our Rails repo at spec/fixtures/schemas/. Eventually we may gem-ify this repo to avoid the duplication.

Deployment

To deploy you must install Python and aws-cli:

brew install python && pip install awscli

You also need to configure aws-cli. Grab the security credentials for honeybadger-schemas from the shared keychain on Dropbox:

aws configure set preview.cloudfront true

# You can use any of the configuration methods mentioned in the aws-cli README.
export AWS_ACCESS_KEY_ID=[Key]
export AWS_SECRET_ACCESS_KEY=[Secret Key]

Then to deploy:

# Test deployment. (optional)
aws s3 sync public s3://honeybadger-schemas --acl public-read --dryrun

# Deploy files.
aws s3 sync public s3://honeybadger-schemas --acl public-read

# It will take a while for the cache to invalidate.
open http://honeybadger-schemas.s3-website-us-east-1.amazonaws.com

Tests

TODO

Contributing

If you're adding a new feature, please submit an issue as a preliminary step; that way you can be (moderately) sure that your pull request will be accepted.

To contribute your code:

1. Fork it.
2. Create a topic branch git checkout -b my_branch
3. Commit your changes git commit -am "Boom"
4. Push to your branch git push origin my_branch
5. Send a pull request