influxdata / influxdata/openapi

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

Ouverte Adaptée aux débutants
#653 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Shell
Étoiles
18
Forks
9
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Comparez src/oss/paths/backup_metadata.yml avec src/oss/paths/backup_shards_shardID.yml, puis examinez les chemins Cloud analogues afin de déterminer si le header s’y applique. Ajoutez le paramètre documenté Gzip-Compression-Level à l’opération de métadonnées et promouvez la modification vers docs-release/influxdb-oss afin que la référence d’API v2 publiée inclue les deux endpoints.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
openapi
Domaine
api, documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
1-3 heures
Activité
Calme
Clarté
Clairement spécifiée
Accessibilité débutants
85/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.