kbs: ITA: Documentation update. #675
Open
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
szymon-klimek
force-pushed
the
sklimek/change_default_policy_ids_behavior
branch
from
058279c to
7cd9fc3
Compare
szymon-klimek
changed the title
Documentation of parameters `policy_ids` and `allow_unmatched_policy` updated to be more descriptive. Signed-off-by: szymon.klimek <[email protected]>
szymon-klimek
force-pushed
the
sklimek/change_default_policy_ids_behavior
branch
from
7cd9fc3 to
617943f
Compare
mythi
reviewed
Jan 24, 2025
| | `api_key` | String | Intel Trust Authority API key. | Yes | - | | ||
| | `certs_file` | String | URL to an Intel Trust Authority portal or path to JWKS file used for token verification. | Yes | - | | ||
| | `policy_ids` | String array | Quoted and comma-separated list of policy IDs defined in ITA portal. | No | `[]` | | ||
| | `allow_unmatched_policy` | Boolean | If `policy_ids` is not specified, parameter is ignored and ignores result of policy matching. <br/> Otherwise, define whether result of policy matching should be ignored. | No | false | |
There was a problem hiding this comment.
Suggested change
| | `allow_unmatched_policy` | Boolean | If `policy_ids` is not specified, parameter is ignored and ignores result of policy matching. <br/> Otherwise, define whether result of policy matching should be ignored. | No | false | | |
| | `allow_unmatched_policy` | Boolean | If `policy_ids` is empty, this setting is ignored. By default, the listed policies must always match. Enabling this flag relaxes that requirement. | No | false | |
There was a problem hiding this comment.
In my opinion By default here is misleading, beacuse by default policy_ids are empty
so the true default behavior is that policies does not have to match
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.
Documentation of parameters
policy_idsandallow_unmatched_policyupdated to be more descriptive.