aboutcode-org / aboutcode-org/purldb

Reorganize API endpoints

未關閉
#207 3 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
主要語言
HTML
星號
67
分支
69
平均合併
8 天 8 小時
30 天內合併 PR
1

描述

We have a lot of API endpoints exposed that are not used and/or unnecessary. These endpoints should be removed:
```
approximate_directory_content_index
approximate_directory_structure_index
exact_file_index
exact_package_archive_index
cditems
on_demand_queue
```

The matching related endpoints, `approximate_directory_content_index`, `approximate_directory_structure_index`, `exact_file_index`, and `exact_package_archive_index`, are being removed because the current D2D pipeline only uses sha1 lookups on the `packages` and `resources` endpoints. We also plan to revamp matching such that it is all done on the purldb server.

We should reorganize the API endpoints into three categories:

1. lookup (query, get)
2. match (post)
3. "mining" (live retrieval of things)

We also need to rethink the actions on the `packages` endpoint. The `get_or_fetch_package` endpoint should be merged with the `get_package` endpoint. `get_package` should also be updated to create a package from a download url, in addition to purls.

貢獻指南

這個儲存庫沒有索引到貢獻指南

評估

這個 Issue 還沒有評估資料。

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。