validate-openapi-spec: @apidevtools/swagger-cli has been abandoned

Open Beginner friendly
#8,487 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
70/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
node.js, openapi
Domain
api, ci-cd

Research direction

Start with .github/workflows/validate-openapi-spec.yml lines 19-28 and compare the current swagger-cli invocation with the suggested @redocly/cli replacement. Update the workflow to use maintained tooling while preserving validation of openapi/nexus.json, then run the workflow or equivalent validation and confirm the spec remains valid without the deprecation warning.

Written by the indexing model from the issue text.

Description

https://github.com/oxidecomputer/omicron/blob/cbae98c3d48f8ecd77fc750d15daf1bdc6a72a2a/.github/workflows/validate-openapi-spec.yml#L19-L28

$ npx @apidevtools/swagger-cli validate openapi/nexus.json
Need to install the following packages:
@apidevtools/swagger-cli@4.0.4
Ok to proceed? (y) y
npm WARN deprecated @apidevtools/swagger-cli@4.0.4: This package has been abandoned. Please switch to using the actively maintained @redocly/cli
openapi/nexus.json is valid
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 7h
Merged PRs (30d)
92

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.

More from oxidecomputer/omicron

All issues in oxidecomputer/omicron

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.