feat: display containers using the volume

This commit is contained in:
Nicolas Meienberger
2025-09-27 10:16:23 +02:00
parent 481eb13a44
commit 592a8f52b7
10 changed files with 353 additions and 45 deletions

View File

@@ -8,6 +8,7 @@ import {
deleteVolume,
getVolume,
updateVolume,
getContainersUsingVolume,
mountVolume,
unmountVolume,
} from "../sdk.gen";
@@ -23,6 +24,7 @@ import type {
GetVolumeData,
UpdateVolumeData,
UpdateVolumeResponse,
GetContainersUsingVolumeData,
MountVolumeData,
MountVolumeResponse,
UnmountVolumeData,
@@ -226,6 +228,27 @@ export const updateVolumeMutation = (
return mutationOptions;
};
export const getContainersUsingVolumeQueryKey = (options: Options<GetContainersUsingVolumeData>) =>
createQueryKey("getContainersUsingVolume", options);
/**
* Get containers using a volume by name
*/
export const getContainersUsingVolumeOptions = (options: Options<GetContainersUsingVolumeData>) => {
return queryOptions({
queryFn: async ({ queryKey, signal }) => {
const { data } = await getContainersUsingVolume({
...options,
...queryKey[0],
signal,
throwOnError: true,
});
return data;
},
queryKey: getContainersUsingVolumeQueryKey(options),
});
};
export const mountVolumeQueryKey = (options: Options<MountVolumeData>) => createQueryKey("mountVolume", options);
/**

View File

@@ -16,6 +16,9 @@ import type {
UpdateVolumeData,
UpdateVolumeResponses,
UpdateVolumeErrors,
GetContainersUsingVolumeData,
GetContainersUsingVolumeResponses,
GetContainersUsingVolumeErrors,
MountVolumeData,
MountVolumeResponses,
MountVolumeErrors,
@@ -122,6 +125,22 @@ export const updateVolume = <ThrowOnError extends boolean = false>(
});
};
/**
* Get containers using a volume by name
*/
export const getContainersUsingVolume = <ThrowOnError extends boolean = false>(
options: Options<GetContainersUsingVolumeData, ThrowOnError>,
) => {
return (options.client ?? _heyApiClient).get<
GetContainersUsingVolumeResponses,
GetContainersUsingVolumeErrors,
ThrowOnError
>({
url: "/api/v1/volumes/{name}/containers",
...options,
});
};
/**
* Mount a volume
*/

View File

@@ -349,6 +349,39 @@ export type UpdateVolumeResponses = {
export type UpdateVolumeResponse = UpdateVolumeResponses[keyof UpdateVolumeResponses];
export type GetContainersUsingVolumeData = {
body?: never;
path: {
name: string;
};
query?: never;
url: "/api/v1/volumes/{name}/containers";
};
export type GetContainersUsingVolumeErrors = {
/**
* Volume not found
*/
404: unknown;
};
export type GetContainersUsingVolumeResponses = {
/**
* List of containers using the volume
*/
200: {
containers: Array<{
id: string;
image: string;
name: string;
state: string;
}>;
};
};
export type GetContainersUsingVolumeResponse =
GetContainersUsingVolumeResponses[keyof GetContainersUsingVolumeResponses];
export type MountVolumeData = {
body?: never;
path: {