Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix(api): propagate showSecuritySchemes to content generation 

Add showSecuritySchemes field handling to generate-openapi-articles.ts
to ensure the flag is written to content frontmatter. Regenerate API
docs for cloud-dedicated and clustered products.
claude/api-code-samples-plan-MEkQO
Jason Stirnaman 2025-12-29 15:19:33 -06:00
parent a392b95f28
commit 64c3d7b028
7 changed files with 1275 additions and 1290 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1249
api-docs/scripts/dist/generate-openapi-articles.js vendored
View File

File diff suppressed because it is too large Load Diff

1276
api-docs/scripts/dist/openapi-paths-to-hugo-data/index.js vendored
View File

File diff suppressed because it is too large Load Diff

7
api-docs/scripts/generate-openapi-articles.ts
View File

@ -367,6 +367,7 @@ function generateTagPagesFromArticleData(
description?: string;
tag?: string;
isConceptual?: boolean;
showSecuritySchemes?: boolean;
tagDescription?: string;
menuGroup?: string;
staticFilePath?: string;
@ -461,6 +462,11 @@ ${yaml.dump(parentFrontmatter)}---
frontmatter.tagDescription = article.fields.tagDescription;
}
// Add showSecuritySchemes flag for authentication pages
if (article.fields.showSecuritySchemes) {
frontmatter.showSecuritySchemes = true;
}
// Note: We deliberately don't add menu entries for tag-based API pages.
// The API sidebar navigation (api/sidebar-nav.html) handles navigation
// for API reference pages, avoiding conflicts with existing menu items
@ -552,6 +558,7 @@ function generateOperationPages(options: GenerateOperationPagesOptions): void {
title?: string;
tag?: string;
isConceptual?: boolean;
showSecuritySchemes?: boolean;
staticFilePath?: string;
operations?: OperationMeta[];
related?: string[];

4
data/article_data/influxdb/cloud-dedicated/articles.json
View File

@ -22,8 +22,8 @@
"Tables",
"Database tokens"
],
"source": "static/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml",
"staticFilePath": "/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml"
"source": "static/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml",
"staticFilePath": "/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml"
}
}
]

4
data/article_data/influxdb/cloud-dedicated/articles.yml
View File

@ -19,6 +19,6 @@ articles:
- Tables
- Database tokens
source: >-
static/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml
static/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml
staticFilePath: >-
/openapi/influxdb-cloud-dedicated/paths/openapi-accounts-{accountId}-clusters.yaml
/openapi/influxdb-cloud-dedicated/paths/influxdb-cloud-dedicated-accounts-{accountId}-clusters.yaml

12
data/article_data/influxdb/clustered/articles.json
View File

@ -16,8 +16,8 @@
"apiTags": [
"Tables"
],
"source": "static/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml",
"staticFilePath": "/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml"
"source": "static/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml",
"staticFilePath": "/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml"
}
},
{
@ -37,8 +37,8 @@
"apiTags": [
"Databases"
],
"source": "static/openapi/influxdb-clustered/paths/openapi-databases.yaml",
"staticFilePath": "/openapi/influxdb-clustered/paths/openapi-databases.yaml"
"source": "static/openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml",
"staticFilePath": "/openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml"
}
},
{
@ -58,8 +58,8 @@
"apiTags": [
"Database tokens"
],
"source": "static/openapi/influxdb-clustered/paths/openapi-tokens.yaml",
"staticFilePath": "/openapi/influxdb-clustered/paths/openapi-tokens.yaml"
"source": "static/openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml",
"staticFilePath": "/openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml"
}
}
]

13
data/article_data/influxdb/clustered/articles.yml
View File

@ -12,9 +12,9 @@ articles:
apiTags:
- Tables
source: >-
static/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml
static/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml
staticFilePath: >-
/openapi/influxdb-clustered/paths/openapi-databases-{databaseName}-tables.yaml
/openapi/influxdb-clustered/paths/influxdb-clustered-databases-{databaseName}-tables.yaml
- path: api/databases
fields:
name: /databases
@ -28,8 +28,9 @@ articles:
- databases
apiTags:
- Databases
source: static/openapi/influxdb-clustered/paths/openapi-databases.yaml
staticFilePath: /openapi/influxdb-clustered/paths/openapi-databases.yaml
source: >-
static/openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml
staticFilePath: /openapi/influxdb-clustered/paths/influxdb-clustered-databases.yaml
- path: api/tokens
fields:
name: /tokens
@ -43,5 +44,5 @@ articles:
- tokens
apiTags:
- Database tokens
source: static/openapi/influxdb-clustered/paths/openapi-tokens.yaml
staticFilePath: /openapi/influxdb-clustered/paths/openapi-tokens.yaml
source: static/openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml
staticFilePath: /openapi/influxdb-clustered/paths/influxdb-clustered-tokens.yaml