Files
zooqueen 252e1cb076 Generated clients call the API where it is mounted
`insights/mount.py` is explicit: `/v1/` is the mount and `/api/` is the older
spelling, kept on the wire for released CLI builds and personal-API-key
holders and rewritten once at the edge by `ApiRewriteMiddleware`. Our own
frontend was still on the older spelling: the orval clients were generated
two days before the mount moved and the move did not regenerate them, so 70
files and 2323 paths said `/api/`.

That is not only a spelling. `prepareUrl` in `lib/api.ts` rewrites `/v1/*` to
the selected region's host in OAuth mode and nothing else, because that is
what the cloud CORS allowlist covers — so every generated call quietly stayed
same-origin, and `getExportsContentRetrieveUrl` builds an `<img src>` that
never reaches `lib/api.ts` at all.

The clients are regenerated from a spec that needs postgres, the datastore and
Django, so this is the path strings only, which is the whole of what the mount
move changes in them: orval copies paths verbatim from the spec, and the spec
takes them from the URLconf. Doc comments carried the same stale prefix and
move with them; their Python docstrings already say `/v1/`. The two frozen
OAuth client-metadata paths are identifiers rather than API surface and appear
in none of these files.

The Slack task prompt told the agent to POST to
`$INSIGHTS_API_URL/api/projects/...`, which is a live request path, not prose.
2026-08-24 23:13:08 -07:00

241 lines
8.0 KiB
TypeScript
Generated

import { apiMutator } from '../../../../frontend/src/lib/api-orval-mutator'
/**
* Auto-generated from the Django backend OpenAPI schema.
* To modify these types, update the Django serializers or views, then run:
* insightscli build:openapi
* Questions or issues? #team-devex on Slack
*
* Insights API - generated
* OpenAPI spec version: 1.0.0
*/
import type {
CreateGroupApi,
GroupApi,
GroupsActivityRetrieveParams,
GroupsDeletePropertyCreateParams,
GroupsFindRetrieveParams,
GroupsListParams,
GroupsRelatedRetrieveParams,
GroupsUpdatePropertyCreateParams,
} from './api.schemas'
// https://stackoverflow.com/questions/49579094/typescript-conditional-types-filter-out-readonly-properties-pick-only-requir/49579497#49579497
type IfEquals<X, Y, A = X, B = never> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? A : B
type WritableKeys<T> = {
[P in keyof T]-?: IfEquals<{ [Q in P]: T[P] }, { -readonly [Q in P]: T[P] }, P>
}[keyof T]
type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never
type DistributeReadOnlyOverUnions<T> = T extends any ? NonReadonly<T> : never
type Writable<T> = Pick<T, WritableKeys<T>>
type NonReadonly<T> = [T] extends [UnionToIntersection<T>]
? {
[P in keyof Writable<T>]: T[P] extends object ? NonReadonly<NonNullable<T[P]>> : T[P]
}
: DistributeReadOnlyOverUnions<T>
export const getGroupsListUrl = (projectId: string, params: GroupsListParams) => {
const normalizedParams = new URLSearchParams()
Object.entries(params || {}).forEach(([key, value]) => {
if (value !== undefined) {
normalizedParams.append(key, value === null ? 'null' : String(value))
}
})
const stringifiedParams = normalizedParams.toString()
return stringifiedParams.length > 0
? `/v1/projects/${projectId}/groups/?${stringifiedParams}`
: `/v1/projects/${projectId}/groups/`
}
/**
* List all groups of a specific group type. You must pass ?group_type_index= in the URL.
* To get a list of valid group types, call /v1/:project_id/groups_types/.
*
* Uses forward-only keyset pagination via the `cursor` parameter.
* The `previous` field in the response envelope is always null.
*/
export const groupsList = async (
projectId: string,
params: GroupsListParams,
options?: RequestInit
): Promise<GroupApi[]> => {
return apiMutator<GroupApi[]>(getGroupsListUrl(projectId, params), {
...options,
method: 'GET',
})
}
export const getGroupsCreateUrl = (projectId: string) => {
return `/v1/projects/${projectId}/groups/`
}
export const groupsCreate = async (
projectId: string,
createGroupApi: CreateGroupApi,
options?: RequestInit
): Promise<GroupApi> => {
return apiMutator<GroupApi>(getGroupsCreateUrl(projectId), {
...options,
method: 'POST',
headers: { 'Content-Type': 'application/json', ...options?.headers },
body: JSON.stringify(createGroupApi),
})
}
export const getGroupsActivityRetrieveUrl = (projectId: string, params: GroupsActivityRetrieveParams) => {
const normalizedParams = new URLSearchParams()
Object.entries(params || {}).forEach(([key, value]) => {
if (value !== undefined) {
normalizedParams.append(key, value === null ? 'null' : String(value))
}
})
const stringifiedParams = normalizedParams.toString()
return stringifiedParams.length > 0
? `/v1/projects/${projectId}/groups/activity/?${stringifiedParams}`
: `/v1/projects/${projectId}/groups/activity/`
}
export const groupsActivityRetrieve = async (
projectId: string,
params: GroupsActivityRetrieveParams,
options?: RequestInit
): Promise<void> => {
return apiMutator<void>(getGroupsActivityRetrieveUrl(projectId, params), {
...options,
method: 'GET',
})
}
export const getGroupsDeletePropertyCreateUrl = (projectId: string, params: GroupsDeletePropertyCreateParams) => {
const normalizedParams = new URLSearchParams()
Object.entries(params || {}).forEach(([key, value]) => {
if (value !== undefined) {
normalizedParams.append(key, value === null ? 'null' : String(value))
}
})
const stringifiedParams = normalizedParams.toString()
return stringifiedParams.length > 0
? `/v1/projects/${projectId}/groups/delete_property/?${stringifiedParams}`
: `/v1/projects/${projectId}/groups/delete_property/`
}
export const groupsDeletePropertyCreate = async (
projectId: string,
groupApi: NonReadonly<GroupApi>,
params: GroupsDeletePropertyCreateParams,
options?: RequestInit
): Promise<void> => {
return apiMutator<void>(getGroupsDeletePropertyCreateUrl(projectId, params), {
...options,
method: 'POST',
headers: { 'Content-Type': 'application/json', ...options?.headers },
body: JSON.stringify(groupApi),
})
}
export const getGroupsFindRetrieveUrl = (projectId: string, params: GroupsFindRetrieveParams) => {
const normalizedParams = new URLSearchParams()
Object.entries(params || {}).forEach(([key, value]) => {
if (value !== undefined) {
normalizedParams.append(key, value === null ? 'null' : String(value))
}
})
const stringifiedParams = normalizedParams.toString()
return stringifiedParams.length > 0
? `/v1/projects/${projectId}/groups/find/?${stringifiedParams}`
: `/v1/projects/${projectId}/groups/find/`
}
export const groupsFindRetrieve = async (
projectId: string,
params: GroupsFindRetrieveParams,
options?: RequestInit
): Promise<void> => {
return apiMutator<void>(getGroupsFindRetrieveUrl(projectId, params), {
...options,
method: 'GET',
})
}
export const getGroupsPropertyValuesRetrieveUrl = (projectId: string) => {
return `/v1/projects/${projectId}/groups/property_values/`
}
export const groupsPropertyValuesRetrieve = async (projectId: string, options?: RequestInit): Promise<void> => {
return apiMutator<void>(getGroupsPropertyValuesRetrieveUrl(projectId), {
...options,
method: 'GET',
})
}
export const getGroupsRelatedRetrieveUrl = (projectId: string, params: GroupsRelatedRetrieveParams) => {
const normalizedParams = new URLSearchParams()
Object.entries(params || {}).forEach(([key, value]) => {
if (value !== undefined) {
normalizedParams.append(key, value === null ? 'null' : String(value))
}
})
const stringifiedParams = normalizedParams.toString()
return stringifiedParams.length > 0
? `/v1/projects/${projectId}/groups/related/?${stringifiedParams}`
: `/v1/projects/${projectId}/groups/related/`
}
export const groupsRelatedRetrieve = async (
projectId: string,
params: GroupsRelatedRetrieveParams,
options?: RequestInit
): Promise<void> => {
return apiMutator<void>(getGroupsRelatedRetrieveUrl(projectId, params), {
...options,
method: 'GET',
})
}
export const getGroupsUpdatePropertyCreateUrl = (projectId: string, params: GroupsUpdatePropertyCreateParams) => {
const normalizedParams = new URLSearchParams()
Object.entries(params || {}).forEach(([key, value]) => {
if (value !== undefined) {
normalizedParams.append(key, value === null ? 'null' : String(value))
}
})
const stringifiedParams = normalizedParams.toString()
return stringifiedParams.length > 0
? `/v1/projects/${projectId}/groups/update_property/?${stringifiedParams}`
: `/v1/projects/${projectId}/groups/update_property/`
}
export const groupsUpdatePropertyCreate = async (
projectId: string,
groupApi: NonReadonly<GroupApi>,
params: GroupsUpdatePropertyCreateParams,
options?: RequestInit
): Promise<void> => {
return apiMutator<void>(getGroupsUpdatePropertyCreateUrl(projectId, params), {
...options,
method: 'POST',
headers: { 'Content-Type': 'application/json', ...options?.headers },
body: JSON.stringify(groupApi),
})
}