hashgraph / hashgraph/guardian
Schema Editor — Excel Schema Export / Guidance Inconsistencies
- Dominant language
- TypeScript
- Stars
- 146
- Forks
- 186
- Avg merge
- 2d 20h
- Merged PRs (30d)
- 126
Description
## Bug Summary
Fields between the schema editor and excel export are not consistent and require a user to experiment with to understand how they work.
Acceptance Criteria
* \[ \] review items below, update for consistency
* \[ \] update / review documentation to include a reference article to match excel guidance
### Title Field Required?
When creating a schema and adding a field, the `Title` property is required, however when exporting the schema to Excel it is not included and the `title` property is also not mentioned in the Excel guide (yet it is included in the .schema output as a json property).
I want this field to be fully documented, so I understand why it is needed or removed if it is redundant.
### Export to Excel is not consistent with Field Properties found in the Schema Editor
When updating a schema field's properties, I want the names and the order of the field properties to be consistent with the Excel output
* `updatable field`: not present in export; add to excel.
* `private`: when schema entity type is set to `Encrypted VC` add checkbox to field properties `private` which flags the individual field as encrypted
* `key`: important field is listed last in excel but second in editor, align the order of export
* `type`: listed as `Field Type` in Excel
* `property`: not visible in Excel and unclear what the purpose of this field is, remove if not need. Move to bottom of list, Add help text: "Optional property related to IWA taxonomy"
* geo field types: `country`, `province` fields are not documented in the Excel guidance tab. They use the parameter field for relationships and `Depends on` in the schema editor; make consistent and update guidance.
* `parameter`: not identified clearly in the schema editor and its use / label changes depending on the property (e.g. enum, string); always display and disable when not used.
Contributor guide
Research direction
Start with the Schema Editor, Excel schema export, and Excel guidance referenced in the issue; compare field names, ordering, visibility, and behavior across them. Done means the listed inconsistencies are resolved or clarified, and the documentation includes matching guidance for title, geo fields, properties, parameters, and encryption-related fields.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100