apache / apache/cloudstack

[API] Internal DB IDs used as parameters

Đang mở
#9,684 4 bình luận 0 reaction 0 người được giao Xem trên GitHub
component:api status:needs-functional-definition type:improvement
Ngôn ngữ chính
Java
Star
3.1k
Fork
1.4k
Merge trung bình
6 ngày 19 giờ
Pull request đã merge (30 ngày)
32

Mô tả

##### ISSUE TYPE
* Improvement Request

##### COMPONENT NAME
~~~
API
~~~

##### CLOUDSTACK VERSION
~~~
Any
~~~

##### CONFIGURATION
N/A

##### OS / ENVIRONMENT
N/A

##### SUMMARY
The API accepts internal database IDs as well as UUIDs on the UUID parameters. For example:

````
(nvs) 🐱 > list accounts id=c3d932e5-488c-11ef-a188-3e7340e5df3c filter=id,name
{
"account": [
{
"id": "c3d932e5-488c-11ef-a188-3e7340e5df3c",
"name": "nicolas"
}
],
"count": 1
}
(nvs) 🐱 > list accounts id=2 filter=id,name
{
"account": [
{
"id": "c3d932e5-488c-11ef-a188-3e7340e5df3c",
"name": "nicolas"
}
],
"count": 1
}
(nvs) 🐱 > list accounts id=3 filter=id,name
{
"account": [
{
"id": "eef0d0a3-8013-4c37-954d-eafb96716c95",
"name": "baremetal-system-account"
}
],
"count": 1
}
````

##### EXPECTED RESULTS
~~~
ERROR - only UUIDs must be accepted
~~~

##### ACTUAL RESULTS
~~~
Successful API response
~~~

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Bắt đầu bằng cách tái hiện các lệnh gọi list accounts được ghi trong tài liệu với id lần lượt được đặt thành một UUID, 2 và 3, sau đó theo dõi quá trình xác thực tham số API và đường dẫn tra cứu đối với các tham số UUID. Hoàn tất khi các ID số nội bộ của cơ sở dữ liệu bị từ chối kèm theo lỗi, trong khi các UUID hợp lệ vẫn tiếp tục trả về account.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
java
Lĩnh vực
api, backend
Loại issue
Lỗi
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
38/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.