feat: add support for canceling requests

README.md

@@ -50,6 +50,15 @@ const details: Request = await api.requestDetails('test-id');
 const details: unknown = await api.requestDetails('test-id', false);
 ```
 
+### Cancel a Test Request
+
+documentation of - [`DELETE /requests/{request_id}`](https://api.dev.testing-farm.io/redoc#operation/delete_test_request_v0_1_requests__request_id__delete)
+
+```typescript
+const response: CancelRequestResponse = await cancelRequest('test-id');
+const response: unknown = await cancelRequest('test-id', false);
+```
+
 ### Composes Public Ranch
 
 documentation of - [`GET /composes`](https://api.dev.testing-farm.io/redoc#operation/supported_composes_v0_1_composes_get)

src/index.ts

@@ -8,6 +8,8 @@ import {
   Ranch,
   Request,
   ErrorResponse,
+  CancelRequestResponse,
+  cancelRequestResponseSchema,
 } from './schema';
 import {
   composesSchema,
@@ -75,6 +77,20 @@ export default class TestingFarmAPI {
     return requestSchema.parse(await this.link.get(`requests/${id}`));
   }
 
+  async cancelRequest(requestId: string): Promise<CancelRequestResponse>;
+  async cancelRequest(requestId: string, strict: boolean): Promise<unknown>;
+  async cancelRequest(requestId: string, strict?: boolean): Promise<unknown> {
+    const id = requestIdSchema.parse(requestId);
+
+    if (!this.isStrict(strict)) {
+      return this.link.delete(`requests/${id}`);
+    }
+
+    return cancelRequestResponseSchema.parse(
+      await this.link.delete(`requests/${id}`)
+    );
+  }
+
   async composes(): Promise<Composes>;
   async composes(strict: boolean): Promise<unknown>;
   async composes(strict?: boolean): Promise<unknown> {

src/schema.ts

@@ -186,6 +186,16 @@ export const requestSchema = z.object({
 
 export type Request = z.infer<typeof requestSchema>;
 
+// TODO: make
+export const cancelRequestResponseSchema = z.object({
+  id: requestIdSchema,
+  state: z.string(),
+  created: z.string(),
+  updated: z.string(),
+});
+
+export type CancelRequestResponse = z.infer<typeof cancelRequestResponseSchema>;
+
 export const ranchSchema = z.union([z.literal('public'), z.literal('redhat')]);
 
 export type Ranch = z.infer<typeof ranchSchema>;

test/integration/cancel-request.test.ts

@@ -0,0 +1,34 @@
+import { expect, test, describe } from 'vitest';
+
+import TestingFarmAPI from '../../src/index';
+
+describe('Test Testing Farm DELETE /requests/{request_id}', () => {
+  test.todo('safe response', async () => {
+    const api = new TestingFarmAPI('https://api.dev.testing-farm.io/v0.1');
+
+    const response = await api.cancelRequest(
+      'f053796b-452e-4da2-b4e1-26eb2f3e721f'
+    );
+    expect(response).toMatchInlineSnapshot();
+  });
+
+  test.todo('unsafe response', async () => {
+    const api = new TestingFarmAPI('https://api.dev.testing-farm.io/v0.1');
+
+    const response = await api.cancelRequest(
+      'f053796b-452e-4da2-b4e1-26eb2f3e721f',
+      false
+    );
+    expect(response).toBeTypeOf('object');
+  });
+
+  test('non-existent request_id', async () => {
+    const api = new TestingFarmAPI('https://api.dev.testing-farm.io/v0.1');
+
+    await expect(
+      api.cancelRequest('request_id')
+    ).rejects.toThrowErrorMatchingInlineSnapshot(
+      `[Error: {"detail":[{"loc":["body"],"msg":"field required","type":"value_error.missing"}]}]`
+    );
+  });
+});