blender/flamenco
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

OAPI: yet another refactor of 'eval-on-submit' behavior for job settings

Browse Source 
The data is still the same, but the names of the properties have changed
a bit so that they're more generic, declarative, instead of specific to
one bit of functionality.

The goal is to have the `evalInfo.description` field usable for the
'evaluate now' button in the add-on as well. That way it should be
clearer what that does.

This commit just updates the OpenAPI definition.
This commit is contained in:
Sybren A. Stüvel 2023-07-13 14:59:22 +02:00
parent 242ed119ab
commit 6686ba3610
1 changed files with 22 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
pkg/api/flamenco-openapi.yaml
View File

@ -1683,28 +1683,32 @@ components:
"eval": "eval":
type: string type: string
description: Python expression to be evaluated in order to determine the default value for this setting. description: Python expression to be evaluated in order to determine the default value for this setting.
"evalOnSubmit": "evalInfo":
type: object type: object
description: Meta-data for the 'eval' expression.
properties:
"showLinkButton":
type: boolean
default: false
description: > description: >
Enables the 'eval on submit' toggle button behavior for this setting. Enables the 'eval on submit' toggle button behavior for this setting.
A toggle button will be shown in Blender's submission interface. A toggle button will be shown in Blender's submission interface.
When toggled on, the `eval` expression will determine the setting's When toggled on, the `eval` expression will determine the setting's
value. Manually editing the setting is then no longer possible, and value. Manually editing the setting is then no longer possible, and
instead of an input field, the 'placeholder' string is shown. instead of an input field, the 'description' string is shown.
An example use is the to-be-rendered frame range, which by default An example use is the to-be-rendered frame range, which by default
automatically follows the scene range, but can be overridden automatically follows the scene range, but can be overridden
manually when desired. manually when desired.
properties: "description":
"showButton":
type: boolean
description: Enable or disable the 'eval on submit' toggle button.
"placeholder":
type: string type: string
default: ""
description: > description: >
Placeholder text to show when the manual input field is hidden Description of what the 'eval' expression is doing.
(because eval-on-submit has been toggled on by the user). It is also used as placeholder text to show when the manual
required: [showButton, placeholder] input field is hidden (because eval-on-submit has been toggled
on by the user).
required: [showLinkButton, description]
"visible": "visible":
$ref: "#/components/schemas/AvailableJobSettingVisibility" $ref: "#/components/schemas/AvailableJobSettingVisibility"
"required": "required":