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

docs(policy): swagger document update #67

Conversation

AnuragNagpure
Copy link
Contributor

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.

  • I have followed the contributing guidelines
  • I have performed a self-review of my own code
  • I have successfully tested my changes locally
  • I have added tests that prove my changes work
  • I have checked that new and existing tests pass locally with my changes
  • I have commented my code, particularly in hard-to-understand areas
  • I have added copyright and license headers, footers (for .md files) or files (for images)

@Phil91 Phil91 merged commit e0a4b2c into eclipse-tractusx:dev Mar 25, 2024
9 checks passed
@Phil91 Phil91 deleted the doc/65-policy-swagger-documentation-update branch March 25, 2024 12:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants