Open Spec / Approved pilot prerelease
Open Spec 0.5.0-draft.1
This is the contract used by the initial research collection. It remains a prerelease; future migrations will be explicit. Both robot and project records share one version.
Versioning rules
We follow semantic versioning. During 0.x development, incompatible changes advance the minor version; compatible corrections advance the patch. After 1.0.0, incompatible changes advance the major version. Released definitions are preserved. Changes to a price or an article do not change the specification.
Fields by format
Required-for-review fields are marked below. Optional fields can remain unknown. Each claim records its value, evidence status, source IDs, check date and context. Automated validation cannot establish source truth.
| Field | Format / type | Review |
|---|---|---|
| Name name | robot, project string | Required |
| Short summary summary | robot, project string | Required |
| Primary upstream URL primary_url | robot, project url | Required |
| Categories categories | robot, project string_list | Required |
| Maintainers / organization maintainers | robot, project string_list | Optional |
| Repository repository_url | robot, project url | Optional |
| Documentation documentation_url | robot, project url | Optional |
| Revision covered reviewed_revision | robot, project string | Required |
| Purpose purpose | robot, project string | Required |
| Intended audience audience | robot, project string_list | Required |
| Use cases use_cases | robot, project string_list | Optional |
| Known limitations limitations | robot, project string_list | Optional |
| Getting started getting_started_url | robot, project url | Optional |
| Setup route setup_steps | robot, project string_list | Optional |
| Required skills skills | robot, project string_list | Optional |
| Dependencies dependencies | robot, project string_list | Optional |
| Host / compute requirements host_compute | robot, project string | Optional |
| Supported operating systems supported_os | robot, project string_list | Optional |
| Interfaces / protocols interfaces | robot, project string_list | Optional |
| Last relevant release date last_release_date | robot, project date | Optional |
| Upstream last updated last_activity_date | robot, project date | Optional |
| Community / support support_url | robot, project url | Optional |
| Maturity maturity | robot, project string | Required |
| Maintenance assessment maintenance_status | robot, project string | Optional |
| Project type project_type | project string | Required |
| Robot form robot_form | robot string | Optional |
| Degrees of freedom degrees_of_freedom | robot number | Optional |
| Actuators actuators | robot string_list | Optional |
| Sensors sensors | robot string_list | Optional |
| Controller controller | robot string | Optional |
| Power requirements power | robot string | Optional |
| Dimensions and configuration dimensions | robot string | Optional |
| Build tools tools | robot string_list | Optional |
| Assembly / fabrication assembly | robot string | Optional |
| Calibration calibration | robot string | Optional |
| Upstream bill of materials bom_url | robot url | Optional |
| Languages / runtimes languages | project string_list | Optional |
| Supported hardware supported_hardware | project string_list | Optional |
| Inputs and outputs inputs_outputs | project string | Optional |
| Model / dataset / file formats formats | project string_list | Optional |
| Installation installation | project string | Optional |
| Published evaluation and its conditions evaluation | project string | Optional |
| Supported workflows workflows | project string_list | Optional |
| Supported algorithms / models algorithms_models | project string_list | Optional |
| CPU / GPU / memory / storage requirements compute_requirements | project string_list | Optional |
| Replacement parts and repairability replacement_parts | robot string | Optional |
| Documented assembly effort assembly_time | robot string | Optional |
| Scope of upstream activity date activity_scope | robot, project string | Optional |
Additional contract requirements
Robot costs carry a configuration, currency, region, inclusions, exclusions and source date. Source attribution and asset credits are separate from the project's licensing assessment. Known activity dates need their repository or artifact scope. References are linked beside claims.