feat(openapi/upload): add --confirm-overwrite flag (#1168)

| 🚥 Resolves #1167 |
| :------------------- |

## 🧰 Changes

If an automated system runs `openapi upload` on a pre-existing file,
then an overwrite prompt is shown. There is no way to skip this prompt
which can lock up automated systems.

This PR adds a flag to skip the prompt.

## 🧬 QA & Testing

Provide as much information as you can on how to test what you've done.

**Case 1 - confirm existing behavior**
- Upload a new API spec to readme using `openapi upload {spec}
--key={key} --slug={slug}`
- Try uploading the API spec again to trigger the overwrite prompt

**Case 2 - test new behavior**
- Upload a new API spec to readme using `openapi upload {spec}
--key={key} --slug={slug}`
- Try uploading the API spec again using `openapi upload {spec}
--key={key} --slug={slug} --overwrite` to skip the overwrite prompt

---------

Co-authored-by: Kanad Gupta <[email protected]>

Author: jarrodparkes

__tests__/commands/openapi/upload.test.ts

@@ -1,7 +1,7 @@
 import nock from 'nock';
 import prompts from 'prompts';
 import slugify from 'slugify';
-import { describe, beforeAll, beforeEach, afterEach, it, expect } from 'vitest';
+import { afterEach, beforeAll, beforeEach, describe, expect, it } from 'vitest';
 
 import Command from '../../../src/commands/openapi/upload.js';
 import petstore from '../../__fixtures__/petstore-simple-weird-version.json' with { type: 'json' };
@@ -428,4 +428,26 @@ describe('rdme openapi upload', () => {
       fileMock.done();
     });
   });
+
+  describe('given that the confirm overwrite flag is passed', () => {
+    it('should overwrite an existing API definition without asking for confirmation', async () => {
+      const mock = getAPIv2Mock({ authorization: `Bearer ${key}` })
+        .get(`/versions/${version}/apis`)
+        .reply(200, { data: [{ filename: slugifiedFilename }] })
+        .put(`/versions/${version}/apis/${slugifiedFilename}`, body =>
+          body.match(`form-data; name="schema"; filename="${slugifiedFilename}"`),
+        )
+        .reply(200, {
+          data: {
+            upload: { status: 'done' },
+            uri: `/versions/${version}/apis/${slugifiedFilename}`,
+          },
+        });
+
+      const result = await run(['--version', version, filename, '--key', key, '--confirm-overwrite']);
+      expect(result.stdout).toContain('was successfully updated in ReadMe!');
+
+      mock.done();
+    });
+  });
 });

src/commands/openapi/upload.ts

@@ -30,6 +30,11 @@ export default class OpenAPIUploadCommand extends BaseCommand<typeof OpenAPIUplo
 
   static flags = {
     key: keyFlag,
+    'confirm-overwrite': Flags.boolean({
+      description:
+        'If set, file overwrites will be made without a confirmation prompt. This flag can be a useful in automated environments where prompts cannot be responded to.',
+      hidden: true,
+    }),
     slug: Flags.string({
       summary: 'Override the slug (i.e., the unique identifier) for your API definition.',
       description: [
@@ -146,7 +151,7 @@ export default class OpenAPIUploadCommand extends BaseCommand<typeof OpenAPIUplo
     if (method === 'PUT') {
       // bypass the prompt if we're in a CI environment
       prompts.override({
-        confirm: isCI() ? true : undefined,
+        confirm: isCI() || this.flags['confirm-overwrite'] ? true : undefined,
       });
 
       const { confirm } = await promptTerminal({