feat: Adds gzip compression level param to spec#652
Merged
Conversation
devanbenz
requested review from
Copilot and
jstirnaman
and removed request for
a team and
jstirnaman
There was a problem hiding this comment.
Pull request overview
Updates the OSS OpenAPI spec for the shard backup download endpoint to allow callers to control gzip compression strength via a request header.
Changes:
- Adds a
Gzip-Compression-Levelrequest header parameter toGET /backup/shards/{shardID}.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
jstirnaman
approved these changes
Mar 24, 2026
jstirnaman
added a commit
that referenced
this pull request
Apr 30, 2026
Promotes pending master commits to the OSS docs-release branch ahead of the InfluxDB OSS 2.9.0 release. Includes #652 (Gzip-Compression-Level parameter on /backup/shards/{shardID}) — the spec change backing the backup gzip compression docs in influxdata/DAR#682. Refs influxdata/DAR#682.
jstirnaman
added a commit
to influxdata/docs-v2
that referenced
this pull request
Apr 30, 2026
Add v2.9.0 release notes and supporting docs for the InfluxDB OSS 2.9.0 release. Token hashing default change: - Add v2.9.0 release notes section with "Before you upgrade" callout, disable / opt-out guidance, and backup/restore workflow note. - Flip the use-hashed-tokens default in the config-options reference from false to true; rewrite intro and examples to reflect the new default. - Add a Token hashing section to admin/tokens/ covering version defaults, startup behavior, opt-out, downgrade considerations, and recovery for lost tokens. - Add a sitewide notification scoped to /influxdb/v2 and a cascade prepend on the /influxdb/v2 landing page that surface the change on every page in the v2 doc tree. - Register --use-hashed-tokens in data/influxd_flags.yml so it appears in the influxd flag list. Backup gzip compression: - Document the new server-side Gzip-Compression-Level header and the influx backup --gzip-compression-level flag (influx-cli 2.8.0+) in the admin backup page and the shared CLI reference, including the --compression coupling. - Note the regenerated v2 OpenAPI bundle in api-docs/, produced by api-docs/getswagger.sh after promoting influxdata/openapi#652 to docs-release/influxdb-oss. The /backup/metadata operation is still missing the parameter; tracked in influxdata/openapi#653. Restore --operator-token: - Document the new --operator-token flag (influx-cli 2.8.0+) in the admin restore page and the shared CLI reference, with explicit guidance for restoring backups whose operator token is hashed. EDR replication: - Note the new maxAgeSeconds bounds (60s–60d, 0 = use default) in the v2.9.0 release notes. Version metadata: - Bump data/products.yml: latest v2.8 -> v2.9, latest_patches.v2 2.8.0 -> 2.9.0, latest_cli.v2 2.7.5 -> 2.8.0. Refs influxdata/DAR#682
jstirnaman
added a commit
to influxdata/docs-v2
that referenced
this pull request
Apr 30, 2026
Add v2.9.0 release notes and supporting docs for the InfluxDB OSS 2.9.0 release. Token hashing default change: - Add v2.9.0 release notes section with "Before you upgrade" callout, disable / opt-out guidance, and backup/restore workflow note. - Flip the use-hashed-tokens default in the config-options reference from false to true; rewrite intro and examples to reflect the new default. - Add a Token hashing section to admin/tokens/ covering version defaults, startup behavior, opt-out, downgrade considerations, and recovery for lost tokens. - Add a sitewide notification scoped to /influxdb/v2 and a cascade prepend on the /influxdb/v2 landing page that surface the change on every page in the v2 doc tree. - Register --use-hashed-tokens in data/influxd_flags.yml so it appears in the influxd flag list. Backup gzip compression: - Document the new server-side Gzip-Compression-Level header and the influx backup --gzip-compression-level flag (influx-cli 2.8.0+) in the admin backup page and the shared CLI reference, including the --compression coupling. - Note the regenerated v2 OpenAPI bundle in api-docs/, produced by api-docs/getswagger.sh after promoting influxdata/openapi#652 to docs-release/influxdb-oss. The /backup/metadata operation is still missing the parameter; tracked in influxdata/openapi#653. Restore --operator-token: - Document the new --operator-token flag (influx-cli 2.8.0+) in the admin restore page and the shared CLI reference, with explicit guidance for restoring backups whose operator token is hashed. EDR replication: - Note the new maxAgeSeconds bounds (60s–60d, 0 = use default) in the v2.9.0 release notes. Version metadata: - Bump data/products.yml: latest v2.8 -> v2.9, latest_patches.v2 2.8.0 -> 2.9.0, latest_cli.v2 2.7.5 -> 2.8.0. Refs influxdata/DAR#682
jstirnaman
added a commit
to influxdata/docs-v2
that referenced
this pull request
Apr 30, 2026
…rds endpoint
Surgical patch to api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml
adding the new Gzip-Compression-Level header parameter on
GET /api/v2/backup/shards/{shardID}, mirroring the upstream change in
influxdata/openapi#652.
The bundled YAML carries local Hugo-native customizations (title,
description, server URLs, tag descriptions with x-related doc links,
v2-scoped link paths) that get clobbered by api-docs/getswagger.sh.
Hand-applied here to preserve those customizations. The /backup/metadata
endpoint also receives this header in the server and CLI implementations
but is missing the parameter in the upstream spec; tracked in
influxdata/openapi#653.
Refs influxdata/DAR#682
jstirnaman
added a commit
to influxdata/docs-v2
that referenced
this pull request
May 1, 2026
* docs(influxdb/v2): document v2.9.0 release Add v2.9.0 release notes and supporting docs for the InfluxDB OSS 2.9.0 release. Token hashing default change: - Add v2.9.0 release notes section with "Before you upgrade" callout, disable / opt-out guidance, and backup/restore workflow note. - Flip the use-hashed-tokens default in the config-options reference from false to true; rewrite intro and examples to reflect the new default. - Add a Token hashing section to admin/tokens/ covering version defaults, startup behavior, opt-out, downgrade considerations, and recovery for lost tokens. - Add a sitewide notification scoped to /influxdb/v2 and a cascade prepend on the /influxdb/v2 landing page that surface the change on every page in the v2 doc tree. - Register --use-hashed-tokens in data/influxd_flags.yml so it appears in the influxd flag list. Backup gzip compression: - Document the new server-side Gzip-Compression-Level header and the influx backup --gzip-compression-level flag (influx-cli 2.8.0+) in the admin backup page and the shared CLI reference, including the --compression coupling. - Note the regenerated v2 OpenAPI bundle in api-docs/, produced by api-docs/getswagger.sh after promoting influxdata/openapi#652 to docs-release/influxdb-oss. The /backup/metadata operation is still missing the parameter; tracked in influxdata/openapi#653. Restore --operator-token: - Document the new --operator-token flag (influx-cli 2.8.0+) in the admin restore page and the shared CLI reference, with explicit guidance for restoring backups whose operator token is hashed. EDR replication: - Note the new maxAgeSeconds bounds (60s–60d, 0 = use default) in the v2.9.0 release notes. Version metadata: - Bump data/products.yml: latest v2.8 -> v2.9, latest_patches.v2 2.8.0 -> 2.9.0, latest_cli.v2 2.7.5 -> 2.8.0. Refs influxdata/DAR#682 * docs(influxdb/v2): add Gzip-Compression-Level parameter to backup shards endpoint Surgical patch to api-docs/influxdb/v2/influxdb-oss-v2-openapi.yaml adding the new Gzip-Compression-Level header parameter on GET /api/v2/backup/shards/{shardID}, mirroring the upstream change in influxdata/openapi#652. The bundled YAML carries local Hugo-native customizations (title, description, server URLs, tag descriptions with x-related doc links, v2-scoped link paths) that get clobbered by api-docs/getswagger.sh. Hand-applied here to preserve those customizations. The /backup/metadata endpoint also receives this header in the server and CLI implementations but is missing the parameter in the upstream spec; tracked in influxdata/openapi#653. Refs influxdata/DAR#682 * fix(influxdb/v2): correct broken #admin-token anchor in restore note Update the operator-token link in admin/backup-restore/restore.md from the non-existent `#admin-token` anchor to `#operator-token`, which matches the actual heading on the tokens page. The link prose still reads "admin token" as colloquial wording; only the anchor target is corrected here.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.