influxdata / influxdata/openapi

OSS: `Gzip-Compression-Level` header parameter missing on `/backup/metadata`

未关闭 适合新手
#653 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
Shell
星标
18
派生
9
PR 合并指标
30 天内没有已合并 PR

描述

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#27297 adds the header on
    GET /api/v2/backup/shards/:shardID and
    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

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

比较 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 内容生成。

评估

技术栈
openapi
领域
api, documentation
Issue 类型
文档
难度
1/5
预计耗时
1-3 小时
活跃度
冷清
描述清晰度
描述清楚
新手友好度
85/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。