[INTERNAL] csp: Update documentation for sap-csp-policies target level increase #792
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
codeworrior
reviewed
Feb 24, 2023
| @@ -33,7 +33,7 @@ E.g. `/index.html?sap-ui-xx-csp-policy=sap-target-level-1:report-only` | |||
|
|
|||
| #### The SAPtargetCSP parameter | |||
| The default CSP policies can be modified using parameter `sendSAPTargetCSP` (`--sap-csp-policies` when using the CLI). | |||
| With `sendSAPTargetCSP` set to `true` the policies `sap-target-level-1` and `sap-target-level-2` policies are activated and send as report-only. | |||
| With `sendSAPTargetCSP` set to `true` the policies `sap-target-level-1` and `sap-target-level-3` policies are activated and send as report-only. | |||
There was a problem hiding this comment.
two comments from my side regarding the text outside your change:
- the title says
SAPtargetCSPparameter, but there's no such parameter, it'ssendSAPtargetCSP(from a CLI user's perspective) - the next paragraph below says
!!! info This option is available since UI5 CLI v2.3.0
Can't we remove that hint in version 3? I think it was necessary in v2, but v3 it doesn't make much sense to me.
And one comment to the changed text itself:
do we explain the policies anywhere? Other than the name suggests, these are not well-established terms within SAP. We've just picked those names in our code / configuration.
There was a problem hiding this comment.
No, I think we currently don't have explanation for the policies. They need to be checked in the code.
I addressed the other two points.
codeworrior
approved these changes
Feb 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
See: SAP/ui5-server#580