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

Add the role_external_tenant param to the internal spec #766

Conversation

coderbydesign
Copy link
Contributor

We were missing role_external_tenant in the internal API spec for the OCM integration. This will allow for clients to be built with and use this filter on nested roles for groups to filter by external tenant.

Link(s) to Jira

Description of Intent of Change(s)

The /api/rbac/v1/integrations/tenant//groups//roles/ endpoint in the internal spec [1] needs to add support for the query param which allows roles to be filtered by external tenants.

We can use the same query param as is in the external spec [2] for "role_external_tenant".

[1] https://github.com/RedHatInsights/insights-rbac/blob/master/rbac/internal/specs/openapi.json#L304
[2]

"name": "role_external_tenant",
"in": "query",
"required": false,
"description": "Parameter for filtering group roles by role `external_tenant` using string search.",
"schema": {
"type": "string"
}

Local Testing

Generate a client and make use of role_external_tenant

Checklist

  • if API spec changes are required, is the spec updated?
  • are there any pre/post merge actions required? if so, document here.
  • are theses changes covered by unit tests?
  • if warranted, are documentation changes accounted for?
  • does this require migration changes?
    • if yes, are they backwards compatible?
  • is there known, direct impact to dependent teams/components?
    • if yes, how will this be handled?

Secure Coding Practices Checklist Link

Secure Coding Practices Checklist

  • Input Validation
  • Output Encoding
  • Authentication and Password Management
  • Session Management
  • Access Control
  • Cryptographic Practices
  • Error Handling and Logging
  • Data Protection
  • Communication Security
  • System Configuration
  • Database Security
  • File Management
  • Memory Management
  • General Coding Practices

We were missing `role_external_tenant` in the internal API spec for the OCM integration.
This will allow for clients to be built with and use this filter on nested roles
for groups to filter by external tenant.
@lpichler lpichler merged commit d95bdb0 into RedHatInsights:master Nov 8, 2022
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.

None yet

2 participants