When we deploy Data Model using GraphQL then we can put some comments like documentation giving relevant info. This is helpful for people who look into Data Model’s graphql in web application.
However, when we deploy using toolkit via yaml files the generated Data Model’s GraphQL do not have comments. Though we can add comment by editing in UI but that has to be done manually.
Is there any way to have documentation in generated Data Model’s GraphQL when we deploy yaml files using toolkit?
Best answer by Ayush Daruka
I did not find anything as such to add a comment to the model. But to add information about any view or a property of the view, we can use the description field when we create the view definition. For example, CogniteDescribable as shown below. Please note the content of description in graphQL and definition file.
I did not find anything as such to add a comment to the model. But to add information about any view or a property of the view, we can use the description field when we create the view definition. For example, CogniteDescribable as shown below. Please note the content of description in graphQL and definition file.
I assume with documentation you mean the name and description of the properties. As
I assume with documentation you mean the name and description of the properties. As
Any reason why you want an additional comments outside the description fields?
The way I have seen this solved when governing a data model with Toolkit is that the YAML files are version controlled, typically in GitHub or Azure Devops. Then, either with a Changelog, similar to the one for Toolkit here, and/or Pull requests descriptions + discussions the reasoning for why the modeling was done in a particular way.
Enter your E-mail address. We'll send you an e-mail with instructions to reset your password.
Check the
documentation
Ask the
Community
Take a look
at
Academy
Cognite
Status
Page
Contact
Cognite Support
