Skip to content

[API Shield] updates API Gateway to API Shield #21719

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Apr 15, 2025
Merged

[API Shield] updates API Gateway to API Shield #21719

merged 3 commits into from
Apr 15, 2025

Conversation

patriciasantaana
Copy link
Contributor

@patriciasantaana patriciasantaana commented Apr 15, 2025 •
edited
Loading

Summary

Updates API Gateway to API Shield (aside from token permissions or role names)

Documentation checklist

@hyperlint-ai Hyperlint AI
Copy link
Contributor

hyperlint-ai bot commented Apr 15, 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 references from API Gateway to API Shield across various documentation files, ensuring consistency in terminology and improving clarity regarding the product's features and capabilities.

  • Replaced all mentions of 'API Gateway' with 'API Shield' in the documentation.
  • Updated links to point to the correct API Shield resources instead of API Gateway.
  • Adjusted the order of sidebar items for better navigation in the API Shield documentation.

Modified Files

  • src/content/changelog/audit-logs/2025-03-27-automatic-audit-logs-beta-release.mdx
  • src/content/docs/api-shield/index.mdx
  • src/content/docs/api-shield/management-and-monitoring/index.mdx
  • src/content/docs/api-shield/plans.mdx
  • src/content/docs/api-shield/reference/index.mdx
  • src/content/docs/api-shield/security/schema-validation/index.mdx
  • src/content/docs/data-localization/metadata-boundary/graphql-datasets.mdx
  • src/content/docs/reference-architecture/architectures/multi-vendor.mdx
  • src/content/docs/reference-architecture/architectures/security.mdx
  • src/content/docs/reference-architecture/design-guides/secure-application-delivery.mdx
  • src/content/docs/reference-architecture/diagrams/iot/optimizing-and-securing-connected-transportation-systems.mdx
  • src/content/docs/reference-architecture/diagrams/serverless/serverless-global-apis.mdx
  • src/content/docs/ruleset-engine/reference/phases-list.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.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Apr 15, 2025 •
edited
Loading

Preview URL: https://a6a8e5ce.preview.developers.cloudflare.com
Preview Branch URL: https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/reference-architecture/architectures/security/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/reference-architecture/architectures/security/
https://developers.cloudflare.com/api-shield/plans/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/api-shield/plans/
https://developers.cloudflare.com/reference-architecture/diagrams/iot/optimizing-and-securing-connected-transportation-systems/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/reference-architecture/diagrams/iot/optimizing-and-securing-connected-transportation-systems/
https://developers.cloudflare.com/api-shield/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/api-shield/
https://developers.cloudflare.com/api-shield/security/schema-validation/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/api-shield/security/schema-validation/
https://developers.cloudflare.com/reference-architecture/design-guides/secure-application-delivery/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/reference-architecture/design-guides/secure-application-delivery/
https://developers.cloudflare.com/changelog/2025-03-27-automatic-audit-logs-beta-release/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/changelog/2025-03-27-automatic-audit-logs-beta-release/
https://developers.cloudflare.com/data-localization/metadata-boundary/graphql-datasets/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/data-localization/metadata-boundary/graphql-datasets/
https://developers.cloudflare.com/reference-architecture/architectures/multi-vendor/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/reference-architecture/architectures/multi-vendor/
https://developers.cloudflare.com/reference-architecture/diagrams/serverless/serverless-global-apis/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/reference-architecture/diagrams/serverless/serverless-global-apis/
https://developers.cloudflare.com/ruleset-engine/reference/phases-list/ https://patricia-pcx16958-gway-shield.preview.developers.cloudflare.com/ruleset-engine/reference/phases-list/

@patriciasantaana patriciasantaana marked this pull request as ready for review April 15, 2025 16:41
@patriciasantaana patriciasantaana merged commit 4666cc6 into production Apr 15, 2025
11 checks passed
@patriciasantaana patriciasantaana deleted the patricia/pcx16958-gway-shield branch April 15, 2025 20:02
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
@patriciasantaana @RebeccaTamachiro
[API Shield] updates API Gateway to API Shield (#21719)
3c33d45 
* updates API Gateway name to API Shield

* spacing

* add back api gateway page
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kodster28 kodster28 kodster28 approved these changes

@securitypedant securitypedant Awaiting requested review from securitypedant securitypedant is a code owner

@haleycode haleycode Awaiting requested review from haleycode haleycode is a code owner

@pedrosousa pedrosousa Awaiting requested review from pedrosousa pedrosousa is a code owner

@soheiokamoto soheiokamoto Awaiting requested review from soheiokamoto soheiokamoto is a code owner

@angelampcosta angelampcosta Awaiting requested review from angelampcosta angelampcosta is a code owner

@GregBrimble GregBrimble Awaiting requested review from GregBrimble

@KianNH KianNH Awaiting requested review from KianNH

@WalshyDev WalshyDev Awaiting requested review from WalshyDev

Assignees

@pedrosousa pedrosousa

@soheiokamoto soheiokamoto

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@securitypedant securitypedant

@haleycode haleycode

@angelampcosta angelampcosta

@KianNH KianNH

Labels
product:api-shield product:data-localization product:reference-architecture product:ruleset-engine size/s
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@patriciasantaana @kodster28 @pedrosousa @soheiokamoto @GregBrimble @WalshyDev @securitypedant @haleycode @angelampcosta @KianNH