Skip to content

[Style guide] Placeholder variables #21377

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

Merged
merged 1 commit into from
Apr 3, 2025
Merged

[Style guide] Placeholder variables #21377

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions src/content/docs/style-guide/api-content-strategy/guidelines-for-curl-commands.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To automatically incorporate our conventions into your examples, use:
- [`APIRequest`](/style-guide/components/api-request/): For examples hitting endpoints in the Cloudflare API schema.
- [`CURL`](/style-guide/components/curl/): For other cURL commands.

## Paramter names
## Parameter names

Use long parameter names for clarity:

Expand Down Expand Up @@ -45,7 +45,7 @@ If you must suggest the use of this tool, you can add a link to the [Make API ca

* Make sure not to use typographical or smart quotes in a cURL command, or the command will fail.
* Placeholders in the URL should follow the same format as in the API documentation: `$ZONE_ID`
* Placeholders in the request body (that is, the data included in a `POST`/`PUT`/`PATCH` request) should use this format: `<RULE_ID>`
* Placeholders in the request body (that is, the data included in a `POST`/`PUT`/`PATCH` request) should use [angle brackets](/style-guide/formatting/code-conventions-and-format/#angle-brackets---and--): `<RULE_ID>`

The same placeholder name should correspond to the same value – use different placeholder names for different ID values. You can use the same request placeholders in the response, if they should match the values in the request.

Expand Down
18 changes: 7 additions & 11 deletions src/content/docs/style-guide/formatting/code-conventions-and-format.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@ Use the conventions described below throughout Cloudflare product content.

## Angle brackets ( `<` and `>` )

Use angle brackets as a placeholder for variables you want the user to enter (except in URLs, where you should use curly braces for placeholders).
Use angle brackets to denote placeholders for variables you want the user to enter (except in [API URLs and API authentication headers](/style-guide/api-content-strategy/guidelines-for-curl-commands/#request-guidelines), where you should use the `$ZONE_ID` / `$CLOUDFLARE_API_TOKEN` format). Placeholder text should have all capital letters and use underscores (`_`) to separate words.

Example:

Type your user-specified domain in this format: `https://<user-specified domain>.cloudflare.com`
Examples:

```
{
"description": "<RULE_DESCRIPTION>"
}
```

```
https://<YOUR_DOMAIN>.cloudflare.com
```

Angle brackets that contain numbers separated by an ellipsis represent a range of values associated with a bit or single name - for example, AO `<0...3>`.

## Square brackets ( `[` and `]` )
Expand All @@ -32,13 +34,7 @@ Specify a subsearch that starts with this search command: `tag=dns query [search

## Curly braces ( `{` and `}` )

Use curly braces in the following situations, such as:

When they are part of a code sample or other string literal, such as in placeholders inside a URL.

Example:

`https://api.cloudflare.com/client/v4/organizations/{organization_identifier}/invites`
Do not use curly braces for URL or variable placeholders. Instead, refer to [angle brackets](#angle-brackets---and--).

## >

Expand Down
Loading