Skip to content

"Update a stack" API Documentation contains incorrect role #4673

@rashedkvm

Description

@rashedkvm

Issue

"Update a stack" API Documentation contains incorrect role

Context

There is a discrepancy in the Cloud Controller V3 API documentation regarding stack metadata updates. The documentation currently permits both Admin and Space Developer roles, but practical testing and code investigation suggest that the Space Developer role is not actually authorized. We recommend updating the documentation to list only the Admin role.

Steps to Reproduce

cf space-users the-system_domain-org-name test-space
Getting users in org the-system_domain-org-name / space test-space as Alice...

SPACE MANAGER
  ccadmin (uaa)

SPACE DEVELOPER
  Alice (uaa)
  ccadmin (uaa)

SPACE SUPPORTER
  No SPACE SUPPORTER found

SPACE AUDITOR
  No SPACE AUDITOR found
cf login -u Alice -p *******
API endpoint: http://localhost
Warning: Insecure http API endpoint detected: secure https API endpoints are recommended


Authenticating...
OK

Targeted org the-system_domain-org-name.

Targeted space test-space.

API endpoint:   http://localhost
API version:    3.208.0
user:           Alice
org:            the-system_domain-org-name
space:          test-space
 cf curl -X PATCH /v3/stacks/be319b3d-1a9f-461d-8982-64123e75926b -d '{ "metadata": { "labels": { "key": "value" }, "annotations": {"note": "detailed information"}}}'
{"errors":[{"detail":"You are not authorized to perform the requested action","title":"CF-NotAuthorized","code":10003}]}

Expected Result

V3 API documentation to list only the Admin role

Current Result

V3 API documentation to lists Admin and Space Developer roles as permitted rolles

Image

Possible Fix

We recommend updating the documentation to list only the Admin role.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions