Skip to content

[API Shield] JSON POST body formats #22112

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 3 commits into from
May 2, 2025

Conversation

patriciasantaana
Copy link
Contributor

@patriciasantaana patriciasantaana commented Apr 30, 2025

Summary

Add info on endpoint schema learning about JSON POST body formats being included in every learned schema + make schema learning a standalone page

Documentation checklist

Copy link
Contributor

hyperlint-ai bot commented Apr 30, 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 API Shield documentation to include information on JSON POST body formats in learned schemas.

  • Added information on JSON POST body formats to the endpoint schema documentation.
  • Updated the schema description to reflect the inclusion of POST body formats.

Modified Files

  • src/content/docs/api-shield/management-and-monitoring/index.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 30, 2025

Preview URL: https://8ed70e57.preview.developers.cloudflare.com
Preview Branch URL: https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/api-shield/management-and-monitoring/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/
https://developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-management/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-management/
https://developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-management/schema-learning/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-management/schema-learning/
https://developers.cloudflare.com/api-shield/management-and-monitoring/api-routing/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/api-routing/
https://developers.cloudflare.com/api-shield/management-and-monitoring/developer-portal/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/developer-portal/
https://developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-labels/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/endpoint-labels/
https://developers.cloudflare.com/api-shield/management-and-monitoring/session-identifiers/ https://patricia-pcx17224-json-post-em.preview.developers.cloudflare.com/api-shield/management-and-monitoring/session-identifiers/

:::note
The schema is saved as a JSON file in OpenAPI `v3.0.0` format.
:::

Copy link
Contributor Author

@patriciasantaana patriciasantaana May 1, 2025

Choose a reason for hiding this comment

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

Lines 26-47 of this page is new content

@patriciasantaana patriciasantaana marked this pull request as ready for review May 1, 2025 22:44
@patriciasantaana patriciasantaana requested a review from a team as a code owner May 1, 2025 22:44
@patriciasantaana patriciasantaana merged commit 462d788 into production May 2, 2025
10 of 12 checks passed
@patriciasantaana patriciasantaana deleted the patricia/pcx17224-json-post-em branch May 2, 2025 00:34
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.

2 participants