influxdata / influxdata/openapi

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

Aperta Adatta ai principianti
#653 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Shell
Stelle
18
Fork
9
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

## 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`:

```yaml
- 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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Confronta src/oss/paths/backup_metadata.yml con src/oss/paths/backup_shards_shardID.yml, quindi esamina i percorsi Cloud analoghi per determinare se l’header si applica anche lì. Aggiungi il parametro documentato Gzip-Compression-Level all’operazione sui metadati e promuovi la modifica a docs-release/influxdb-oss, in modo che il riferimento API v2 pubblicato includa entrambi gli endpoint.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
openapi
Ambito
api, documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
1-3 ore
Stato di attività
Tranquilla
Chiarezza
Specificata chiaramente
Idoneità per principianti
85/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.