nusmodifications / nusmodifications/nusmods

CI: OpenAPI definition should be tested before deployment

Open
#3,386 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
689
Forks
364
Avg merge
7h 5m
Merged PRs (30d)
14

Description

Not using the templates since the suggestion seems to fall into neither category.

As the title suggests, it might be good to do actual testing of the OpenAPI definition before deployment.

Although this is admittedly a bit pedantic, it should be able to reveal defects such as #3363 more timely and serves as a crosscheck as well.

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

No files, tests, or entry points are named. Start by locating the OpenAPI definition and the CI/deployment configuration, then identify how the definition can be tested before deployment. Done means the CI process checks the definition early enough to catch defects such as #3363.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, ci-cd
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.