Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Swagger Documentation Update #65

Closed
jjeroch opened this issue Mar 10, 2024 · 1 comment
Closed

Swagger Documentation Update #65

jjeroch opened this issue Mar 10, 2024 · 1 comment
Assignees

Comments

@jjeroch
Copy link
Contributor

jjeroch commented Mar 10, 2024

Summary

Correct/Update the swagger docu of the policy hub.

Details

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."
@jjeroch jjeroch added this to Portal Mar 10, 2024
@github-project-automation github-project-automation bot moved this to NEW USER REQUEST in Portal Mar 10, 2024
@jjeroch jjeroch moved this from NEW USER REQUEST to BACKLOG in Portal Mar 10, 2024
@jjeroch
Copy link
Contributor Author

jjeroch commented Mar 13, 2024

@AnuragNagpure let me know in case you have questions regarding the requirement.
Note: this is not the backend repo - its the policy hub - you likely need to first of all update your local dev connection
Code wise phil is the expert ;)

@AnuragNagpure AnuragNagpure moved this from BACKLOG to IN PROGRESS in Portal Mar 14, 2024
Phil91 pushed a commit that referenced this issue Mar 25, 2024
* swagger document updated

---------------
Refs: #65 
Reviewed-By: Phil Schneider <[email protected]>
@AnuragNagpure AnuragNagpure moved this from IN PROGRESS to IN REVIEW in Portal Mar 26, 2024
@jjeroch jjeroch moved this from IN REVIEW to USER READY in Portal Jul 13, 2024
@jjeroch jjeroch closed this as completed Jul 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants