feat(@xen-orchestra/rest-api): expose forget SR (#9505)

Author: MelissaFrncJrg

@vates/types/src/lib/xen-orchestra-xapi.mts

@@ -134,6 +134,7 @@ export interface Xapi {
       nameLabel?: string
     }
   ): Promise<{ vm: XenApiVmWrapped }>
+  forgetSr(id: XoSr['id']): Promise<void>
   SR_importVdi(
     ref: XenApiSr['$ref'],
     stream: Readable,

@xen-orchestra/rest-api/src/srs/sr.controller.mts

@@ -273,4 +273,31 @@ export class SrController extends XapiXoController<XoSr> {
       },
     })
   }
+
+  /**
+   * @example id "c4284e12-37c9-7967-b9e8-83ef229c3e03"
+   */
+  @Example(taskLocation)
+  @Post('{id}/actions/forget')
+  @SuccessResponse(asynchronousActionResp.status, asynchronousActionResp.description)
+  @Response(noContentResp.status, noContentResp.description)
+  @Response(notFoundResp.status, notFoundResp.description)
+  @Response(invalidParametersResp.status, invalidParametersResp.description)
+  @Response(internalServerErrorResp.status, internalServerErrorResp.description)
+  async forgetSr(@Path() id: string, @Query() sync?: boolean): CreateActionReturnType<void> {
+    const srId = id as XoSr['id']
+    const action = async () => {
+      const xapiSr = this.getXapiObject(srId)
+      await xapiSr.$xapi.forgetSr(srId)
+    }
+
+    return this.createAction<void>(action, {
+      sync,
+      statusCode: noContentResp.status,
+      taskProperties: {
+        name: 'forget sr',
+        objectId: srId,
+      },
+    })
+  }
 }

CHANGELOG.unreleased.md

@@ -15,6 +15,7 @@
 - [Replication] Reuse the same VM as an incremental replication target (PR [#9524](https://github.com/vatesfr/xen-orchestra/pull/9524))
 - [S3] add configuration for max/minPartSize and maxPartNumber in the API (PR [#9561](https://github.com/vatesfr/xen-orchestra/pull/9561))
 - [REST API] Expose `/rest/v0/vms/:id/actions/clone` (PR [#9453](https://github.com/vatesfr/xen-orchestra/pull/9453))
+- [REST API] Expose POST `/rest/v0/srs/:id/actions/forget` (PR [#9505](https://github.com/vatesfr/xen-orchestra/pull/9505))
 
 ### Bug fixes