Skip to content

Commit

Permalink
readme: Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
ItsJamie9494 committed Aug 27, 2024
1 parent deccfc0 commit 357e5a4
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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/<id> | Get single package for ID |
| GET /api/packages/name/<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=<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
Expand Down

0 comments on commit 357e5a4

Please sign in to comment.