StackStorm / StackStorm/st2

REST API return incorrect data

Open
#5,622 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API bug
Dominant language
Python
Stars
6.5k
Forks
787
No merged PRs in 30d

Description

StackStorm version st2 3.6.0, on Python 3.6.9

Endpoint GET /api/v1/actions returns actions with parameters but some parameters are missing or incomplete.

Examples:

  • action HTTP from core package in parameters that return the API endpoint doesn't have url parameter which is required.
  • action announcement from core package doesn't have all data for parameters (eg. type). Look at the pictures
ST2 API bug

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 reproducing GET /api/v1/actions on StackStorm 3.6.0 and compare the returned parameter metadata for the core HTTP and announcement actions with their expected definitions. Done means the HTTP action includes its required url parameter and announcement includes complete parameter data such as type.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.