docs(policy): swagger document update #67
Merged
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.
Description
Correct/Update the swagger docu of the policy hub.
Endpoint: /api/policy-hub/policy-types
Endpoint: /api/policy-hub/policy-content
Endpoint: /api/policy-hub/policy-content
Why
Endpoint: /api/policy-hub/policy-types
Type: GET
update the summary of the endpoint to "Provides all current supported policy types incl. a policy description and useCase link"
Endpoint: /api/policy-hub/policy-content
Type: GET
update the summary of the endpoint to "Receive the policy template "access" or "usage" for a single policy rule based on the request parameters submitted by the user."
recheck if the parameter "UseCase" is really needed. Please analyse once for what the parameter is used; share the information with the Product Owner and agree on the next steps
Update the description of the endpoint parameter Type to "Policy type for which the policy is supposed to get created. Possible values: "Access" or "Usage""
Change the parameter name credential to PolicyName
Change the parameter name operatorId to operatorType
Update the description of the endpoint parameter operatorId to "Policy Rule operator. Possible values: "Equals" or "In""
Update the description of the endpoint parameter value to "OPTIONAL: Value to be used for the rightOperand"
Endpoint: /api/policy-hub/policy-content
Type: POST
update the summary of the endpoint to "Receive the policy template "access" or "usage" for multiple policy rule template based on the input request body."
Issue
#65
Checklist
Please delete options that are not relevant.