feat: expose capability and catalog documentation
This commit is contained in:
@@ -70,6 +70,20 @@ export type DocsSource = {
|
||||
};
|
||||
};
|
||||
|
||||
export type DocsSourceDetail = DocsSource & {
|
||||
visibility: {
|
||||
documentation_types: string[];
|
||||
required_modules: string[];
|
||||
any_modules: string[];
|
||||
missing_modules: string[];
|
||||
required_capabilities: string[];
|
||||
required_scopes: string[];
|
||||
any_scopes: string[];
|
||||
configuration_keys: string[];
|
||||
};
|
||||
inspection: Record<string, unknown>;
|
||||
};
|
||||
|
||||
export type DocsDocumentationCondition = {
|
||||
required_modules: string[];
|
||||
any_modules: string[];
|
||||
@@ -186,3 +200,18 @@ export function fetchDocsContext(settings: ApiSettings, options: { documentation
|
||||
const query = params.toString();
|
||||
return apiFetch(settings, `/api/v1/docs/context${query ? `?${query}` : ""}`);
|
||||
}
|
||||
|
||||
export function fetchDocsSource(
|
||||
settings: ApiSettings,
|
||||
sourceId: string,
|
||||
options: { documentationType?: "admin" | "user"; locale?: string } = {}
|
||||
): Promise<DocsSourceDetail> {
|
||||
const params = new URLSearchParams();
|
||||
if (options.documentationType) params.set("type", options.documentationType);
|
||||
if (options.locale) params.set("locale", options.locale);
|
||||
const query = params.toString();
|
||||
return apiFetch(
|
||||
settings,
|
||||
`/api/v1/docs/sources/${encodeURIComponent(sourceId)}${query ? `?${query}` : ""}`
|
||||
);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user