Chuyển tới nội dung chính

Tham chiếu API

Trang này là nơi chuẩn để ghi lại bề mặt API của CheesePad. Nếu một endpoint không được liệt kê ở đây, hãy coi như không được hỗ trợ.

Base URL​

TBD

Authentication​

Xem trang Xác thực để biết các phương thức được hỗ trợ.

Conventions​

Versioning​

  • Document API versions explicitly (e.g. /v1).

Pagination​

  • Document default page size, maximum page size, and cursors/offsets.

Errors​

  • Use consistent error codes and a predictable response schema.

Endpoints​

Pools​

  • List pools
  • Get pool details

Locks​

  • List locks
  • Get lock details

Projects​

  • List projects
  • Get project details