cloudfoundry / cloudfoundry/cloud_controller_ng

[Proposal] Limit the Visibility of Organization Quotas

Open
#3,367 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement performance unscheduled
Dominant language
Ruby
Stars
207
Forks
373
Avg merge
2d 12h
Merged PRs (30d)
56

Description

Background

Currently, the GET /v3/organization_quotas endpoint lists all organization quotas present in a foundation. However, this can result in displaying quotas that may not be relevant to the authenticated user. The proposal aims to improve this by limiting the visibility of organization quotas to only those that have been assigned to organizations accessible by the user.

Proposed Change

The endpoint behavior should remain unchanged by default, showing all organization quotas. However, we suggest introducing a configuration option that allows administrators to control the visibility of organization quotas. The new behavior, enabled by the configuration option, would only display quotas that have been assigned to organizations the authenticated user can access.

Implementation Options

  1. Config Property: We can introduce a configuration option as a property in the capi-release for the job cloud_controller_ng.
  2. Feature Flag: Alternatively, we can implement the configuration option as a feature flag. This approach allows for easier toggling of the behavior without requiring a redeployment.

Benefits

By implementing this proposal, we can enhance the user experience by only displaying relevant organization quotas. Users will no longer see quotas that have not been assigned to organizations they can access, reducing confusion and improving the overall usability of the API.

This change is particularly useful as the assignment of quotas can only be done by administrators, and users without the necessary permissions would find little value in viewing all organization quotas.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the GET /v3/organization_quotas endpoint and how authenticated users' accessible organizations and quota assignments are determined. Compare the proposed capi-release cloud_controller_ng configuration property with the feature-flag option, then define tests showing that the default lists all quotas while the enabled behavior lists only quotas assigned to accessible organizations.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
api, authorization, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.