StackStorm / StackStorm/st2

openapi.yaml not standing in specifications.

Open
#5,453 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

API/v2 bug
Dominant language
Python
Stars
6.5k
Forks
787
PR merge metrics
No merged PRs in 30d

Description

The openapi.yaml not standing in https://github.com/OAI/OpenAPI-Specification/blob/main/schemas/v2.0/schema.json specifications.

[{\"code\":\"ValidationError\",\"target\":\"representation\",\"message\":\"Parsing error(s): JSON is valid against no schemas from 'oneOf'. Path 'paths['/{connectionId}/api/v1/executions/{id}/result'].get.responses.200', line 806, position 18.\"},{\"code\":\"ValidationError\",\"target\":\"representation\",\"message\":\"Parsing error(s): JSON does not match any schemas from 'anyOf'. Path 'definitions.AliasExecution.properties.actionalias.properties.formats.items', line 1123, position 24.\"},{\"code\":\"ValidationError\",\"target\":\"representation\",\"message\":\"Parsing error(s): Invalid type. Expected Object but got String. Path 'definitions.AliasExecution.properties.execution.properties.$ref', line 1199, position 45.\"},{\"code\":\"ValidationError\",\"target\":\"representation\",\"message\":\"Parsing error(s): Invalid type. Expected Array but got Boolean. Path 'definitions.PacksInstall.properties.skip_dependencies.required', line 1620, position 27.\"},{\"code\":\"ValidationError\",\"target\":\"representation\",\"message\":\"Parsing error(s): The input OpenAPI file is not valid for the OpenAPI specificate https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md (schema https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json).\"}]}}","Target":null,"Details":[],"Innererror":null}

Also recieving alot of errors uploading it to: https://editor.swagger.io/

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 with st2common/st2common/openapi.yaml and compare the reported paths and definitions against the OpenAPI 2.0 schema. Validate the file with the linked schema and Swagger Editor, then address the reported errors until both validators accept the specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.