Skip to content

Conversation

@daisyfaithauma
Copy link
Contributor

Summary

  • json endpoint docs

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.

@daisyfaithauma daisyfaithauma requested review from a team, celso, danielgek and mchenco as code owners March 20, 2025 14:49
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 20, 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

Added documentation for the new JSON endpoint that extracts structured data from webpages.

  • Introduced a new JSON endpoint documentation for structured data extraction.
  • Detailed parameters for the JSON endpoint including usage examples.
  • Provided potential use-cases for the JSON endpoint.

Added Files

  • src/content/docs/browser-rendering/rest-api/json-endpoint.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.

@kathayl
Copy link
Contributor

kathayl commented Mar 31, 2025

we're starting to have a TON of endpoints (whoooo!)
image
wondering if it would help devs navigate if we added like the (/links, or /json, or /pdf) to the sidebar here to help people navigate directly to an endpoint if they know what endpoint they're looking for)

daisyfaithauma and others added 5 commits March 31, 2025 17:37
added note about incurring workers ai usage when using json endpoint
fix collapsing and get rid of random highlighting
get rid of random highlighting
@kathayl kathayl merged commit 939c5fd into production Apr 4, 2025
11 checks passed
@kathayl kathayl deleted the json branch April 4, 2025 00:03
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* json endpoint docs

* reorder

* docs: Update JSON endpoint documentation with new examples and structure

* docs: Add links endpoint

* minor edits

* collapsed lines

* title

* Update json-endpoint.mdx

added note about incurring workers ai usage when using json endpoint

* Update json-endpoint.mdx

fix collapsing and get rid of random highlighting

* Update links-endpoint.mdx

get rid of random highlighting

---------

Co-authored-by: Omar Mohammad <[email protected]>
Co-authored-by: Kathy <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants