Skip to content

Commit 913674a

Browse files
capitalization (#20892)
1 parent b6868eb commit 913674a

File tree

18 files changed

+154
-154
lines changed

18 files changed

+154
-154
lines changed

src/content/docs/api-shield/api-gateway.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar:
99

1010
API Gateway is a package of features that will do everything for your APIs, including:
1111

12-
- **Security**: Protect your API from malicious traffic with [API Discovery](/api-shield/security/api-discovery/), [Schema Validation](/api-shield/security/schema-validation/), [mTLS validation](/api-shield/security/mtls/), and more.
12+
- **Security**: Protect your API from malicious traffic with [API Discovery](/api-shield/security/api-discovery/), [Schema validation](/api-shield/security/schema-validation/), [mTLS validation](/api-shield/security/mtls/), and more.
1313
- **Management and monitoring**: Streamline API management with [Endpoint Management](/api-shield/management-and-monitoring/) and [tools](https://blog.cloudflare.com/api-gateway/) like analytics, routing, and authentication.
1414
- **Logging, quota management, and more**: All of Cloudflare's [established features](https://blog.cloudflare.com/api-gateway/), like caching, load balancing, and log integrations work natively with API Gateway.
1515

src/content/docs/api-shield/frequently-asked-questions.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Not currently.
5959

6060
## What version of OpenAPI specification do you support?
6161

62-
The importing ([Schema Validation](/api-shield/security/schema-validation/)) and exporting ([Schema Learning](/api-shield/management-and-monitoring/#endpoint-schema-learning)) of OpenAPI schemas from our product to customers is done using **OpenAPI v3.0**. Any specifications using patched versions (3.0.x) are compatible as well.
62+
The importing ([Schema validation](/api-shield/security/schema-validation/)) and exporting ([Schema Learning](/api-shield/management-and-monitoring/#endpoint-schema-learning)) of OpenAPI schemas from our product to customers is done using **OpenAPI v3.0**. Any specifications using patched versions (3.0.x) are compatible as well.
6363

6464
---
6565

src/content/docs/api-shield/get-started.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,15 @@ Enabling API Shield features will have no impact on your traffic until you choos
2626

2727
<Render file="set-up-session-identifiers" />
2828

29-
## Upload a schema using Schema Validation (optional)
29+
## Upload a schema using Schema validation (optional)
3030

31-
Schema Validation protects your APIs by ensuring only requests matching your <GlossaryTooltip term="API schema">API schema</GlossaryTooltip> are allowed to communicate with your origin.
31+
Schema validation protects your APIs by ensuring only requests matching your <GlossaryTooltip term="API schema">API schema</GlossaryTooltip> are allowed to communicate with your origin.
3232

33-
While not strictly required, uploading a pre-existing schema will offer the chance to automatically add endpoints to Endpoint Management. If you already have a schema, you can upload it to [Schema Validation](/api-shield/security/schema-validation/).
33+
While not strictly required, uploading a pre-existing schema will offer the chance to automatically add endpoints to Endpoint Management. If you already have a schema, you can upload it to [Schema validation](/api-shield/security/schema-validation/).
3434

3535
:::note
3636

37-
It is recommended to start with Schema Validation rules set to `log` to review logged requests in **Security** > **Events**. When you are confident that only the correct requests are logged, you should switch the rule to `block`.
37+
It is recommended to start with Schema validation rules set to `log` to review logged requests in **Security** > **Events**. When you are confident that only the correct requests are logged, you should switch the rule to `block`.
3838
:::
3939

4040
If you do not have a schema to upload, continue reading this guide to learn how to generate a schema with API Shield.
@@ -56,10 +56,10 @@ Cloudflare’s machine learning models have already inspected your existing traf
5656

5757
:::note
5858

59-
Schema Validation, Schema Learning, JWT Validation, Sequence Analytics, Sequence Mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
59+
Schema validation, Schema Learning, JWT validation, Sequence Analytics, Sequence Mitigation, and rate limit recommendations only run on endpoints saved to Endpoint Management.
6060
:::
6161

62-
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema Validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/#add-endpoints-manually) by method, path, and host.
62+
You can save your endpoints directly from [API Discovery](/api-shield/management-and-monitoring/#add-endpoints-from-api-discovery), [Schema validation](/api-shield/management-and-monitoring/#add-endpoints-from-schema-validation), or [manually](/api-shield/management-and-monitoring/#add-endpoints-manually) by method, path, and host.
6363

6464
This will add the specified endpoints to your list of managed endpoints. You can view your list of saved endpoints in the **Endpoint Management** page.
6565

@@ -81,7 +81,7 @@ We recommend proceeding with [additional configurations](/api-shield/get-started
8181

8282
You can observe Cloudflare suggested rate limits in Endpoint Management for endpoints using session identifiers. Unlike many security tools, these recommended rate limits are per-endpoint and per-session, not site-wide and not based on IP address. When creating a rule, it will be based on only traffic to that specific endpoint from unique visitors during their session. This feature allows you to be very specific and targeted with your rate limit enforcement, both lowering abusive traffic and false positives due to broadly scoped rules.
8383

84-
## Import a learned schema to Schema Validation
84+
## Import a learned schema to Schema validation
8585

8686
Cloudflare learns schema parameters via traffic inspection for all endpoints stored in Endpoint Management. You can export OpenAPI schemas in OpenAPI v3.0.0 format by hostname.
8787

@@ -103,15 +103,15 @@ You can observe the top sequences in your API traffic that contain endpoints sto
103103

104104
[Sequence Mitigation](/api-shield/security/sequence-mitigation/) allows you to enforce request patterns for authenticated clients communicating with your API. Use Sequence Analytics to better understand the request sequences used by your API clients.
105105

106-
You should apply all possible API Shield protections (rate limiting suggestions, Schema Validation, JWT Validation, and mTLS) to API endpoints found in high correlation score sequences that make up the critical request flows in your application. You should also check their specific endpoint order with your development team.
106+
You should apply all possible API Shield protections (rate limiting suggestions, Schema validation, JWT validation, and mTLS) to API endpoints found in high correlation score sequences that make up the critical request flows in your application. You should also check their specific endpoint order with your development team.
107107

108108
For more information, refer to [Detecting API abuse automatically using sequence analysis](https://blog.cloudflare.com/api-sequence-analytics) blog post.
109109

110110
## Additional configuration
111111

112-
### Set up JSON Web Tokens (JWT) Validation
112+
### Set up JSON Web Tokens (JWT) validation
113113

114-
Use the Cloudflare API to configure [JSON Web Tokens Validation](/api-shield/security/jwt-validation/), which validates the integrity and validity of JWTs sent by clients to your API or web application.
114+
Use the Cloudflare API to configure [JSON Web Tokens validation](/api-shield/security/jwt-validation/), which validates the integrity and validity of JWTs sent by clients to your API or web application.
115115

116116
### Set up GraphQL Malicious Query Protection
117117

src/content/docs/api-shield/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ A package of features that will do everything for your APIs.
4040

4141
Cloudflare API Security products are available to Enterprise customers only, though anyone can set up [Mutual TLS](/api-shield/security/mtls/) with a Cloudflare-managed certificate authority.
4242

43-
The full API Shield security suite is available as an Enterprise-only paid add-on, but all customers can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema Validation](/api-shield/security/schema-validation/) functionalities.
43+
The full API Shield security suite is available as an Enterprise-only paid add-on, but all customers can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema validation](/api-shield/security/schema-validation/) functionalities.
4444

4545
## Related products
4646

src/content/docs/api-shield/management-and-monitoring/developer-portal.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Once <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> are saved
2222

2323
If you do not have a schema to upload or to select from a pre-existing schema, export your Endpoint Management schema. For best results, include the learned parameters.
2424

25-
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema Validation 2.0 are available when selecting existing schemas
25+
Only <GlossaryTooltip term="API schema">API schemas</GlossaryTooltip> uploaded to Schema validation 2.0 are available when selecting existing schemas
2626
:::
2727

2828
5. Select **Download project files** to save a local copy of the files that will be uploaded to Cloudflare Pages. Downloading the project files can be helpful if you wish to modify the project in any way and then upload the new version manually to Pages.

src/content/docs/api-shield/management-and-monitoring/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ When an endpoint is using [Cloudflare Workers](/workers/), the metrics data will
2929

3030
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com/login) and select your account and domain.
3131
2. Select **Security** > **API Shield**.
32-
3. Add your endpoints [manually](#add-endpoints-manually), from [Schema Validation](#add-endpoints-from-schema-validation), or from [API Discovery](#add-endpoints-from-api-discovery).
32+
3. Add your endpoints [manually](#add-endpoints-manually), from [Schema validation](#add-endpoints-from-schema-validation), or from [API Discovery](#add-endpoints-from-api-discovery).
3333

3434
## Add endpoints from API Discovery
3535

@@ -47,9 +47,9 @@ There are two ways to add API endpoints from Discovery.
4747
2. Select the discovered endpoints you would like to add.
4848
3. Select **Save selected endpoints**.
4949

50-
## Add endpoints from Schema Validation
50+
## Add endpoints from Schema validation
5151

52-
1. Add a schema by [configuring Schema Validation](/api-shield/security/schema-validation/).
52+
1. Add a schema by [configuring Schema validation](/api-shield/security/schema-validation/).
5353
2. On **Review schema endpoints**, save new endpoints to endpoint management by checking the box.
5454
3. Select **Save as draft** or **Save and Deploy**. Endpoints will be saved regardless of whether the Schema is saved as a draft or published.
5555

@@ -106,7 +106,7 @@ You can delete endpoints one at a time or in bulk.
106106

107107
Cloudflare learns schema parameters via traffic inspection. For all endpoints saved to Endpoint Management, you can export OpenAPI schemas in `v3.0.0` format by hostname. You can also include learned schema parameters.
108108

109-
To protect your API with a learned schema, refer to [Schema Validation](/api-shield/security/schema-validation/#add-validation-by-applying-a-learned-schema-to-an-entire-hostname).
109+
To protect your API with a learned schema, refer to [Schema validation](/api-shield/security/schema-validation/#add-validation-by-applying-a-learned-schema-to-an-entire-hostname).
110110

111111
### Export a schema
112112

src/content/docs/api-shield/plans.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ sidebar:
77

88
---
99

10-
Free, Pro, Business, and Enterprise customers without an API Gateway subcription can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema Validation](/api-shield/security/schema-validation/), but no other [API Gateway](/api-shield/api-gateway/) features.
10+
Free, Pro, Business, and Enterprise customers without an API Gateway subscription can access [Endpoint Management](/api-shield/management-and-monitoring/) and [Schema validation](/api-shield/security/schema-validation/), but no other [API Gateway](/api-shield/api-gateway/) features.
1111

1212
To subscribe to API Gateway, upgrade to an Enterprise plan and contact your account team.
1313

14-
Limits to endpoints apply to Endpoint Management and Schema Validation. Refer to the table below for limits based on your zone plan.
14+
Limits to endpoints apply to Endpoint Management and Schema validation. Refer to the table below for limits based on your zone plan.
1515

1616
| Plan type | Saved endpoints | Uploaded schemas | Total uploaded schema size | Rule action |
1717
| --- | --- | --- | --- | --- |
Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,56 @@
11
---
2-
title: Classic Schema Validation (deprecated)
2+
title: Classic Schema validation (deprecated)
33
pcx_content_type: how-to
44
type: overview
55
head:
66
- tag: title
7-
content: Configure Classic Schema Validation (deprecated)
7+
content: Configure Classic Schema validation (deprecated)
88
sidebar:
99
badge:
1010
text: Deprecated
1111
order: 1
12-
label: Classic Schema Validation
12+
label: Classic Schema validation
1313

1414
---
1515

1616
import { GlossaryTooltip } from "~/components"
1717

1818
:::caution[Deprecation notice]
19-
Classic Schema Validation has been deprecated.
19+
Classic Schema validation has been deprecated.
2020

21-
Upload all new schemas to [Schema Validation 2.0](/api-shield/security/schema-validation/).
21+
Upload all new schemas to [Schema validation 2.0](/api-shield/security/schema-validation/).
2222
:::
2323

24-
Use the **API Shield** interface to configure [API Schema Validation](/api-shield/security/schema-validation/), which validates requests according to the <GlossaryTooltip term="API schema">API schema</GlossaryTooltip> you provide.
24+
Use the **API Shield** interface to configure [API Schema validation](/api-shield/security/schema-validation/), which validates requests according to the <GlossaryTooltip term="API schema">API schema</GlossaryTooltip> you provide.
2525

26-
Before you can configure Schema Validation for an API, you must obtain an API Schema file matching our [specifications](/api-shield/security/schema-validation/#specifications).
26+
Before you can configure Schema validation for an API, you must obtain an API Schema file matching our [specifications](/api-shield/security/schema-validation/#specifications).
2727

28-
If you are in the Schema Validation 2.0, you can make changes to your settings but you cannot add any new Classic Schema Validation schemas.
28+
If you are in the Schema validation 2.0, you can make changes to your settings but you cannot add any new Classic Schema validation schemas.
2929

3030
:::note
3131

3232
This feature is only available for customers on an Enterprise plan. Contact your Cloudflare Customer Success Manager to get access.
3333
:::
3434

35-
## Create an API Shield with Schema Validation
35+
## Create an API Shield with Schema validation
3636

37-
To configure Schema Validation in the Cloudflare dashboard:
37+
To configure Schema validation in the Cloudflare dashboard:
3838

3939
1. Log in to the [Cloudflare dashboard](https://dash.cloudflare.com) and select your account and domain.
4040
2. Select **Security** > **API Shield**.
41-
3. Go to **Schema Validation** and select **Add schema**.
42-
4. Enter a descriptive name for your policy and optionally edit the expression to trigger Schema Validation. For example, if your API is available at `http://api.example.com/v1`, include a check for the *Hostname* field — equal to `api.example.com` — and a check for the *URI Path* field using a regular expression — matching the regex `^/v1`.
41+
3. Go to **Schema validation** and select **Add schema**.
42+
4. Enter a descriptive name for your policy and optionally edit the expression to trigger Schema validation. For example, if your API is available at `http://api.example.com/v1`, include a check for the *Hostname* field — equal to `api.example.com` — and a check for the *URI Path* field using a regular expression — matching the regex `^/v1`.
4343
:::caution[Important]
4444

4545
To validate the hostname, you must include the *Hostname* field explicitly in the rule, even if the hostname value is in the schema file. Any hostname value present in the schema file will be ignored.
4646
:::
4747
5. Select **Next**.
4848
6. Upload your schema file.
49-
7. Select **Save** to validate the content of the schema file and deploy the Schema Validation rule. If you get a validation error, ensure that you are using one of the [supported file formats](/api-shield/security/schema-validation/#specifications) and that each endpoint and method pair has a unique operation ID.
49+
7. Select **Save** to validate the content of the schema file and deploy the Schema validation rule. If you get a validation error, ensure that you are using one of the [supported file formats](/api-shield/security/schema-validation/#specifications) and that each endpoint and method pair has a unique operation ID.
5050

5151
After deploying your API Shield rule, Cloudflare displays a summary of all <GlossaryTooltip term="API endpoint">API endpoints</GlossaryTooltip> organized by their protection level and actions that will occur for non-compliant and unprotected requests.
5252

53-
1. In the **Endpoint action** dropdown, select an action for every request that targets a protected endpoint and fails Schema Validation.
53+
1. In the **Endpoint action** dropdown, select an action for every request that targets a protected endpoint and fails Schema validation.
5454
2. In the **Fallthrough action** dropdown, select an action for every request that targets an unprotected endpoint.
5555
3. Optionally, you can save the endpoints to Endpoint Management at the same time the Schema is saved by selecting **Save new endpoints to [endpoint management](/api-shield/management-and-monitoring/)**. Endpoints will be saved regardless of whether the Schema is saved as a draft or published live.
5656
4. Select **Done**.

src/content/docs/api-shield/reference/terraform.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ The following resources are available to configure through Terraform:
1818

1919
- [`api_shield_operation`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_operation) for configuring <GlossaryTooltip term="API endpoint">endpoints</GlossaryTooltip> in Endpoint Management.
2020

21-
**Schema Validation 2.0**
21+
**Schema validation 2.0**
2222

23-
- [`api_shield_schema`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema) for configuring a schema in [Schema Validation 2.0](/api-shield/security/schema-validation/).
24-
- [`api_shield_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema_validation_settings) for configuring zone-level Schema Validation 2.0 settings.
25-
- [`api_shield_operation_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_operation_schema_validation_settings) for configuring operation-level Schema Validation 2.0 settings.
23+
- [`api_shield_schema`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema) for configuring a schema in [Schema validation 2.0](/api-shield/security/schema-validation/).
24+
- [`api_shield_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_schema_validation_settings) for configuring zone-level Schema validation 2.0 settings.
25+
- [`api_shield_operation_schema_validation_settings`](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs/resources/api_shield_operation_schema_validation_settings) for configuring operation-level Schema validation 2.0 settings.
2626

2727
## Manage API Shield session identifiers
2828

@@ -58,14 +58,14 @@ resource "cloudflare_api_shield_operation" "post_image" {
5858
}
5959
```
6060

61-
## Manage Schema Validation 2.0
61+
## Manage Schema validation 2.0
6262

6363
:::note
6464

65-
It is required to configure Endpoint Management if you want to set up Schema Validation 2.0 using Terraform.
65+
It is required to configure Endpoint Management if you want to set up Schema validation 2.0 using Terraform.
6666
:::
6767

68-
Refer to the example configuration below to manage [Schema Validation 2.0](/api-shield/security/schema-validation/configure/) on your zone.
68+
Refer to the example configuration below to manage [Schema validation 2.0](/api-shield/security/schema-validation/configure/) on your zone.
6969

7070
```tf title="Example configuration"
7171
# Schema that should be used for schema validation 2.0

0 commit comments

Comments
 (0)