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

Document the API data models and schema #48

Open
jtanzi opened this issue Feb 21, 2018 · 0 comments
Open

Document the API data models and schema #48

jtanzi opened this issue Feb 21, 2018 · 0 comments
Labels
Outdated Issues that may or may not still be relevant (as of 7/9/18)

Comments

@jtanzi
Copy link
Contributor

jtanzi commented Feb 21, 2018

Document the data models (categories and properties) for all data models that will be handled by the Streetlights API. Also, all methods that the API will support for clients (front-end application) requesting data.

e.g.

Streetlight: {
id: string,
bulbType: 'Inc' | 'LED' | 'Fireflies',
wireless: boolean,
fixture_mfg: string
}

Methods:
getStreetlight(id):
Returns a single streetlight.
Parameters:
id: the ID of the streetlight to be returned.
Returns: JSON

@MatthewScholefield MatthewScholefield added the Outdated Issues that may or may not still be relevant (as of 7/9/18) label Jul 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Outdated Issues that may or may not still be relevant (as of 7/9/18)
Projects
None yet
Development

No branches or pull requests

2 participants