"Incoming request cf properties" should include information about minimum required plan levels about cloudflare-docs HOT 4 CLOSED

We should update https://developers.cloudflare.com/workers/runtime-apis/request#incomingrequestcfproperties to indicate which properties are available contingent on the developer's plan level, and label those properties with the minimum plan level required to have access to them.

This information was present in the previous docs at https://github.com/cloudflare/workers-docs/blob/master/workers-docs/src/content/reference/apis/request.md .

from cloudflare-docs.

@adamschwartz I could use some help deciding on the best way to solve this.

Some properties of IncomingRequestCfProperties are only populated for users on Biz or higher plans (for mostly-legacy reasons, but changing that is out of scope and a longer conversation). An example is city here: https://developers.cloudflare.com/workers/runtime-apis/request#incomingrequestcfproperties

It's currently represented like:

<Definitions>

- `city` <Type>string | null</Type>

  - City of the incoming request, e.g. `"Austin"`.

</Definitions>

I don't want to go back to the old world of grouping properties by plan type; I'd prefer to find a way to annotate this definition to indicate that Business is the minimum plan for which it's available, and have explanatory content elsewhere on the page explaining the details of this distinction.

What do you think we should do? Add text content to the end of each definition describing the minimum plan level, if one exists? Use a PropMeta or similar entity to describe the minimum plan next to the term itself?

from cloudflare-docs.

Thanks @ispivey for the great context.

I would recommend using a <PropMeta/> for now:

<Definitions>

- `city` <Type>string | null</Type> <PropMeta>Paid-plan only</PropMeta>

  - City of the incoming request, e.g. `"Austin"`.

</Definitions>

(Replace “Paid-plan only” with whatever is appropriate.)

Please just @ me on the PR and include a screenshot. If it feels like something special is warranted, like a <PlansTag/>, I can always whip one up.

Thanks

from cloudflare-docs.

Resolved by #569

from cloudflare-docs.