action.json overview

The action.json file defines the actions an adapter can take with the system it integrates with. Actions are also referred to as integrations, APIs, or endpoints.

How actions are generated

When you build an adapter from a Swagger or OpenAPI document, each operation in that document produces an action in the adapter’s action.json.

• By default, method names are derived from the operationId field in the OpenAPI document. If operationId values are missing or do not follow a clear naming convention, the adapter generates method names from the HTTP method and path instead, which can result in long or unclear names.
• Actions are grouped by entity. Each entity defined in the adapter has a single action.json file containing all the actions available for that entity. By default, entities are built to match the tags in the OpenAPI document. If those tags are absent or do not group calls meaningfully, the adapter may not group actions in a useful way either.

Actions and entities

An entity can have any number of actions. Common examples follow CRUD patterns — for a device entity, you might have getDevice, createDevice, updateDevice, and deleteDevice — but entities can also have more specific actions such as getDeviceConfig or setDeviceConfig.

Live updates

Changes to action.json do not require a restart ofItential Platform or the adapter. Updates take effect immediately.