Purpose: just a template to describe an entity in the README.md file
Location in File System:
- Directory inside parent entity directory with a
entity.jsonfile inside. - The directory name of a entity directory must be the same as the field
idinside theentity.json. - All other directories that do not conform to these rules will be ignored by the Scenarioo Viewer.
Fields of entity.json:
| Name | Type / Format | Description | Rules |
|---|---|---|---|
| name | String | Display name. Use something that identifies your entity. | Required |
| id | Identifier-String | Identifier used for this entity in URLs. | Required (but calculated by libraries from name, if not set), must be the same as the directory name. |
| description | String | A short description text | Optional |
| labels | Labels | Add some categories that are important to your entity as labels to mark all such entities of special kinds. | Optional |
| properties | Properties: Array of DocuObject | For additional properties to add arbitrary application specific docu data as important attributes of this entity (displayed in the viewer on an object's details page right below the other direct field values of this object) | Optional |
| sections | Sections: Array of DocuObject | For even more documentation sections to be added to the documentation of this object. Every section must at least have a labelKey as the section title and can be any DocuObject with contained arbitrary application specific docu data. Use this for special more detailed aspects of this entity that do not belong logically to the direct top level attributes (=properties) of it. |
Optional |
Example entity.json file:
TODO