arrow_back_ios_new
View this file on Github Download as Schema.org

cq-genesis

This file exposes the INFINITY Ecosystem annotations for this component. It is consumed as-is by the INFINITY Ecosystem website (built on REECO/Jekyll), so keep the YAML header both REECO-valid and up to date at every release.

Notes for editing this file

  • type is set to WebApplication since CQ-Genesis ships both a Streamlit web interface and a FastAPI REST API. Revisit if the ecosystem site should annotate the API separately (e.g. a second component file with type: API).
  • pilot is an empty list: CQ-Genesis is not currently attached to a specific INFINITY pilot. Update this if/when it is.
  • licence must be a list of codes from REECO’s own vocabulary (reeco-python/src/reeco/schema/licences.yml, ~340 entries derived from DALICC), not SPDX identifiers. MIT happens to match SPDX exactly, so no substitution is needed here (unlike EUPL-1.2, which has no REECO code as of this writing).
  • related-components must be present (an empty list is valid) – REECO treats a missing key as an error, not a missing-but-optional field.
  • Validate locally before pushing: pip install reeco && python -c "import frontmatter, reeco, sys; a,_ = frontmatter.parse(open('component.md').read()); v = reeco.Validator(); r = (v.asComponent(a) if 'component-id' in a else v.asContainer(a)); print(r)"
  • A repository may contain multiple annotated component files (any filename); duplicate this structure per component if so.
  • Component types: https://github.com/reeco-framework/reeco-annotation-schema/blob/main/schema/README.md