influxdata / influxdata/openapi
OSS: `Gzip-Compression-Level` header parameter missing on `/backup/metadata`
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Shell
- Star
- 18
- Fork
- 9
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
## 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
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
So sánh src/oss/paths/backup_metadata.yml với src/oss/paths/backup_shards_shardID.yml, sau đó kiểm tra mọi đường dẫn Cloud tương tự để xác định liệu header có áp dụng ở đó hay không. Thêm tham số Gzip-Compression-Level đã được tài liệu hóa vào thao tác metadata và promote thay đổi lên docs-release/influxdb-oss để tài liệu tham chiếu API v2 được phát hành bao gồm cả hai endpoint.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- openapi
- Lĩnh vực
- api, documentation
- Loại issue
- Tài liệu
- Độ khó
- 1/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 85/100