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.

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

API: json protocol pause messages in run log #3308

Closed
b-cooper opened this issue Apr 5, 2019 · 0 comments
Closed

API: json protocol pause messages in run log #3308

b-cooper opened this issue Apr 5, 2019 · 0 comments
Assignees
Labels
api Affects the `api` project feature Ticket is a feature request / PR introduces a feature small

Comments

@b-cooper
Copy link
Contributor

b-cooper commented Apr 5, 2019

overview

The JSON schema allows pauses ("until told to resume" AND "for amount of time") to contain a message that is to be displayed to the user in the run log.

current behavior

In APIv1:
Currently only messages from the indefinite pause type are surfacing in the app's run log.
Furthermore, pause for amount of times aren't being logged in the run log at all.
In APIv2:
Currently only messages from the indefinite pause type are surfacing in the app's run log.
Pause for amount of times are being logged with their amount of time in the run log.

desired behavior

In APIv1:
log both types of pauses with optional message in the RA's run log
In APIv2:
log both types of pauses with optional message in the RA's run log

@b-cooper b-cooper added feature Ticket is a feature request / PR introduces a feature api Affects the `api` project small labels Apr 5, 2019
@b-cooper b-cooper self-assigned this Apr 5, 2019
b-cooper added a commit that referenced this issue Apr 5, 2019
This adds an optional message parameter to the delay function in the python apiv2. The message is
published to the run log appended to the standard timing message. The json executor for apiv1 and
apiv2 is capable of receiving messages for both delays and pauses. This will allow PD user's input
Pause step messages to be presented in the App's run log regardless of the duration (including
indefinite holds) of a pause.

Closes #3308
b-cooper added a commit that referenced this issue Apr 11, 2019
This adds an optional message parameter to the delay function in the python apiv2. The message is
published to the run log appended to the standard timing message. The json executor for apiv1 and
apiv2 is capable of receiving messages for both delays and pauses. This will allow PD user's input
Pause step messages to be presented in the App's run log regardless of the duration (including
indefinite holds) of a pause.

Closes #3308
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Affects the `api` project feature Ticket is a feature request / PR introduces a feature small
Projects
None yet
Development

No branches or pull requests

1 participant