[CF1] partial front matter edit #22905
Conversation
|
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 SummaryUpdated the documentation for custom certificates to clarify the parameters used in the API calls.
Modified Files
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 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 |
![windsurf-bot[bot]](https://avatars.githubusercontent.com/in/1066231?s=60&v=4){kind=small}
| <TabItem label="API"> | ||
|
|
||
| 1. <Render file="upload-mtls-cert" params={{ one: " ", cert: "root CA" }} /> | ||
| 1. <Render file="upload-mtls-cert" params={{ key: " ", cert: "root CA" }} /> |
There was a problem hiding this comment.
The parameter in the <Render> component was changed from one to key. Please confirm that key is the correct parameter expected by the upload-mtls-cert file, as this change could affect the rendered output or functionality.
| file="upload-mtls-cert" | ||
| params={{ | ||
| one: "The private key is only required if you are using this custom certificate for Gateway HTTPS inspection.", | ||
| key: "The private key is only required if you are using this custom certificate for Gateway HTTPS inspection.", |
There was a problem hiding this comment.
The parameter name in the Render component was changed from 'one' to 'key'. Please confirm that the Render component expects 'key' and not 'one', as this could break the UI or documentation rendering if not updated everywhere.
| inputParameters: param1 | ||
| params: | ||
| - cert | ||
| - key? |
There was a problem hiding this comment.
The use of 'key?' in the params list is non-standard YAML. If you intend to indicate that 'key' is optional, consider documenting this in a comment or in the documentation body, rather than using a question mark in the key name.
|
This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:
|
4 participants
Summary
related to #22699
Screenshots (optional)
Documentation checklist