Giters

cyberark / conjur-openapi-spec

OpenAPI v3 specification for Conjur / DAP v10+

Home Page:https://conjur.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spec clearly defines relationship between optional query parameters Resources endpoints

john-odonnell opened this issue · comments

commented

Is your feature request related to a problem? Please describe.

On /resources/{account}/{kind}/{identifier}, there are two optional query parameters, check and permitted_roles.
If both are used in the same API call, the resulting response is that corresponding to a call with only check.
Some documentation is needed to define this relationship to the user.

There might be a similar relationship between optional query parameters on /roles/{account}/{kind}/{identifier}.

Describe the solution you would like

  • test Conjur's responses when given multiple optional query parameters on Resources endpoints
  • add documentation to spec/resources.yml explaining this behavior to the user
  • test Conjur's responses when given multiple optional query parameters on Roles endpoints
  • add documentation to spec/roles.yml explaining this behavior to the user

Additional context

When Conjur is given multiple optional query parameters, it seems to execute the API call for whichever parameter is checks for first in config/routes.rb.