Skip to content

feat(api!): rename component to action on the API level#4399

Merged
lucaspin merged 8 commits into
mainfrom
chore/api-component-rename
Apr 26, 2026
Merged

feat(api!): rename component to action on the API level#4399
lucaspin merged 8 commits into
mainfrom
chore/api-component-rename

Conversation

@lucaspin

@lucaspin lucaspin commented Apr 25, 2026

Copy link
Copy Markdown
Contributor

Related to #1837


Following #4396, we update the APIs and CLI to reflect the rename of component to action. This is a breaking change for the API. Clients will be required to update their YAMLs to work with the new API.

API

Two changes:

  • The /api/v1/components no longer exists. It was replaced with /api/v1/actions.
  • Referencing an action in a canvas YAML now requires you to use action field instead of the component field:
spec:
  nodes:
    - id: "component-node-70p83y"
      name: "Wait for the changes to propagate"
      type: "TYPE_ACTION"
      action:
        name: "wait"
      # ...

CLI

The superplane index components command becomes superplane index actions

Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
@superplanehq-integration

Copy link
Copy Markdown

👋 Commands for maintainers:

  • /sp start - Start an ephemeral machine (takes ~30s)
  • /sp stop - Stop a running machine (auto-executed on pr close)

Comment thread templates/canvases/health-check-monitor.yaml
Comment thread pkg/cli/commands/index/index_test.go
Comment thread protos/actions.proto Outdated
Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Comment thread pkg/cli/commands/index/actions.go Outdated
Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Comment thread agent/src/ai/superplane_client.py Outdated
Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Comment thread Makefile Outdated
Signed-off-by: Lucas Pinheiro <lucas@superplane.com>

@cursor cursor Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 48005b0. Configure here.

Comment thread Makefile
@lucaspin lucaspin merged commit 4add11e into main Apr 26, 2026
5 checks passed
@lucaspin lucaspin deleted the chore/api-component-rename branch April 26, 2026 11:43
WashingtonKK pushed a commit to WashingtonKK/superplane that referenced this pull request Apr 27, 2026
…#4399)

Related to superplanehq#1837

---

Following superplanehq#4396, we
update the APIs and CLI to reflect the rename of component to action.
This is a breaking change for the API. Clients will be required to
update their YAMLs to work with the new API.

### API

Two changes:
- The `/api/v1/components` no longer exists. It was replaced with
`/api/v1/actions`.
- Referencing an action in a canvas YAML now requires you to use
`action` field instead of the `component` field:

```yaml
spec:
  nodes:
    - id: "component-node-70p83y"
      name: "Wait for the changes to propagate"
      type: "TYPE_ACTION"
      action:
        name: "wait"
      # ...
```

### CLI

The `superplane index components` command becomes `superplane index
actions`

---------

Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Signed-off-by: WashingtonKK <washingtonkigan@gmail.com>
re-pixel pushed a commit to re-pixel/superplane that referenced this pull request May 4, 2026
…#4399)

Related to superplanehq#1837

---

Following superplanehq#4396, we
update the APIs and CLI to reflect the rename of component to action.
This is a breaking change for the API. Clients will be required to
update their YAMLs to work with the new API.

### API

Two changes:
- The `/api/v1/components` no longer exists. It was replaced with
`/api/v1/actions`.
- Referencing an action in a canvas YAML now requires you to use
`action` field instead of the `component` field:

```yaml
spec:
  nodes:
    - id: "component-node-70p83y"
      name: "Wait for the changes to propagate"
      type: "TYPE_ACTION"
      action:
        name: "wait"
      # ...
```

### CLI

The `superplane index components` command becomes `superplane index
actions`

---------

Signed-off-by: Lucas Pinheiro <lucas@superplane.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants