Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Publish the parameters of a plan in a machine readable way #12

Closed
tacaswell opened this issue Sep 2, 2020 · 1 comment
Closed

Publish the parameters of a plan in a machine readable way #12

tacaswell opened this issue Sep 2, 2020 · 1 comment
Labels
server The core API server web client An HTML/JS UI to the API server
Milestone
mvp1

Comments

@tacaswell
Copy link
Collaborator

To be able to (semi) auto generate UIs we need to be able to describe the parameters is a machine readable way (names, types, optional or not, etc ). This has two parts:

  • pick a markup to send between the client and the server
  • start to annotate plans
@tacaswell tacaswell added server The core API server web client An HTML/JS UI to the API server labels Sep 2, 2020
@tacaswell tacaswell added this to the mvp1 milestone Sep 2, 2020
@tacaswell tacaswell mentioned this issue Sep 2, 2020
Closed
@dmgav
Copy link
Contributor

dmgav commented Mar 16, 2021

Custom decorator for annotating plans was implemented in #68 The currently implemented features include tools for generation of complete plan parameter descriptions based on docstring, signature and description in the parameter_annotation_decorator. Separate issues will be created before work on refinement of the features will be performed.

@dmgav dmgav closed this as completed Mar 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
server The core API server web client An HTML/JS UI to the API server
Projects
None yet
Milestone
mvp1
Development

No branches or pull requests
2 participants
@tacaswell @dmgav