open-rmf / open-rmf/rmf_api_msgs

Add UI schema to task discovery response to help frontend build forms

Open
#32 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
2
Forks
12
Avg merge
22h 56m
Merged PRs (30d)
2

Description

Feature request

Description

Regarding this issue about validating tasks https://github.com/open-rmf/rmf-web/issues/684. Afaik, there are several blockers for us to resolve it.

  • The rmf task discovery endpoint is not implemented yet
  • The task discovery uses json schema to describe the params of a task
    • Problem is that json schema is very powerful/flexible, I have tried building a form from json schema before but there are too many features which makes the whole process super complicated.
    • There are some similar OSS projects like https://jsonforms.io/ and https://github.com/rjsf-team/react-jsonschema-form, but they require a ui schema to be written beforehand so it won't quite work for our case. Given that this is the approach they use, my conclusion is that going from json schema -> ui forms directly is actually a very complex challenge.

My proposal is to have task discovery contain both the json schema and a ui schema, with this, we can build forms for any tasks and validate them.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining how the task discovery endpoint is represented in this repository and how task parameters are currently described with JSON Schema. Define what the combined JSON Schema and UI schema response should contain, then verify that it supports frontend form generation and task validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.