Action specifications
Before you start
This guide applies to services and links
Creating actions for services and links is exactly the same process. Unless stated otherwise, every time we refer to services or service specifications you can automatically assume the same applies to links and link specifications.
Design your action specifications
Now that you have your service specifications, you have to bring it to life by designing create, update, and delete actions.
Here are some design questions to answer:
Question | Guidance |
---|---|
Which input parameters do I need to ask to create the service? | This is a central design question that will determine the content of the JSON schema under the attributes field. |
Which parameters will I allow to be edited? | Be mindful of the underlying capabilities of your cloud-based services. Also, be careful not to allow changing parameters which cannot be changed in-place and would trigger a resource re-creation by your IaC tool. |
Which custom actions do I want to provide? | These will be actions that serve a specific operational purpose such as "Manually push an event to the queue". |
Do I need to store results for my action? | Results play a key role as they connect actions to the service specifications. Also, custom action's results are displayed to the end-user for easier interpretation. |