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

Complete documentation for data schema #180

Open
anderspeders opened this issue Aug 23, 2016 · 7 comments
Open

Complete documentation for data schema #180

anderspeders opened this issue Aug 23, 2016 · 7 comments

Comments

@anderspeders
Copy link

I may have missed something but cannot find the overview of the RP schema in the wiki: https://github.com/NRGI/ResourceProjects.org/wiki/

@davidmihalyi
Copy link

This is not something Chris got to complete before he left.
He had sketches of previous schema, but then the schema changed since.

@mattfullerton
Copy link
Contributor

Should I complete this? High priority? Are there sketches with which to start with? @byndcivilization @anderspeders

@anderspeders
Copy link
Author

I would find this very relevant to have. I do however not know where any sketches are located.

Is this not possible to generate from the API?

@mattfullerton
Copy link
Contributor

We need to make a clear distinction between the API and the database schema.

Auto generation is not really applicable as the API is not built around any such framework (like Swagger), and even then the real work is in writing the descriptions.

Again, for the DB, it might well be possible to print out a document of what collections have what fields, but the real work is in explaining the field names (which for some fields in the whole department of payments I would have to think really hard about!).

I suspect the more important one for internal good process is the DB docs because then new devs can see what stores what and hence understand the controllers and also then the API. If we are more interested in serving external interested parties then the API docs would be more important.

@davidmihalyi
Copy link

We have quite a few things on for last days this year of @mattfullerton . Let`s first understand what we have from Chris, see the size of scope of work...

@byndcivilization
Copy link
Contributor

byndcivilization commented Dec 7, 2016

@davidmihalyi @mattfullerton is this what you're looking for?
https://github.com/NRGI/ResourceProjects.org/wiki
or are you looking for actual db mapping. If so I never got enough breathing room to do that. That said, theres not a ton of difference between the api calls vs the db. The only big transformations are either joining multiple docs and doing counts in some places.

@byndcivilization
Copy link
Contributor

At least thats what i remember. its been a while.

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

4 participants