Skip to content

[AIG]websockets new path #22038

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 7, 2025
Merged

[AIG]websockets new path #22038

merged 6 commits into from
May 7, 2025

Conversation

daisyfaithauma
Copy link
Contributor

Summary

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

Copy link
Contributor

hyperlint-ai bot commented Apr 28, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated the WebSockets API documentation with a new path and improved organization.

  • Renamed and reorganized the WebSockets API documentation files
  • Added an order parameter for better sidebar navigation
  • Clarified the structure of the AI Gateway WebSockets API

Renamed Files

  • src/content/docs/ai-gateway/websockets-api/index.mdx
  • src/content/docs/ai-gateway/websockets-api/non-realtime-api.mdx
  • src/content/docs/ai-gateway/websockets-api/realtime-api.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link
Contributor

github-actions bot commented Apr 28, 2025

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /ai-gateway/configuration/websockets-api/
  • /ai-gateway/configuration/websockets-api/non-realtime-api/
  • /ai-gateway/configuration/websockets-api/realtime-api/

@github-actions github-actions bot added the product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ label Apr 28, 2025
@github-actions github-actions bot added size/s and removed size/xs labels Apr 28, 2025
@daisyfaithauma daisyfaithauma marked this pull request as ready for review April 29, 2025 15:43
@daisyfaithauma daisyfaithauma changed the title [BRAPI}]websockets new path [AIG]websockets new path Apr 29, 2025
@github-actions github-actions bot removed product:browser-rendering product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ product:turnstile product:fundamentals product:radar product:support product:ddos-protection product:learning-paths product:style-guide product:automatic-platform-optimization product:kv product:workers-ai Workers AI: https://developers.cloudflare.com/workers-ai/ product:vectorize Vectorize: https://developers.cloudflare.com/vectorize/ product:hyperdrive Hyperdrive: https://developers.cloudflare.com/hyperdrive/ product:developer-spotlight product:workflows Workflows: https://developers.cloudflare.com/workflows/ product:pipelines product:google-tag-first-party-mode product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. product:security product:realtime product:google-tag-gateway labels May 7, 2025
Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
@daisyfaithauma daisyfaithauma enabled auto-merge (squash) May 7, 2025 14:36
@daisyfaithauma daisyfaithauma merged commit 14e3d93 into production May 7, 2025
12 checks passed
@daisyfaithauma daisyfaithauma deleted the websockets-new-path branch May 7, 2025 14:47
daisyfaithauma added a commit that referenced this pull request May 8, 2025
* websockets new path

* invalid links

* invalid links

* Update index.mdx

* Update src/content/docs/ai-gateway/websockets-api/index.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

---------

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
Maddy-Cloudflare pushed a commit that referenced this pull request May 9, 2025
* websockets new path

* invalid links

* invalid links

* Update index.mdx

* Update src/content/docs/ai-gateway/websockets-api/index.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

---------

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
daisyfaithauma added a commit that referenced this pull request May 13, 2025
* websockets new path

* invalid links

* invalid links

* Update index.mdx

* Update src/content/docs/ai-gateway/websockets-api/index.mdx

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>

---------

Co-authored-by: Pedro Sousa <680496+pedrosousa@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:ai-gateway AI Gateway: https://developers.cloudflare.com/ai-gateway/ size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants