Zendro-dev / Zendro-dev.github.io

Zendro documentation
5 stars 2 forks source link

Describe and document the existing API #8

Open tmvoe opened 4 years ago

tmvoe commented 4 years ago

The following text is taken from the text Integrate Cassandra Support into Cenzontle

Describe and update the Cenzontle documentation for data models. Here, generate a data model of storage type SQL including to_one and to_many associations. Write a comprehensive and concise documentation explaining what data model definitions (input arguments to the code-generators) create which output on the level of resolvers and data model modules. Explain briefly the generated Application Programming Interface (API), i.e. which functions are generated. Here, distinguish between root and field resolvers, and point out which data model functions correspond to the respective resolvers. Add a brief paragraph about authorization-checks and record limits. Finally in a separate technical document describe the SQL statements each data model function uses to implement its respective database operation.

Make sure the above documents are in the style and format of our existing manual and documentation. Also make sure these documents become part of the current documentation and it is thus updated. Before integrating them, pass them to the rest of the team for peer review.