Skip to content

docs: add common errors section to Hello World tutorial #517

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.

Sign up for GitHub

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

Open
enoshjoseph wants to merge 1 commit into
base: main
Choose a base branch
from
+27 −0
Open

docs: add common errors section to Hello World tutorial #517

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions docs/started-hello.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,33 @@ Then run `cicero trigger --template helloworld@0.14.0.cta --sample sample.md --r
```
13:47:35 - ERROR: Instance org.accordproject.helloworld.MyRequest#null missing required field input
```
## Common Errors

### Invalid or Missing Identifier

This occurs when your model defines an identifier field but it is not included in `data.json`.
Ensure all required fields defined in `model.cto` are provided in your JSON data file.

### Missing `data.json`

The `cicero draft` command requires a JSON data file.
If your data file has a different name, specify it using:

```bash
cicero draft --data your-file.json
```

### Namespace Mismatch

Ensure the `$class` value in your JSON matches the namespace and asset defined in `model.cto`.

Example:

```json
{
"$class": "org.accordproject.template.MyClause"
}
```

## What Next?

Expand Down