influxdata / influxdata/openapi

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

Offen Anfängerfreundlich
#653 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Shell
Sterne
18
Forks
9
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Vergleiche src/oss/paths/backup_metadata.yml mit src/oss/paths/backup_shards_shardID.yml und untersuche anschließend alle analogen Cloud-Pfade, um festzustellen, ob der Header dort gilt. Füge der Metadatenoperation den dokumentierten Gzip-Compression-Level-Parameter hinzu und übertrage die Änderung nach docs-release/influxdb-oss, damit die veröffentlichte v2 API-Referenz beide Endpunkte enthält.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
openapi
Bereich
api, documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Ruhig
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
85/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.