influxdata / influxdata/openapi

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

Abierto Apto para principiantes
#653 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Shell
Estrellas
18
Forks
9
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Compara src/oss/paths/backup_metadata.yml con src/oss/paths/backup_shards_shardID.yml y, a continuación, inspecciona las rutas de Cloud análogas para determinar si el header se aplica allí. Añade el parámetro documentado Gzip-Compression-Level a la operación de metadatos y promueve el cambio a docs-release/influxdb-oss para que la referencia de la API v2 publicada incluya ambos endpoints.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
openapi
Área
api, documentation
Tipo de issue
Documentación
Dificultad
1/5
Tiempo estimado
1-3 horas
Estado de actividad
Tranquilo
Claridad
Bien especificado
Aptitud para principiantes
85/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.