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

Describe and document the existing API #8

Open
tmvoe opened this issue Jun 2, 2020 · 0 comments
Open

Describe and document the existing API #8

tmvoe opened this issue Jun 2, 2020 · 0 comments
Assignees
Labels
enhancement New feature or request

Comments

@tmvoe
Copy link
Contributor

tmvoe commented Jun 2, 2020

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.

@tmvoe tmvoe added the enhancement New feature or request label Jun 2, 2020
@tmvoe tmvoe self-assigned this Jun 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant