Skip to content

fix(spec): custom actions documentation does not match the schema #81

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

Open
ficosta wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(spec): custom actions documentation does not match the schema #81

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions v1/specification/docs/Specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,16 +155,16 @@ an exact `step` match, then a fallback step duration without `step`, then the ac
#### Custom actions

A custom action is an action that is specific for a particular Graphic. It is a mechanism to support any action
a Graphic can execute. The Manifest file defines the custom actions by means of the `actions` field. It represents
a Map where the keys correspond to the id of the custom action and the values are `Action` objects. The `Action` object
a Graphic can execute. The Manifest file defines the custom actions by means of the `customActions` field. It is an
array of `Action` objects, each carrying the id of the custom action in its own `id` field. The `Action` object
supports the following fields:

| Field | Type | Required | Default | Description |
|-------------|--------|:--------:|:-------:|-----------------------------------------------------------|
| id | string | X | | The identity of the action. The id must be unique within the graphic. |
| name | string | X | | The name of the action (for use in GUIs). |
| description | string | | | A longer description of the action. |
| schema | object | | | The JSON schema definition for the payload of the action. |
| schema | object | | | The JSON schema definition for the payload of the action. Set to `null` when the action takes no parameters. |

#### RenderRequirements

Expand Down Expand Up @@ -385,15 +385,15 @@ customAction: (
) => Promise<ReturnPayload | undefined>;
```
The `customAction()` function is called by the Renderer to invoke a custom action on the Graphic. The `id` field MUST
correspond to an `id` of an Action that is defined in the Manifest file, inside the `actions` field. The schema for the
correspond to an `id` of an Action that is defined in the Manifest file, inside the `customActions` field. The schema for the
`payload` field is the described in the corresponding Action inside the Manifest file. The returned Promise MUST
resolve when the action is executed.

The `skipAnimation` field indicates whether the Graphic should disappear with or without animation.
The `skipAnimation` field indicates whether the Graphic should perform the action with or without animation.
When not provided, the `skipAnimation` field defaults to `false`. The Graphic MUST skip the animation when
`skipAnimation` is set to `true`.

The returned Promise MUST resolve after the execution of the update.
The returned Promise MUST resolve after the execution of the action.
The point in time when the Promise is resolved SHOULD indicate that the graphic is ready to execute another action.
Typically, it could be when a graphic has finished an animation of the action.

Expand Down