Comments (5)
Here is a rough draft of English documentation, which needs to be updated: https://docs.google.com/document/d/1p4XjF50dMWj1gZzN2vpwvzKC11AMNw-6jvCAXFLtVgA/edit?usp=sharing
from openhds-rest.
We definitely want high-level documentation to explain the API.
We probably don't want to invest in hard-to-maintain documentation, like the laundry list of endpoints.
from openhds-rest.
Here is more high-level documentation:
https://docs.google.com/document/d/1XJPpzYblVe7wsw92oPNNkt7DY5xTfaqS6m7NEramru0/edit?usp=sharing
from openhds-rest.
It would be great to serve this documentation directly from openhds-rest, along side the REST API. See #17 .
from openhds-rest.
Let's box this at about 1 day. We can pull "the good stuff" from the two documents linked above.
from openhds-rest.
Related Issues (20)
- Use cases, documentation, and tests for essential functionality. HOT 7
- Detect update conflicts? With record revision numbers? HOT 3
- Discuss openhds-rest with CIMS Bioko team
- Add logging HOT 2
- Location-based queries HOT 2
- Demonstrate integration with openhds-tablet HOT 3
- Make sure REST controllers are generating links to all endpoints. HOT 1
- Optimize Queries for LocationHierarchy Sub-trees
- Disable basic auth on localhost HOT 3
- Initial application setup does not create events table HOT 1
- OPTIONS requests should not require authorization
- Pregnancy Result fails to create new individual
- Security implementation complicates design of browser based clients
- Credentials for Users and Fieldworkers should not be returned by the service
- Better validation and error messages
- Create a deploy plan for the database
- User roles should have domain semantics rather than crud semantics
- Validate structure and uniqueness of extId
- Poorly formed extIds should be flagged for review
- Submitting a membership does not link uuid for individual or socialgroup correctly HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from openhds-rest.