Skip to content

refactor(api)!: show uid instead of parent_lookup DEV-1049 #6323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 12 commits into
base: release/2.025.37
Choose a base branch
from
Open

refactor(api)!: show uid instead of parent_lookup DEV-1049 #6323

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2e149b5
update {parent_lookup_*} to use {uid_*}
RuthTurk Oct 2, 2025
d50fc43
add generated schema
RuthTurk Oct 2, 2025
0be5928
Merge branch 'release/2.025.37' of github.com:kobotoolbox/kpi into de…
RuthTurk Oct 2, 2025
6d91679
updating branch and resolving merge conflicts
RuthTurk Oct 2, 2025
2eb2a73
fix orval and drf-spectacular
RuthTurk Oct 2, 2025
aedf8c6
fix wrong urls in drf schema generation
RuthTurk Oct 2, 2025
e49576b
Merge branch 'release/2.025.37' of github.com:kobotoolbox/kpi into de…
RuthTurk Oct 3, 2025
474740e
clean up
RuthTurk Oct 3, 2025
b87e532
add rest of org uid changes
RuthTurk Oct 3, 2025
5ff9d50
Fix 404 with fetching members/invites nested endpoints
noliveleger Oct 3, 2025
5c75687
update docstrings, fix schema and orval generations, fix tests
RuthTurk Oct 4, 2025
c5ac2f6
fix orval and drf-spectacular generation
RuthTurk Oct 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
235 changes: 128 additions & 107 deletions jsapp/js/api/react-query/form-content.ts
View file
Open in desktop

Large diffs are not rendered by default.

54 changes: 30 additions & 24 deletions jsapp/js/api/react-query/library-collections.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,42 +233,42 @@ export type assetSubscriptionsRetrieveResponse = assetSubscriptionsRetrieveRespo
headers: Headers
}

export const getAssetSubscriptionsRetrieveUrl = (uid: string) => {
return `/api/v2/asset_subscriptions/${uid}/`
export const getAssetSubscriptionsRetrieveUrl = (uidAssetSubscription: string) => {
return `/api/v2/asset_subscriptions/${uidAssetSubscription}/`
}

export const assetSubscriptionsRetrieve = async (
uid: string,
uidAssetSubscription: string,
options?: RequestInit,
): Promise<assetSubscriptionsRetrieveResponse> => {
return fetchWithAuth<assetSubscriptionsRetrieveResponse>(getAssetSubscriptionsRetrieveUrl(uid), {
return fetchWithAuth<assetSubscriptionsRetrieveResponse>(getAssetSubscriptionsRetrieveUrl(uidAssetSubscription), {
...options,
method: 'GET',
})
}

export const getAssetSubscriptionsRetrieveQueryKey = (uid: string) => {
return ['api', 'v2', 'asset_subscriptions', uid] as const
export const getAssetSubscriptionsRetrieveQueryKey = (uidAssetSubscription: string) => {
return ['api', 'v2', 'asset_subscriptions', uidAssetSubscription] as const
}

export const getAssetSubscriptionsRetrieveQueryOptions = <
TData = Awaited<ReturnType<typeof assetSubscriptionsRetrieve>>,
TError = ErrorObject,
>(
uid: string,
uidAssetSubscription: string,
options?: {
query?: UseQueryOptions<Awaited<ReturnType<typeof assetSubscriptionsRetrieve>>, TError, TData>
request?: SecondParameter<typeof fetchWithAuth>
},
) => {
const { query: queryOptions, request: requestOptions } = options ?? {}

const queryKey = queryOptions?.queryKey ?? getAssetSubscriptionsRetrieveQueryKey(uid)
const queryKey = queryOptions?.queryKey ?? getAssetSubscriptionsRetrieveQueryKey(uidAssetSubscription)

const queryFn: QueryFunction<Awaited<ReturnType<typeof assetSubscriptionsRetrieve>>> = ({ signal }) =>
assetSubscriptionsRetrieve(uid, { signal, ...requestOptions })
assetSubscriptionsRetrieve(uidAssetSubscription, { signal, ...requestOptions })

return { queryKey, queryFn, enabled: !!uid, ...queryOptions } as UseQueryOptions<
return { queryKey, queryFn, enabled: !!uidAssetSubscription, ...queryOptions } as UseQueryOptions<
Awaited<ReturnType<typeof assetSubscriptionsRetrieve>>,
TError,
TData
Expand All @@ -282,13 +282,13 @@ export function useAssetSubscriptionsRetrieve<
TData = Awaited<ReturnType<typeof assetSubscriptionsRetrieve>>,
TError = ErrorObject,
>(
uid: string,
uidAssetSubscription: string,
options?: {
query?: UseQueryOptions<Awaited<ReturnType<typeof assetSubscriptionsRetrieve>>, TError, TData>
request?: SecondParameter<typeof fetchWithAuth>
},
): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
const queryOptions = getAssetSubscriptionsRetrieveQueryOptions(uid, options)
const queryOptions = getAssetSubscriptionsRetrieveQueryOptions(uidAssetSubscription, options)

const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey }

Expand Down Expand Up @@ -321,15 +321,15 @@ export type assetSubscriptionsDestroyResponse = assetSubscriptionsDestroyRespons
headers: Headers
}

export const getAssetSubscriptionsDestroyUrl = (uid: string) => {
return `/api/v2/asset_subscriptions/${uid}/`
export const getAssetSubscriptionsDestroyUrl = (uidAssetSubscription: string) => {
return `/api/v2/asset_subscriptions/${uidAssetSubscription}/`
}

export const assetSubscriptionsDestroy = async (
uid: string,
uidAssetSubscription: string,
options?: RequestInit,
): Promise<assetSubscriptionsDestroyResponse> => {
return fetchWithAuth<assetSubscriptionsDestroyResponse>(getAssetSubscriptionsDestroyUrl(uid), {
return fetchWithAuth<assetSubscriptionsDestroyResponse>(getAssetSubscriptionsDestroyUrl(uidAssetSubscription), {
...options,
method: 'DELETE',
})
Expand All @@ -339,24 +339,30 @@ export const getAssetSubscriptionsDestroyMutationOptions = <TError = ErrorObject
mutation?: UseMutationOptions<
Awaited<ReturnType<typeof assetSubscriptionsDestroy>>,
TError,
{ uid: string },
{ uidAssetSubscription: string },
TContext
>
request?: SecondParameter<typeof fetchWithAuth>
}): UseMutationOptions<Awaited<ReturnType<typeof assetSubscriptionsDestroy>>, TError, { uid: string }, TContext> => {
}): UseMutationOptions<
Awaited<ReturnType<typeof assetSubscriptionsDestroy>>,
TError,
{ uidAssetSubscription: string },
TContext
> => {
const mutationKey = ['assetSubscriptionsDestroy']
const { mutation: mutationOptions, request: requestOptions } = options
? options.mutation && 'mutationKey' in options.mutation && options.mutation.mutationKey
? options
: { ...options, mutation: { ...options.mutation, mutationKey } }
: { mutation: { mutationKey }, request: undefined }

const mutationFn: MutationFunction<Awaited<ReturnType<typeof assetSubscriptionsDestroy>>, { uid: string }> = (
props,
) => {
const { uid } = props ?? {}
const mutationFn: MutationFunction<
Awaited<ReturnType<typeof assetSubscriptionsDestroy>>,
{ uidAssetSubscription: string }
> = (props) => {
const { uidAssetSubscription } = props ?? {}

return assetSubscriptionsDestroy(uid, requestOptions)
return assetSubscriptionsDestroy(uidAssetSubscription, requestOptions)
}

return { mutationFn, ...mutationOptions }
Expand All @@ -370,7 +376,7 @@ export const useAssetSubscriptionsDestroy = <TError = ErrorObject, TContext = un
mutation?: UseMutationOptions<
Awaited<ReturnType<typeof assetSubscriptionsDestroy>>,
TError,
{ uid: string },
{ uidAssetSubscription: string },
TContext
>
request?: SecondParameter<typeof fetchWithAuth>
Expand Down
75 changes: 37 additions & 38 deletions jsapp/js/api/react-query/logging.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -466,7 +466,7 @@ export type assetsHistoryListResponse = assetsHistoryListResponseComposite & {
headers: Headers
}

export const getAssetsHistoryListUrl = (parentLookupAsset: string, params?: AssetsHistoryListParams) => {
export const getAssetsHistoryListUrl = (uidAsset: string, params?: AssetsHistoryListParams) => {
const normalizedParams = new URLSearchParams()

Object.entries(params || {}).forEach(([key, value]) => {
Expand All @@ -478,30 +478,30 @@ export const getAssetsHistoryListUrl = (parentLookupAsset: string, params?: Asse
const stringifiedParams = normalizedParams.toString()

return stringifiedParams.length > 0
? `/api/v2/assets/${parentLookupAsset}/history/?${stringifiedParams}`
: `/api/v2/assets/${parentLookupAsset}/history/`
? `/api/v2/assets/${uidAsset}/history/?${stringifiedParams}`
: `/api/v2/assets/${uidAsset}/history/`
}

export const assetsHistoryList = async (
parentLookupAsset: string,
uidAsset: string,
params?: AssetsHistoryListParams,
options?: RequestInit,
): Promise<assetsHistoryListResponse> => {
return fetchWithAuth<assetsHistoryListResponse>(getAssetsHistoryListUrl(parentLookupAsset, params), {
return fetchWithAuth<assetsHistoryListResponse>(getAssetsHistoryListUrl(uidAsset, params), {
...options,
method: 'GET',
})
}

export const getAssetsHistoryListQueryKey = (parentLookupAsset: string, params?: AssetsHistoryListParams) => {
return ['api', 'v2', 'assets', parentLookupAsset, 'history', ...(params ? [params] : [])] as const
export const getAssetsHistoryListQueryKey = (uidAsset: string, params?: AssetsHistoryListParams) => {
return ['api', 'v2', 'assets', uidAsset, 'history', ...(params ? [params] : [])] as const
}

export const getAssetsHistoryListQueryOptions = <
TData = Awaited<ReturnType<typeof assetsHistoryList>>,
TError = ErrorDetail | ErrorObject,
>(
parentLookupAsset: string,
uidAsset: string,
params?: AssetsHistoryListParams,
options?: {
query?: UseQueryOptions<Awaited<ReturnType<typeof assetsHistoryList>>, TError, TData>
Expand All @@ -510,12 +510,12 @@ export const getAssetsHistoryListQueryOptions = <
) => {
const { query: queryOptions, request: requestOptions } = options ?? {}

const queryKey = queryOptions?.queryKey ?? getAssetsHistoryListQueryKey(parentLookupAsset, params)
const queryKey = queryOptions?.queryKey ?? getAssetsHistoryListQueryKey(uidAsset, params)

const queryFn: QueryFunction<Awaited<ReturnType<typeof assetsHistoryList>>> = ({ signal }) =>
assetsHistoryList(parentLookupAsset, params, { signal, ...requestOptions })
assetsHistoryList(uidAsset, params, { signal, ...requestOptions })

return { queryKey, queryFn, enabled: !!parentLookupAsset, ...queryOptions } as UseQueryOptions<
return { queryKey, queryFn, enabled: !!uidAsset, ...queryOptions } as UseQueryOptions<
Awaited<ReturnType<typeof assetsHistoryList>>,
TError,
TData
Expand All @@ -529,14 +529,14 @@ export function useAssetsHistoryList<
TData = Awaited<ReturnType<typeof assetsHistoryList>>,
TError = ErrorDetail | ErrorObject,
>(
parentLookupAsset: string,
uidAsset: string,
params?: AssetsHistoryListParams,
options?: {
query?: UseQueryOptions<Awaited<ReturnType<typeof assetsHistoryList>>, TError, TData>
request?: SecondParameter<typeof fetchWithAuth>
},
): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
const queryOptions = getAssetsHistoryListQueryOptions(parentLookupAsset, params, options)
const queryOptions = getAssetsHistoryListQueryOptions(uidAsset, params, options)

const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey }

Expand Down Expand Up @@ -573,42 +573,42 @@ export type assetsHistoryActionsRetrieveResponse = assetsHistoryActionsRetrieveR
headers: Headers
}

export const getAssetsHistoryActionsRetrieveUrl = (parentLookupAsset: string) => {
return `/api/v2/assets/${parentLookupAsset}/history/actions/`
export const getAssetsHistoryActionsRetrieveUrl = (uidAsset: string) => {
return `/api/v2/assets/${uidAsset}/history/actions/`
}

export const assetsHistoryActionsRetrieve = async (
parentLookupAsset: string,
uidAsset: string,
options?: RequestInit,
): Promise<assetsHistoryActionsRetrieveResponse> => {
return fetchWithAuth<assetsHistoryActionsRetrieveResponse>(getAssetsHistoryActionsRetrieveUrl(parentLookupAsset), {
return fetchWithAuth<assetsHistoryActionsRetrieveResponse>(getAssetsHistoryActionsRetrieveUrl(uidAsset), {
...options,
method: 'GET',
})
}

export const getAssetsHistoryActionsRetrieveQueryKey = (parentLookupAsset: string) => {
return ['api', 'v2', 'assets', parentLookupAsset, 'history', 'actions'] as const
export const getAssetsHistoryActionsRetrieveQueryKey = (uidAsset: string) => {
return ['api', 'v2', 'assets', uidAsset, 'history', 'actions'] as const
}

export const getAssetsHistoryActionsRetrieveQueryOptions = <
TData = Awaited<ReturnType<typeof assetsHistoryActionsRetrieve>>,
TError = ErrorDetail | ErrorObject,
>(
parentLookupAsset: string,
uidAsset: string,
options?: {
query?: UseQueryOptions<Awaited<ReturnType<typeof assetsHistoryActionsRetrieve>>, TError, TData>
request?: SecondParameter<typeof fetchWithAuth>
},
) => {
const { query: queryOptions, request: requestOptions } = options ?? {}

const queryKey = queryOptions?.queryKey ?? getAssetsHistoryActionsRetrieveQueryKey(parentLookupAsset)
const queryKey = queryOptions?.queryKey ?? getAssetsHistoryActionsRetrieveQueryKey(uidAsset)

const queryFn: QueryFunction<Awaited<ReturnType<typeof assetsHistoryActionsRetrieve>>> = ({ signal }) =>
assetsHistoryActionsRetrieve(parentLookupAsset, { signal, ...requestOptions })
assetsHistoryActionsRetrieve(uidAsset, { signal, ...requestOptions })

return { queryKey, queryFn, enabled: !!parentLookupAsset, ...queryOptions } as UseQueryOptions<
return { queryKey, queryFn, enabled: !!uidAsset, ...queryOptions } as UseQueryOptions<
Awaited<ReturnType<typeof assetsHistoryActionsRetrieve>>,
TError,
TData
Expand All @@ -624,13 +624,13 @@ export function useAssetsHistoryActionsRetrieve<
TData = Awaited<ReturnType<typeof assetsHistoryActionsRetrieve>>,
TError = ErrorDetail | ErrorObject,
>(
parentLookupAsset: string,
uidAsset: string,
options?: {
query?: UseQueryOptions<Awaited<ReturnType<typeof assetsHistoryActionsRetrieve>>, TError, TData>
request?: SecondParameter<typeof fetchWithAuth>
},
): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
const queryOptions = getAssetsHistoryActionsRetrieveQueryOptions(parentLookupAsset, options)
const queryOptions = getAssetsHistoryActionsRetrieveQueryOptions(uidAsset, options)

const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey }

Expand Down Expand Up @@ -669,15 +669,15 @@ export type assetsHistoryExportCreateResponse = assetsHistoryExportCreateRespons
headers: Headers
}

export const getAssetsHistoryExportCreateUrl = (parentLookupAsset: string) => {
return `/api/v2/assets/${parentLookupAsset}/history/export/`
export const getAssetsHistoryExportCreateUrl = (uidAsset: string) => {
return `/api/v2/assets/${uidAsset}/history/export/`
}

export const assetsHistoryExportCreate = async (
parentLookupAsset: string,
uidAsset: string,
options?: RequestInit,
): Promise<assetsHistoryExportCreateResponse> => {
return fetchWithAuth<assetsHistoryExportCreateResponse>(getAssetsHistoryExportCreateUrl(parentLookupAsset), {
return fetchWithAuth<assetsHistoryExportCreateResponse>(getAssetsHistoryExportCreateUrl(uidAsset), {
...options,
method: 'POST',
})
Expand All @@ -690,14 +690,14 @@ export const getAssetsHistoryExportCreateMutationOptions = <
mutation?: UseMutationOptions<
Awaited<ReturnType<typeof assetsHistoryExportCreate>>,
TError,
{ parentLookupAsset: string },
{ uidAsset: string },
TContext
>
request?: SecondParameter<typeof fetchWithAuth>
}): UseMutationOptions<
Awaited<ReturnType<typeof assetsHistoryExportCreate>>,
TError,
{ parentLookupAsset: string },
{ uidAsset: string },
TContext
> => {
const mutationKey = ['assetsHistoryExportCreate']
Expand All @@ -707,13 +707,12 @@ export const getAssetsHistoryExportCreateMutationOptions = <
: { ...options, mutation: { ...options.mutation, mutationKey } }
: { mutation: { mutationKey }, request: undefined }

const mutationFn: MutationFunction<
Awaited<ReturnType<typeof assetsHistoryExportCreate>>,
{ parentLookupAsset: string }
> = (props) => {
const { parentLookupAsset } = props ?? {}
const mutationFn: MutationFunction<Awaited<ReturnType<typeof assetsHistoryExportCreate>>, { uidAsset: string }> = (
props,
) => {
const { uidAsset } = props ?? {}

return assetsHistoryExportCreate(parentLookupAsset, requestOptions)
return assetsHistoryExportCreate(uidAsset, requestOptions)
}

return { mutationFn, ...mutationOptions }
Expand All @@ -727,7 +726,7 @@ export const useAssetsHistoryExportCreate = <TError = ErrorDetail | ErrorObject,
mutation?: UseMutationOptions<
Awaited<ReturnType<typeof assetsHistoryExportCreate>>,
TError,
{ parentLookupAsset: string },
{ uidAsset: string },
TContext
>
request?: SecondParameter<typeof fetchWithAuth>
Expand Down
Loading