OSS: `Gzip-Compression-Level` header parameter missing on `/backup/metadata`
还没有人认领这个 Issue。
评估
- 难度
- 1/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 85/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 冷清
- 技术栈
- openapi
- 领域
- api, documentation
调研方向
比较 src/oss/paths/backup_metadata.yml 和 src/oss/paths/backup_shards_shardID.yml，然后检查所有类似的 Cloud 路径，以确定 header 是否适用于那里。将文档中记录的 Gzip-Compression-Level 参数添加到元数据操作中，并将更改提升到 docs-release/influxdb-oss，使已发布的 v2 API 参考包含两个端点。
由索引模型根据 Issue 内容生成。
描述
Summary
The Gzip-Compression-Level request header parameter, added to the OSS
spec in influxdata/openapi#652 (commit influxdata/openapi@e48e733), is
applied only to the GET /backup/shards/{shardID} operation. It should
also be applied to GET /backup/metadata.
Why this matters
The corresponding implementations in influxd and influx-cli set the
Gzip-Compression-Level header on both backup endpoints — so the
spec under-documents the feature.
- Server:
influxdata/influxdb#27297adds the header on
GET /api/v2/backup/shards/:shardIDand
GET /api/v2/backup/metadata. - CLI:
influxdata/influx-cli#574(clients/backup/backup.go) sets the
header on the metadata download request and on each shard download
request.
Without this fix, the rendered v2 API reference will show the new
compression option on the shard endpoint only, omitting it from the
metadata endpoint that uses the same flag from the CLI.
Suggested change
In src/oss/paths/backup_metadata.yml (and any analogous Cloud paths
if the feature applies there), add the Gzip-Compression-Level header
parameter mirroring the block in src/oss/paths/backup_shards_shardID.yml:
- in: header
name: Gzip-Compression-Level
description: The gzip compression level to use when compressing the response.
schema:
type: string
enum:
- none
- default
- speedy
- full
Once merged on master, please also promote to
docs-release/influxdb-oss so it lands in the published v2 API
reference.
Context
Surfaced while documenting InfluxDB OSS 2.9.0 backup gzip compression
for influxdata/DAR#682. The DAR docs PR will reference the new
--gzip-compression-level flag and the HTTP header on both endpoints
in prose; this issue tracks the spec work needed for the API reference
to match.
cc @influxdata/edge
- 主要语言
- Shell
- 星标
- 18
- 派生
- 9
- 平均合并
- 2 天 18 小时
- 30 天内合并 PR
- 1
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
influxdata/openapi 的其他 Issue
-
Add missing Cloud Routes keys可能已有人在做 @jstirnaman 于 5 天前认领。 未关闭
难度 1/5 1 小时以内 新手友好度 85/100
influxdata/openapi#660 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 76/100
influxdata/openapi#657 ·
-
难度 1/5 1 小时以内 新手友好度 65/100
influxdata/openapi#240 ·
-
Update /ready and /health schemas for v2.10可能已有人在做 @devanbenz 于 5 天前认领。 未关闭
influxdata/openapi#659 · 1 条评论 · 已指派 2 人 ·
-
难度 4/5 3-5 天 新手友好度 25/100
influxdata/openapi#636 ·
查看 influxdata/openapi 的全部 Issue
相似的 Issue
-
area:contributor-experience difficulty:easy good first issue Stellar Wave
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 2 天内回复
-
package-update
难度 2/5 1-3 小时 新手友好度 62/100
oSoWoSo/vOid_Community_repOsitory#436 · 1 条评论 ·
维护者通常 1 天内回复
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 78/100
Maki-Zeninn/stellar-router#1485 ·
维护者通常 1 天内回复
-
Pin pnpm 9 with a packageManager field可能已有人在做 @Rohit-Solanki1890 今天认领。 未关闭devops dx good first issue
难度 1/5 1 小时以内 新手友好度 82/100
StellarLock/StellarLock#980 · 2 条评论 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
hestiacp/hestiacp#5798 · 2 条评论 ·
维护者通常 1 天内回复