Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation/spec for format of JSON data that comes from the API. #2

Open
farmdawgnation opened this issue Feb 15, 2015 · 0 comments

Comments

@farmdawgnation
Copy link
Member

The README.md file in the project root defines the initial ideas for what API endpoints we should have, but we should probably create some more detailed documentation.

I propose the creation of a doc folder at the top of the repository that will contain documentation for each type of record that someone can request from the API.

Such documentation would include:

  • The name of the type of record (e.g. "candidate")
  • The keys that will appear in that record, and what they will contain.

As far as I can tell there will be three types of records:

  1. Candidates
  2. Campaigns
  3. Campaign Reports

A candidate may have one or more campaigns associated with it. A campaign will have one or more report associated with it. These relationships should be taken into account.

We should also plan to have this data be denormalized.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant