IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

RTK Clients: Fix namespace filter (#99949)

Browse Source 
* Fix namespace filter

* Update comment

* Update filter
This commit is contained in:
Alex Khomenko 2025-02-03 13:50:15 +02:00 committed by GitHub
parent b636b81b16
commit a0901456ae
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
scripts/process-specs.ts
View File

@ -18,8 +18,8 @@ function processOpenAPISpec(spec: OpenAPIV3.Document) {
// Process 'paths' property
const newPaths: Record<string, unknown> = {};
for (const [path, pathItem] of Object.entries<OpenAPIV3.PathItemObject>(newSpec.paths)) {
// Remove 'watch' paths as they're deprecated / remove empty path items
if (path.includes('/watch/') || !pathItem) {
// Remove empty path items
if (!pathItem) {
continue;
}
// Remove the specified part from the path key
@ -27,12 +27,13 @@ function processOpenAPISpec(spec: OpenAPIV3.Document) {
// Process each method in the path (e.g., get, post)
const newPathItem: Record<string, unknown> = {};
for (const method of Object.keys(pathItem)) {
// Filter out the 'namespace' param
if (method === 'parameters' && Array.isArray(pathItem.parameters)) {
pathItem.parameters = pathItem.parameters?.filter((param) => 'name' in param && param.name !== 'namespace');
}
// Filter out namespace parameter at path level
if (Array.isArray(pathItem.parameters)) {
pathItem.parameters = filterNamespaceParameters(pathItem.parameters);
}
for (const method of Object.keys(pathItem)) {
// eslint-disable-next-line @typescript-eslint/consistent-type-assertions
const operation = pathItem[method as keyof OpenAPIV3.PathItemObject];
@ -45,6 +46,16 @@ function processOpenAPISpec(spec: OpenAPIV3.Document) {
continue;
}
// Filter out namespace parameter at operation level
if (
operation &&
typeof operation === 'object' &&
'parameters' in operation &&
Array.isArray(operation.parameters)
) {
operation.parameters = filterNamespaceParameters(operation.parameters);
}
updateRefs(operation);
newPathItem[method] = operation;
@ -69,6 +80,13 @@ function processOpenAPISpec(spec: OpenAPIV3.Document) {
return newSpec;
}
/**
* Filter out namespace parameters from an array of parameters
*/
function filterNamespaceParameters(parameters: Array<OpenAPIV3.ReferenceObject | OpenAPIV3.ParameterObject>) {
return parameters.filter((param) => 'name' in param && param.name !== 'namespace');
}
/**
* Recursively update all $ref fields to remove k8s metadata from names
*/