Skip to content

feat: Document support for brotli compression#2750

Merged
mixalturek merged 1 commit into
masterfrom
brotli-compression
Jul 9, 2026
Merged

feat: Document support for brotli compression#2750
mixalturek merged 1 commit into
masterfrom
brotli-compression

Conversation

@mixalturek

@mixalturek mixalturek commented Jul 8, 2026

Copy link
Copy Markdown
Contributor
  • https://github.com/apify/apify-core/pull/28971 added support for brotli compression to BE.
  • Key value store endpoints didn't support it recently. I guess this was a bug in doc, but it's all good now :-)
  • Dataset items endpoints support it as well now.
  • I put brotli at the beginning of the lists, it should be the first choice whenever possible.

Related PRs

- apify/apify-core#28971 added support for brotli compression to BE.
- Key value store endpoints didn't support it recently. I guess this was a bug in doc, but it's all good now :-)
- Dataset items endpoints support it as well now.
- I put brotli at the beginning of the lists, it should be the first choice whenever possible.
@apify-service-account

apify-service-account commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🗑️ Preview for this PR was deleted.

@apify-service-account

Copy link
Copy Markdown
Contributor

Important

Action required@mixalturek please coordinate this docs PR with the Python API client PR linked below.

Because this PR modifies the OpenAPI specification, the generated models in apify-client-python must be regenerated to stay in sync. This has already been done automatically:

A companion PR has been opened in apify-client-python with the regenerated models: apify/apify-client-python#928

  • Please make sure to review and merge both PRs together to keep the OpenAPI spec and API clients in sync.
  • You can ask for review and help from the Tooling team if needed.

@nmanerikar nmanerikar left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it might be apt to have one person from the Technical Writers' team on apify-docs reviews
cc: @szaganek

mixalturek added a commit to apify/apify-client-js that referenced this pull request Jul 9, 2026
- apify/apify-core#28971 added support for
brotli compression to BE.
- Pros: higher compression, cons: more CPU intensive.
- The code could be running on too old Node.js, so brotli compression is
applied only if possible; the code otherwise falls back to gzip. Too
small payloads and unsupported types are still not compressed - no
change.

### Related PRs
- apify/apify-core#28971
- apify/apify-docs#2750
- #962
- apify/apify-client-python#927
- apify/apify-sdk-python#1031
mixalturek pushed a commit to apify/apify-client-python that referenced this pull request Jul 9, 2026
> [!IMPORTANT]
> **Replace this PR title and description before merging.**
> - Title: a Conventional Commits message describing the actual model
changes (e.g. `chore: ...` for a routine sync, or
`refactor:`/`feat:`/`fix:` when models meaningfully change).
> - Description: summarize what changed in the models.

- Updates the auto-generated Pydantic models and TypedDicts based on the
proposed OpenAPI specification changes.
- Based on apify-docs PR
[#2750](apify/apify-docs#2750).
@mixalturek

Copy link
Copy Markdown
Contributor Author

I think it might be apt to have one person from the Technical Writers' team on apify-docs reviews cc: @szaganek

It's good enough, merging ;-)

@mixalturek mixalturek merged commit 3d2cad8 into master Jul 9, 2026
18 checks passed
@mixalturek mixalturek deleted the brotli-compression branch July 9, 2026 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants