diff --git a/README.md b/README.md index c45755d..050af16 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # gura +## API + +| Endpoint | Description | +|:-:|:-:| +| GET / | Redirect to Terra homepage | +| GET /_health | Check if server is running. Returns version | +| GET /api/packages/id/ | Get single package for ID | +| GET /api/packages/name/?all | Get packages by name. This may include multiple packages. By default this returns a combined grouping of all related packages with the same name. Passing ?all will return an array containng all valid packages. | +| GET /api/search?q=>query>&filter= | Search for a package. Apply filters to refine search. Multiple filters can be applied. Supported filters: Name, Provides. If no filter is applied, Name is used. | +| POST /api/ci/repo_update | Update the currently running databse. Authenticate with a JWT Bearer token with 'admin' scope | + ## License Copyright (c) 2024 Fyra Labs