clearlydefined / clearlydefined/service
API Swagger Docs execute a real patch
- Dominant language
- TypeScript
- Stars
- 51
- Forks
- 46
- PR merge metrics
- No merged PRs in 30d
Description
Today I discovered that running the PATCH /curations example embedded in [the Swagger docs](https://api.clearlydefined.io/api-docs/#/curations/patch_curations) does what is expected, but it may not be what is desired.
Running it using the "Execute" button will open a pull request on the [curated-data](https://github.com/clearlydefined/curated-data) repo like [this one](https://github.com/clearlydefined/curated-data/pull/8112).
We should either default to the curated-data-dev repo or make it clearer when the pull request is opened on curated-data that it is a test and should be closed (or be auto closed).
Contributor guide
Research direction
Start at the Swagger documentation definition for the PATCH /curations example linked in the issue, then trace how its Execute request selects the curated-data repository. Compare the desired curated-data-dev default with clearer warning or automatic closure behavior, and verify that executing the example no longer leaves an unintended pull request in curated-data.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi, typescript
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100