-
Notifications
You must be signed in to change notification settings - Fork 0
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
Comments
This is not something Chris got to complete before he left. |
Should I complete this? High priority? Are there sketches with which to start with? @byndcivilization @anderspeders |
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? |
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. |
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... |
@davidmihalyi @mattfullerton is this what you're looking for? |
At least thats what i remember. its been a while. |
I may have missed something but cannot find the overview of the RP schema in the wiki: https://github.com/NRGI/ResourceProjects.org/wiki/
The text was updated successfully, but these errors were encountered: