influxdata / influxdata/openapi
OSS: `Gzip-Compression-Level` header parameter missing on `/backup/metadata`
Ninguém assumiu esta issue ainda.
- Linguagem predominante
- Shell
- Estrelas
- 18
- Forks
- 9
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
## 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
Guia de contribuição
Nenhum guia de contribuição indexado para este repositório
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Direção de pesquisa
Compare src/oss/paths/backup_metadata.yml com src/oss/paths/backup_shards_shardID.yml e, em seguida, inspecione quaisquer caminhos Cloud análogos para determinar se o header se aplica a eles. Adicione o parâmetro documentado Gzip-Compression-Level à operação de metadados e promova a alteração para docs-release/influxdb-oss, para que a referência da API v2 publicada inclua ambos os endpoints.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- openapi
- Domínio
- api, documentation
- Tipo de issue
- Documentação
- Dificuldade
- 1/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Pouca atividade
- Clareza
- Claramente especificada
- Facilidade para iniciantes
- 85/100