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.

Sign up for GitHub

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

Jump to bottom

fix(jans-config-api): agama deployment endpoints not conforming with the projects API style #4048

Closed
moabu opened this issue Mar 7, 2023 · 1 comment · Fixed by #4147
Closed

fix(jans-config-api): agama deployment endpoints not conforming with the projects API style #4048

moabu opened this issue Mar 7, 2023 · 1 comment · Fixed by #4147
Assignees
@jgomer2001 @pujavs
Labels
comp-jans-config-api Component affected by issue or PR kind-bug Issue or PR is a bug in existing functionality
Milestone
1.0.10

Comments

@moabu
Copy link
Member

moabu commented Mar 7, 2023

There is two main nonconformities in the agama deployment endpoints:

  1. All other API endpoints have the ID as a path parameter, here it is a query parameter. If there is no hard evidence that can lead to this style change this should be changed to path as well. The effected endpoints are :
  • /api/v1/agama-deployment GET POST DELETE
  • /api/v1/agama-deployment/list GET
  1. According to the openAPI definition, getting a deployment requires three different scopes: agama.readonly, agama.write, read-all. Every other API call has a one scope to one operation mapping . Why is this different ?
@mo-auto mo-auto added comp-jans-config-api Component affected by issue or PR kind-bug Issue or PR is a bug in existing functionality labels Mar 7, 2023
@moabu moabu modified the milestones: 1.0.9, 1.0.10 Mar 7, 2023
@pujavs
Copy link
Contributor

pujavs commented Mar 10, 2023 •
edited
Loading

  1. Modified endpoints to replace query parameter with path parameter for
  • /api/v1/agama-deployment/ GET POST DELETE PUT
  • /api/v1/agama-deployment/configs GET PUT
  • /api/v1/agama-deployment/list GET not modified as using query param for start and count seems more appropriate
    Note: Changes merged via PR 4147
  1. Rectified the scope - Changes merged via PR 4123

@pujavs pujavs mentioned this issue Mar 14, 2023
Merged
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jgomer2001 jgomer2001

@pujavs pujavs

Labels
comp-jans-config-api Component affected by issue or PR kind-bug Issue or PR is a bug in existing functionality
Projects
None yet
Milestone
1.0.10
Development

Successfully merging a pull request may close this issue.

feat(config-api): agama deployment path param change and client authorization JanssenProject/jans
4 participants
@jgomer2001 @pujavs @moabu @mo-auto