influxdata / influxdata/openapi

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

オープン 初心者向け
#653 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
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. リポジトリをフォークし、ブランチを切って変更します。
  4. 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 を短くまとめたダイジェスト。