shwstppr commented on PR #8973:
URL: https://github.com/apache/cloudstack/pull/8973#issuecomment-2134564768
Tests with a 4.19 env,
Without changes (`objectstorageid` for `listBuckets` is shown to a normal
user):
```
(local) 🐱 > sync
Discovered 320 APIs
(local) 🐱 > list buckets -h
listBuckets: Lists all Buckets.
API Params Type Description
========== ==== ===========
account string list resources by account. Must be used w
ith the domainId parameter.
domainid uuid list only resources belonging to the doma
in specified
id uuid the ID of the bucket
ids list the IDs of the Buckets, mutually exclusiv
e with id
isrecursive boolean defaults to false, but if true, lists all
resources from the parent specified by
the domainId till leaves.
keyword string List by keyword
listall boolean If set to false, list only resources belo
nging to the command's caller; if set to
true - list resources that the caller i
s authorized to see. Default value is fa
lse. Resources dedicated to a project ar
e listed only if using the projectid par
ameter.
name string the name of the bucket
objectstorageid uuid the ID of the object storage pool, availa
ble to ROOT admin only
page integer
pagesize integer
projectid uuid list objects by project; if projectid=-1
lists All VMs
tags map List resources by tags (key/value pairs)
(local) 🐱 > list apis name=listBuckets filter=name,params
{
"api": [
{
"name": "listBuckets",
"params": [
{
"description": "List by keyword",
"length": 255,
"name": "keyword",
"required": false,
"type": "string"
},
{
"description": "list objects by project; if projectid=-1 lists All
VMs",
"length": 255,
"name": "projectid",
"related":
"listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
},
{
"description": "list only resources belonging to the domain
specified",
"length": 255,
"name": "domainid",
"related":
"createDomain,listDomainChildren,listDomains,listDomains",
"required": false,
"type": "uuid"
},
{
"description": "the ID of the bucket",
"length": 255,
"name": "id",
"related": "listBuckets",
"required": false,
"type": "uuid"
},
{
"description": "If set to false, list only resources belonging to
the command's caller; if set to true - list resources that the caller is
authorized to see. Default value is false. Resources dedicated to a project are
listed only if using the projectid parameter.",
"length": 255,
"name": "listall",
"required": false,
"type": "boolean"
},
{
"description": "",
"length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
},
{
"description": "defaults to false, but if true, lists all
resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
"required": false,
"type": "boolean"
},
{
"description": "list resources by account. Must be used with the
domainId parameter.",
"length": 255,
"name": "account",
"required": false,
"type": "string"
},
{
"description": "the name of the bucket",
"length": 255,
"name": "name",
"required": false,
"type": "string"
},
{
"description": "List resources by tags (key/value pairs)",
"length": 255,
"name": "tags",
"required": false,
"type": "map"
},
{
"description": "",
"length": 255,
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "the IDs of the Buckets, mutually exclusive with
id",
"length": 255,
"name": "ids",
"related": "listBuckets",
"required": false,
"type": "list"
},
{
"description": "the ID of the object storage pool, available to
ROOT admin only",
"length": 255,
"name": "objectstorageid",
"related":
"cancelStorageMaintenance,createStoragePool,findStoragePoolsForMigration,enableStorageMaintenance,syncStoragePool,updateStorageCapabilities",
"required": false,
"type": "uuid"
}
]
}
],
"count": 1
}
```
With changes (`objectstorageid` for `listBuckets` is *not* shown to a normal
user):
```
(local) 🐱 > sync
Discovered 320 APIs
(local) 🐱 > list buckets -h
listBuckets: Lists all Buckets.
API Params Type Description
========== ==== ===========
account string list resources by account. Must be used w
ith the domainId parameter.
domainid uuid list only resources belonging to the doma
in specified
id uuid the ID of the bucket
ids list the IDs of the Buckets, mutually exclusiv
e with id
isrecursive boolean defaults to false, but if true, lists all
resources from the parent specified by
the domainId till leaves.
keyword string List by keyword
listall boolean If set to false, list only resources belo
nging to the command's caller; if set to
true - list resources that the caller i
s authorized to see. Default value is fa
lse. Resources dedicated to a project ar
e listed only if using the projectid par
ameter.
name string the name of the bucket
page integer
pagesize integer
projectid uuid list objects by project; if projectid=-1
lists All VMs
tags map List resources by tags (key/value pairs)
(local) 🐱 > list apis name=listBuckets filter=name,params
{
"api": [
{
"name": "listBuckets",
"params": [
{
"description": "list resources by account. Must be used with the
domainId parameter.",
"length": 255,
"name": "account",
"required": false,
"type": "string"
},
{
"description": "the name of the bucket",
"length": 255,
"name": "name",
"required": false,
"type": "string"
},
{
"description": "defaults to false, but if true, lists all
resources from the parent specified by the domainId till leaves.",
"length": 255,
"name": "isrecursive",
"required": false,
"type": "boolean"
},
{
"description": "",
"length": 255,
"name": "page",
"required": false,
"type": "integer"
},
{
"description": "the ID of the bucket",
"length": 255,
"name": "id",
"related": "listBuckets",
"required": false,
"type": "uuid"
},
{
"description": "",
"length": 255,
"name": "pagesize",
"required": false,
"type": "integer"
},
{
"description": "If set to false, list only resources belonging to
the command's caller; if set to true - list resources that the caller is
authorized to see. Default value is false. Resources dedicated to a project are
listed only if using the projectid parameter.",
"length": 255,
"name": "listall",
"required": false,
"type": "boolean"
},
{
"description": "List by keyword",
"length": 255,
"name": "keyword",
"required": false,
"type": "string"
},
{
"description": "List resources by tags (key/value pairs)",
"length": 255,
"name": "tags",
"required": false,
"type": "map"
},
{
"description": "list only resources belonging to the domain
specified",
"length": 255,
"name": "domainid",
"related":
"createDomain,listDomainChildren,listDomains,listDomains",
"required": false,
"type": "uuid"
},
{
"description": "the IDs of the Buckets, mutually exclusive with
id",
"length": 255,
"name": "ids",
"related": "listBuckets",
"required": false,
"type": "list"
},
{
"description": "list objects by project; if projectid=-1 lists All
VMs",
"length": 255,
"name": "projectid",
"related":
"listProjectAccounts,activateProject,listProjects,suspendProject,updateProject",
"required": false,
"type": "uuid"
}
]
}
],
"count": 1
}
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
