Sha256: 79a8caf092e8f2f34a93c91026184050eac02f7efa007a9f031a0481d4accb31

Contents?: true

Size: 709 Bytes

Versions: 13

Compression:

Stored size: 709 Bytes

Contents

# api_spec
This project is centered around generating the `spec.json` file
located in the root directory. The `spec.json` file contains a machine
readable specification of the NationBuilder API. It is in Mashery's
[I/O Docs](http://www.mashery.com/product/io-docs) format. The
specification can be used to generate documentation servers and client
libraries for the NationBuilder API.

## Developer environment setup

```ruby
bundle install
```

## Adding/modifying an endpoint

Locate the file in `lib/api_spec/specs` that corresponds to the API
you're modifying. With the DSL used in the file, make your changes. In
the root project directory, run `rake` to update the `spec.json`
file. Commit your changes.

Version data entries

13 entries across 13 versions & 1 rubygems

Version Path
nationbuilder-rb-1.6.2 lib/api_spec/README.md
nationbuilder-rb-1.6.1 lib/api_spec/README.md
nationbuilder-rb-1.6.0 lib/api_spec/README.md
nationbuilder-rb-1.5.0 lib/api_spec/README.md
nationbuilder-rb-1.4.3 lib/api_spec/README.md
nationbuilder-rb-1.4.2 lib/api_spec/README.md
nationbuilder-rb-1.4.1 lib/api_spec/README.md
nationbuilder-rb-1.3.9 lib/api_spec/README.md
nationbuilder-rb-1.3.7 lib/api_spec/README.md
nationbuilder-rb-1.3.6 lib/api_spec/README.md
nationbuilder-rb-1.3.5 lib/api_spec/README.md
nationbuilder-rb-1.3.4 lib/api_spec/README.md
nationbuilder-rb-1.3.3 lib/api_spec/README.md