apache / apache/cloudstack

Provide a api for List resource types

Open
#12,572 4 comments 0 reactions 0 assignees View on GitHub
component:api type:enhancement type:improvement
Dominant language
Java
Stars
3.1k
Forks
1.4k
Avg merge
6d 19h
Merged PRs (30d)
32

Description

### The required feature described as a wish

As a User/Admin/Operator I would like to know the resource types that are present in cloudstack

Currently, the listResourceDetails and listDetailOptions API requires the resource type parameter

https://cloudstack.apache.org/api/apidocs-4.22/apis/listResourceDetails.html
https://cloudstack.apache.org/api/apidocs-4.22/apis/listDetailOptions.html

Also If a User/Admin/Operator needs to add a detail to resource id they need the resource type parameter

https://cloudstack.apache.org/api/apidocs-4.22/apis/addResourceDetail.html

Currently there is no list of resourcetypes that present in present either is docs

It will be beneficial to the users if we can have a API call which can list the resourcetype in cloudstack

https://github.com/apache/cloudstack/blob/a5b6bc3be620f2b2f14321fd69643cf1bdd7d16c/api/src/main/java/com/cloud/server/ResourceTag.java#L30-L74

Contributor guide

Open the contributing guide

Research direction

Start by reading api/src/main/java/com/cloud/server/ResourceTag.java, especially the resource-type definitions, and compare the existing listResourceDetails, listDetailOptions, and addResourceDetail APIs linked in the issue. Done should include a documented API that lets users, administrators, and operators discover the resource types available in CloudStack and use that information with resource-detail operations.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, cloud
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.