StackStorm / StackStorm/st2

Dedicated REST API Endpoint per action with formal openapi definition

Open
#4,250 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API complexity:hard proposal stale
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

SUMMARY

Each action would have a consumable openapi definition and could be called directly instead of generic execution API

ISSUE TYPE

Pick one below and delete the rest:

  • Feature Idea
STACKSTORM VERSION

N/A

OS / ENVIRONMENT / INSTALL METHOD

N/A

STEPS TO REPRODUCE

This makes exposure of stackstorm actions easier for external systems. Right now, in my case, to expose meaningful northbound APIs on WSO2 based on southbound stackstorm actions through the generic execution API, I need to perform ESB level payload transformation to make the generic execution call on Stackstorm REST API.

Also makes service (action) descovery a lot easier. Right now we need to discover the yaml action metadata, turn into an API definition and deploy the API on WSO2 API Gateway. If the action would have a dedicated openapi definition, action discovery and deployment (exposure), would directly consume the openapi definition with no additional hassle and without the need of custom discovery processes.

EXPECTED RESULTS
ACTUAL RESULTS

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing generic execution API and the action YAML metadata mentioned in the issue, then trace how actions are currently discovered and exposed. The feature would be complete when each action can be called through a dedicated REST endpoint and its formal OpenAPI definition can be consumed directly by external systems.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi, python
Domain
api, backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.